avio: Add an option 'rw_timeout'
[ffmpeg.git] / doc / protocols.texi
1 @chapter Protocols
2 @c man begin PROTOCOLS
3
4 Protocols are configured elements in Libav which allow to access
5 resources which require the use of a particular protocol.
6
7 When you configure your Libav build, all the supported protocols are
8 enabled by default. You can list all available ones using the
9 configure option "--list-protocols".
10
11 You can disable all the protocols using the configure option
12 "--disable-protocols", and selectively enable a protocol using the
13 option "--enable-protocol=@var{PROTOCOL}", or you can disable a
14 particular protocol using the option
15 "--disable-protocol=@var{PROTOCOL}".
16
17 The option "-protocols" of the av* tools will display the list of
18 supported protocols.
19
20 All protocols accept the following options:
21
22 @table @option
23 @item rw_timeout
24 Maximum time to wait for (network) read/write operations to complete,
25 in microseconds.
26 @end table
27
28 A description of the currently available protocols follows.
29
30 @section concat
31
32 Physical concatenation protocol.
33
34 Allow to read and seek from many resource in sequence as if they were
35 a unique resource.
36
37 A URL accepted by this protocol has the syntax:
38 @example
39 concat:@var{URL1}|@var{URL2}|...|@var{URLN}
40 @end example
41
42 where @var{URL1}, @var{URL2}, ..., @var{URLN} are the urls of the
43 resource to be concatenated, each one possibly specifying a distinct
44 protocol.
45
46 For example to read a sequence of files @file{split1.mpeg},
47 @file{split2.mpeg}, @file{split3.mpeg} with @command{avplay} use the
48 command:
49 @example
50 avplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
51 @end example
52
53 Note that you may need to escape the character "|" which is special for
54 many shells.
55
56 @section file
57
58 File access protocol.
59
60 Allow to read from or read to a file.
61
62 For example to read from a file @file{input.mpeg} with @command{avconv}
63 use the command:
64 @example
65 avconv -i file:input.mpeg output.mpeg
66 @end example
67
68 The av* tools default to the file protocol, that is a resource
69 specified with the name "FILE.mpeg" is interpreted as the URL
70 "file:FILE.mpeg".
71
72 @section gopher
73
74 Gopher protocol.
75
76 @section hls
77
78 Read Apple HTTP Live Streaming compliant segmented stream as
79 a uniform one. The M3U8 playlists describing the segments can be
80 remote HTTP resources or local files, accessed using the standard
81 file protocol.
82 The nested protocol is declared by specifying
83 "+@var{proto}" after the hls URI scheme name, where @var{proto}
84 is either "file" or "http".
85
86 @example
87 hls+http://host/path/to/remote/resource.m3u8
88 hls+file://path/to/local/resource.m3u8
89 @end example
90
91 Using this protocol is discouraged - the hls demuxer should work
92 just as well (if not, please report the issues) and is more complete.
93 To use the hls demuxer instead, simply use the direct URLs to the
94 m3u8 files.
95
96 @section http
97
98 HTTP (Hyper Text Transfer Protocol).
99
100 This protocol accepts the following options:
101
102 @table @option
103 @item chunked_post
104 If set to 1 use chunked Transfer-Encoding for posts, default is 1.
105
106 @item content_type
107 Set a specific content type for the POST messages.
108
109 @item headers
110 Set custom HTTP headers, can override built in default headers. The
111 value must be a string encoding the headers.
112
113 @item multiple_requests
114 Use persistent connections if set to 1, default is 0.
115
116 @item post_data
117 Set custom HTTP post data.
118
119 @item user_agent
120 Override the User-Agent header. If not specified a string of the form
121 "Lavf/<version>" will be used.
122
123 @item mime_type
124 Export the MIME type.
125
126 @item icy
127 If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
128 supports this, the metadata has to be retrieved by the application by reading
129 the @option{icy_metadata_headers} and @option{icy_metadata_packet} options.
130 The default is 1.
131
132 @item icy_metadata_headers
133 If the server supports ICY metadata, this contains the ICY-specific HTTP reply
134 headers, separated by newline characters.
135
136 @item icy_metadata_packet
137 If the server supports ICY metadata, and @option{icy} was set to 1, this
138 contains the last non-empty metadata packet sent by the server. It should be
139 polled in regular intervals by applications interested in mid-stream metadata
140 updates.
141
142 @item offset
143 Set initial byte offset.
144
145 @item end_offset
146 Try to limit the request to bytes preceding this offset.
147 @end table
148
149 @section Icecast
150
151 Icecast (stream to Icecast servers)
152
153 This protocol accepts the following options:
154
155 @table @option
156 @item ice_genre
157 Set the stream genre.
158
159 @item ice_name
160 Set the stream name.
161
162 @item ice_description
163 Set the stream description.
164
165 @item ice_url
166 Set the stream website URL.
167
168 @item ice_public
169 Set if the stream should be public or not.
170 The default is 0 (not public).
171
172 @item user_agent
173 Override the User-Agent header. If not specified a string of the form
174 "Lavf/<version>" will be used.
175
176 @item password
177 Set the Icecast mountpoint password.
178
179 @item content_type
180 Set the stream content type. This must be set if it is different from
181 audio/mpeg.
182
183 @item legacy_icecast
184 This enables support for Icecast versions < 2.4.0, that do not support the
185 HTTP PUT method but the SOURCE method.
186
187 @end table
188
189 @section mmst
190
191 MMS (Microsoft Media Server) protocol over TCP.
192
193 @section mmsh
194
195 MMS (Microsoft Media Server) protocol over HTTP.
196
197 The required syntax is:
198 @example
199 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
200 @end example
201
202 @section md5
203
204 MD5 output protocol.
205
206 Computes the MD5 hash of the data to be written, and on close writes
207 this to the designated output or stdout if none is specified. It can
208 be used to test muxers without writing an actual file.
209
210 Some examples follow.
211 @example
212 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
213 avconv -i input.flv -f avi -y md5:output.avi.md5
214
215 # Write the MD5 hash of the encoded AVI file to stdout.
216 avconv -i input.flv -f avi -y md5:
217 @end example
218
219 Note that some formats (typically MOV) require the output protocol to
220 be seekable, so they will fail with the MD5 output protocol.
221
222 @section pipe
223
224 UNIX pipe access protocol.
225
226 Allow to read and write from UNIX pipes.
227
228 The accepted syntax is:
229 @example
230 pipe:[@var{number}]
231 @end example
232
233 @var{number} is the number corresponding to the file descriptor of the
234 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
235 is not specified, by default the stdout file descriptor will be used
236 for writing, stdin for reading.
237
238 For example to read from stdin with @command{avconv}:
239 @example
240 cat test.wav | avconv -i pipe:0
241 # ...this is the same as...
242 cat test.wav | avconv -i pipe:
243 @end example
244
245 For writing to stdout with @command{avconv}:
246 @example
247 avconv -i test.wav -f avi pipe:1 | cat > test.avi
248 # ...this is the same as...
249 avconv -i test.wav -f avi pipe: | cat > test.avi
250 @end example
251
252 Note that some formats (typically MOV), require the output protocol to
253 be seekable, so they will fail with the pipe output protocol.
254
255 @section rtmp
256
257 Real-Time Messaging Protocol.
258
259 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
260 content across a TCP/IP network.
261
262 The required syntax is:
263 @example
264 rtmp://[@var{username}:@var{password}@@]@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
265 @end example
266
267 The accepted parameters are:
268 @table @option
269
270 @item username
271 An optional username (mostly for publishing).
272
273 @item password
274 An optional password (mostly for publishing).
275
276 @item server
277 The address of the RTMP server.
278
279 @item port
280 The number of the TCP port to use (by default is 1935).
281
282 @item app
283 It is the name of the application to access. It usually corresponds to
284 the path where the application is installed on the RTMP server
285 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
286 the value parsed from the URI through the @code{rtmp_app} option, too.
287
288 @item playpath
289 It is the path or name of the resource to play with reference to the
290 application specified in @var{app}, may be prefixed by "mp4:". You
291 can override the value parsed from the URI through the @code{rtmp_playpath}
292 option, too.
293
294 @item listen
295 Act as a server, listening for an incoming connection.
296
297 @item timeout
298 Maximum time to wait for the incoming connection. Implies listen.
299 @end table
300
301 Additionally, the following parameters can be set via command line options
302 (or in code via @code{AVOption}s):
303 @table @option
304
305 @item rtmp_app
306 Name of application to connect on the RTMP server. This option
307 overrides the parameter specified in the URI.
308
309 @item rtmp_buffer
310 Set the client buffer time in milliseconds. The default is 3000.
311
312 @item rtmp_conn
313 Extra arbitrary AMF connection parameters, parsed from a string,
314 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
315 Each value is prefixed by a single character denoting the type,
316 B for Boolean, N for number, S for string, O for object, or Z for null,
317 followed by a colon. For Booleans the data must be either 0 or 1 for
318 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
319 1 to end or begin an object, respectively. Data items in subobjects may
320 be named, by prefixing the type with 'N' and specifying the name before
321 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
322 times to construct arbitrary AMF sequences.
323
324 @item rtmp_flashver
325 Version of the Flash plugin used to run the SWF player. The default
326 is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
327 <libavformat version>).)
328
329 @item rtmp_flush_interval
330 Number of packets flushed in the same request (RTMPT only). The default
331 is 10.
332
333 @item rtmp_live
334 Specify that the media is a live stream. No resuming or seeking in
335 live streams is possible. The default value is @code{any}, which means the
336 subscriber first tries to play the live stream specified in the
337 playpath. If a live stream of that name is not found, it plays the
338 recorded stream. The other possible values are @code{live} and
339 @code{recorded}.
340
341 @item rtmp_pageurl
342 URL of the web page in which the media was embedded. By default no
343 value will be sent.
344
345 @item rtmp_playpath
346 Stream identifier to play or to publish. This option overrides the
347 parameter specified in the URI.
348
349 @item rtmp_subscribe
350 Name of live stream to subscribe to. By default no value will be sent.
351 It is only sent if the option is specified or if rtmp_live
352 is set to live.
353
354 @item rtmp_swfhash
355 SHA256 hash of the decompressed SWF file (32 bytes).
356
357 @item rtmp_swfsize
358 Size of the decompressed SWF file, required for SWFVerification.
359
360 @item rtmp_swfurl
361 URL of the SWF player for the media. By default no value will be sent.
362
363 @item rtmp_swfverify
364 URL to player swf file, compute hash/size automatically.
365
366 @item rtmp_tcurl
367 URL of the target stream. Defaults to proto://host[:port]/app.
368
369 @end table
370
371 For example to read with @command{avplay} a multimedia resource named
372 "sample" from the application "vod" from an RTMP server "myserver":
373 @example
374 avplay rtmp://myserver/vod/sample
375 @end example
376
377 To publish to a password protected server, passing the playpath and
378 app names separately:
379 @example
380 avconv -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
381 @end example
382
383 @section rtmpe
384
385 Encrypted Real-Time Messaging Protocol.
386
387 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
388 streaming multimedia content within standard cryptographic primitives,
389 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
390 a pair of RC4 keys.
391
392 @section rtmps
393
394 Real-Time Messaging Protocol over a secure SSL connection.
395
396 The Real-Time Messaging Protocol (RTMPS) is used for streaming
397 multimedia content across an encrypted connection.
398
399 @section rtmpt
400
401 Real-Time Messaging Protocol tunneled through HTTP.
402
403 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
404 for streaming multimedia content within HTTP requests to traverse
405 firewalls.
406
407 @section rtmpte
408
409 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
410
411 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
412 is used for streaming multimedia content within HTTP requests to traverse
413 firewalls.
414
415 @section rtmpts
416
417 Real-Time Messaging Protocol tunneled through HTTPS.
418
419 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
420 for streaming multimedia content within HTTPS requests to traverse
421 firewalls.
422
423 @section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
424
425 Real-Time Messaging Protocol and its variants supported through
426 librtmp.
427
428 Requires the presence of the librtmp headers and library during
429 configuration. You need to explicitly configure the build with
430 "--enable-librtmp". If enabled this will replace the native RTMP
431 protocol.
432
433 This protocol provides most client functions and a few server
434 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
435 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
436 variants of these encrypted types (RTMPTE, RTMPTS).
437
438 The required syntax is:
439 @example
440 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
441 @end example
442
443 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
444 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
445 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
446 meaning as specified for the RTMP native protocol.
447 @var{options} contains a list of space-separated options of the form
448 @var{key}=@var{val}.
449
450 See the librtmp manual page (man 3 librtmp) for more information.
451
452 For example, to stream a file in real-time to an RTMP server using
453 @command{avconv}:
454 @example
455 avconv -re -i myfile -f flv rtmp://myserver/live/mystream
456 @end example
457
458 To play the same stream using @command{avplay}:
459 @example
460 avplay "rtmp://myserver/live/mystream live=1"
461 @end example
462
463 @section rtp
464
465 Real-Time Protocol.
466
467 @section rtsp
468
469 RTSP is not technically a protocol handler in libavformat, it is a demuxer
470 and muxer. The demuxer supports both normal RTSP (with data transferred
471 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
472 data transferred over RDT).
473
474 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
475 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
476 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
477
478 The required syntax for a RTSP url is:
479 @example
480 rtsp://@var{hostname}[:@var{port}]/@var{path}
481 @end example
482
483 The following options (set on the @command{avconv}/@command{avplay} command
484 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
485 are supported:
486
487 Flags for @code{rtsp_transport}:
488
489 @table @option
490
491 @item udp
492 Use UDP as lower transport protocol.
493
494 @item tcp
495 Use TCP (interleaving within the RTSP control channel) as lower
496 transport protocol.
497
498 @item udp_multicast
499 Use UDP multicast as lower transport protocol.
500
501 @item http
502 Use HTTP tunneling as lower transport protocol, which is useful for
503 passing proxies.
504 @end table
505
506 Multiple lower transport protocols may be specified, in that case they are
507 tried one at a time (if the setup of one fails, the next one is tried).
508 For the muxer, only the @code{tcp} and @code{udp} options are supported.
509
510 Flags for @code{rtsp_flags}:
511
512 @table @option
513 @item filter_src
514 Accept packets only from negotiated peer address and port.
515 @item listen
516 Act as a server, listening for an incoming connection.
517 @end table
518
519 When receiving data over UDP, the demuxer tries to reorder received packets
520 (since they may arrive out of order, or packets may get lost totally). This
521 can be disabled by setting the maximum demuxing delay to zero (via
522 the @code{max_delay} field of AVFormatContext).
523
524 When watching multi-bitrate Real-RTSP streams with @command{avplay}, the
525 streams to display can be chosen with @code{-vst} @var{n} and
526 @code{-ast} @var{n} for video and audio respectively, and can be switched
527 on the fly by pressing @code{v} and @code{a}.
528
529 Example command lines:
530
531 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
532
533 @example
534 avplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
535 @end example
536
537 To watch a stream tunneled over HTTP:
538
539 @example
540 avplay -rtsp_transport http rtsp://server/video.mp4
541 @end example
542
543 To send a stream in realtime to a RTSP server, for others to watch:
544
545 @example
546 avconv -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
547 @end example
548
549 To receive a stream in realtime:
550
551 @example
552 avconv -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
553 @end example
554
555 @section sap
556
557 Session Announcement Protocol (RFC 2974). This is not technically a
558 protocol handler in libavformat, it is a muxer and demuxer.
559 It is used for signalling of RTP streams, by announcing the SDP for the
560 streams regularly on a separate port.
561
562 @subsection Muxer
563
564 The syntax for a SAP url given to the muxer is:
565 @example
566 sap://@var{destination}[:@var{port}][?@var{options}]
567 @end example
568
569 The RTP packets are sent to @var{destination} on port @var{port},
570 or to port 5004 if no port is specified.
571 @var{options} is a @code{&}-separated list. The following options
572 are supported:
573
574 @table @option
575
576 @item announce_addr=@var{address}
577 Specify the destination IP address for sending the announcements to.
578 If omitted, the announcements are sent to the commonly used SAP
579 announcement multicast address 224.2.127.254 (sap.mcast.net), or
580 ff0e::2:7ffe if @var{destination} is an IPv6 address.
581
582 @item announce_port=@var{port}
583 Specify the port to send the announcements on, defaults to
584 9875 if not specified.
585
586 @item ttl=@var{ttl}
587 Specify the time to live value for the announcements and RTP packets,
588 defaults to 255.
589
590 @item same_port=@var{0|1}
591 If set to 1, send all RTP streams on the same port pair. If zero (the
592 default), all streams are sent on unique ports, with each stream on a
593 port 2 numbers higher than the previous.
594 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
595 The RTP stack in libavformat for receiving requires all streams to be sent
596 on unique ports.
597 @end table
598
599 Example command lines follow.
600
601 To broadcast a stream on the local subnet, for watching in VLC:
602
603 @example
604 avconv -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
605 @end example
606
607 Similarly, for watching in avplay:
608
609 @example
610 avconv -re -i @var{input} -f sap sap://224.0.0.255
611 @end example
612
613 And for watching in avplay, over IPv6:
614
615 @example
616 avconv -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
617 @end example
618
619 @subsection Demuxer
620
621 The syntax for a SAP url given to the demuxer is:
622 @example
623 sap://[@var{address}][:@var{port}]
624 @end example
625
626 @var{address} is the multicast address to listen for announcements on,
627 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
628 is the port that is listened on, 9875 if omitted.
629
630 The demuxers listens for announcements on the given address and port.
631 Once an announcement is received, it tries to receive that particular stream.
632
633 Example command lines follow.
634
635 To play back the first stream announced on the normal SAP multicast address:
636
637 @example
638 avplay sap://
639 @end example
640
641 To play back the first stream announced on one the default IPv6 SAP multicast address:
642
643 @example
644 avplay sap://[ff0e::2:7ffe]
645 @end example
646
647 @section tcp
648
649 Transmission Control Protocol.
650
651 The required syntax for a TCP url is:
652 @example
653 tcp://@var{hostname}:@var{port}[?@var{options}]
654 @end example
655
656 @table @option
657
658 @item listen
659 Listen for an incoming connection
660
661 @example
662 avconv -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
663 avplay tcp://@var{hostname}:@var{port}
664 @end example
665
666 @end table
667
668 @section tls
669
670 Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
671
672 The required syntax for a TLS url is:
673 @example
674 tls://@var{hostname}:@var{port}
675 @end example
676
677 The following parameters can be set via command line options
678 (or in code via @code{AVOption}s):
679
680 @table @option
681
682 @item ca_file
683 A file containing certificate authority (CA) root certificates to treat
684 as trusted. If the linked TLS library contains a default this might not
685 need to be specified for verification to work, but not all libraries and
686 setups have defaults built in.
687
688 @item tls_verify=@var{1|0}
689 If enabled, try to verify the peer that we are communicating with.
690 Note, if using OpenSSL, this currently only makes sure that the
691 peer certificate is signed by one of the root certificates in the CA
692 database, but it does not validate that the certificate actually
693 matches the host name we are trying to connect to. (With GnuTLS,
694 the host name is validated as well.)
695
696 This is disabled by default since it requires a CA database to be
697 provided by the caller in many cases.
698
699 @item cert_file
700 A file containing a certificate to use in the handshake with the peer.
701 (When operating as server, in listen mode, this is more often required
702 by the peer, while client certificates only are mandated in certain
703 setups.)
704
705 @item key_file
706 A file containing the private key for the certificate.
707
708 @item listen=@var{1|0}
709 If enabled, listen for connections on the provided port, and assume
710 the server role in the handshake instead of the client role.
711
712 @end table
713
714 @section udp
715
716 User Datagram Protocol.
717
718 The required syntax for a UDP url is:
719 @example
720 udp://@var{hostname}:@var{port}[?@var{options}]
721 @end example
722
723 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
724 Follow the list of supported options.
725
726 @table @option
727
728 @item buffer_size=@var{size}
729 set the UDP buffer size in bytes
730
731 @item localport=@var{port}
732 override the local UDP port to bind with
733
734 @item localaddr=@var{addr}
735 Choose the local IP address. This is useful e.g. if sending multicast
736 and the host has multiple interfaces, where the user can choose
737 which interface to send on by specifying the IP address of that interface.
738
739 @item pkt_size=@var{size}
740 set the size in bytes of UDP packets
741
742 @item reuse=@var{1|0}
743 explicitly allow or disallow reusing UDP sockets
744
745 @item ttl=@var{ttl}
746 set the time to live value (for multicast only)
747
748 @item connect=@var{1|0}
749 Initialize the UDP socket with @code{connect()}. In this case, the
750 destination address can't be changed with ff_udp_set_remote_url later.
751 If the destination address isn't known at the start, this option can
752 be specified in ff_udp_set_remote_url, too.
753 This allows finding out the source address for the packets with getsockname,
754 and makes writes return with AVERROR(ECONNREFUSED) if "destination
755 unreachable" is received.
756 For receiving, this gives the benefit of only receiving packets from
757 the specified peer address/port.
758
759 @item sources=@var{address}[,@var{address}]
760 Only receive packets sent to the multicast group from one of the
761 specified sender IP addresses.
762
763 @item block=@var{address}[,@var{address}]
764 Ignore packets sent to the multicast group from the specified
765 sender IP addresses.
766 @end table
767
768 Some usage examples of the udp protocol with @command{avconv} follow.
769
770 To stream over UDP to a remote endpoint:
771 @example
772 avconv -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
773 @end example
774
775 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
776 @example
777 avconv -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
778 @end example
779
780 To receive over UDP from a remote endpoint:
781 @example
782 avconv -i udp://[@var{multicast-address}]:@var{port}
783 @end example
784
785 @section unix
786
787 Unix local socket
788
789 The required syntax for a Unix socket URL is:
790
791 @example
792 unix://@var{filepath}
793 @end example
794
795 The following parameters can be set via command line options
796 (or in code via @code{AVOption}s):
797
798 @table @option
799 @item timeout
800 Timeout in ms.
801 @item listen
802 Create the Unix socket in listening mode.
803 @end table
804
805 @c man end PROTOCOLS