Merge commit 'eb9244f20210fd420fb9b3c98126f9cae525d1cc'
[ffmpeg.git] / doc / protocols.texi
index cb75d92..49ca750 100644 (file)
@@ -295,39 +295,41 @@ ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somed
 
 @section Icecast
 
-Icecast protocol
+Icecast protocol (stream to Icecast servers)
+
+This protocol accepts the following options:
 
 @table @option
 @item ice_genre
-Set the genre of the stream.
+Set the stream genre.
 
 @item ice_name
-Set the name of the stream.
+Set the stream name.
 
 @item ice_description
-Set the description of the stream.
+Set the stream description.
 
 @item ice_url
-Set the stream website url.
+Set the stream website URL.
 
 @item ice_public
 Set if the stream should be public.
-Default is 0 (not public).
+The default is 0 (not public).
 
-@item ice_password
-Password for the mountpoint.
+@item user_agent
+Override the User-Agent header. If not specified a string of the form
+"Lavf/<version>" will be used.
 
-@item legacy_icecast
-If set to 1, enable support for legacy Icecast (Version < 2.4), using the SOURCE method
-instead of the PUT method.
+@item password
+Set the Icecast mountpoint password.
 
 @item content_type
-Set a specific content type for the stream.
-This MUST be set if streaming else than audio/mpeg
+Set the stream content type. This must be set if it is different from
+audio/mpeg.
 
-@item user_agent
-Override the User-Agent header. If not specified the protocol will use a
-string describing the libavformat build. ("Lavf/<version>")
+@item legacy_icecast
+This enables support for Icecast versions < 2.4.0, that do not support the
+HTTP PUT method but the SOURCE method.
 
 @end table