[FFmpeg-cvslog] r25192 - trunk/doc/protocols.texi

[stefano]

Author: stefano
Date: Sat Sep 25 12:16:15 2010
New Revision: 25192

Log:
Document udp protocol.

Based on a patch by Aviad Rozenhek aviadr1 @ reverse(moc.liamg).

Modified:
   trunk/doc/protocols.texi

Modified: trunk/doc/protocols.texi
==============================================================================
--- trunk/doc/protocols.texi	Sat Sep 25 11:58:07 2010	(r25191)
+++ trunk/doc/protocols.texi	Sat Sep 25 12:16:15 2010	(r25192)
@@ -225,4 +225,47 @@ Trasmission Control Protocol.
 
 User Datagram Protocol.
 
+The required syntax for a UDP url is:
+ at example
+udp://@var{hostname}:@var{port}[?@var{options}]
+ at end example
+
+ at var{options} contains a list of &-seperated options of the form @var{key}=@var{val}.
+Follow the list of supported options.
+
+ at table @option
+
+ at item buffer_size=@var{size}
+set the UDP buffer size in bytes
+
+ at item localport=@var{port}
+override the local UDP port to bind with
+
+ at item pkt_size=@var{size}
+set the size in bytes of UDP packets
+
+ at item reuse=@var{1|0}
+explicitly allow or disallow reusing UDP sockets
+
+ at item ttl=@var{ttl}
+set the time to live value (for multicast only)
+ at end table
+
+Some usage examples of the udp protocol with @file{ffmpeg} follow.
+
+To stream over UDP to a remote endpoint:
+ at example
+ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
+ at end example
+
+To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
+ at example
+ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
+ at end example
+
+To receive over UDP from a remote endpoint:
+ at example
+ffmpeg -i udp://[@var{multicast-address}]:@var{port}
+ at end example
+
 @c man end PROTOCOLS