aboutsummaryrefslogtreecommitdiffstats
path: root/doc/protocols.texi
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2013-12-24 16:27:34 +0100
committerStefano Sabatini <stefasab@gmail.com>2013-12-25 18:42:26 +0100
commit1b4da43ce02452843a1e9bb976da1a39e18a945c (patch)
tree121f023947d6b8e512482a1e6ea73dc218c9ee2f /doc/protocols.texi
parent702d9a23b3d3309fbc7bc7b09ac3271c42dc72dc (diff)
downloadffmpeg-1b4da43ce02452843a1e9bb976da1a39e18a945c.tar.gz
doc/protocols/tcp,lavf/tcp: apply minor fixes to TCP protocol documentation
Diffstat (limited to 'doc/protocols.texi')
-rw-r--r--doc/protocols.texi25
1 files changed, 17 insertions, 8 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi
index 211e125930..20ab8e6836 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -897,23 +897,32 @@ The required syntax for a TCP url is:
tcp://@var{hostname}:@var{port}[?@var{options}]
@end example
-@table @option
+@var{options} contains a list of &-separated options of the form
+@var{key}=@var{val}.
-@item listen
-Listen for an incoming connection
+The list of supported options follows.
+
+@table @option
+@item listen=@var{1|0}
+Listen for an incoming connection. Default value is 0.
@item timeout=@var{microseconds}
-In read mode: if no data arrived in more than this time interval, raise error.
-In write mode: if socket cannot be written in more than this time interval, raise error.
-This also sets timeout on TCP connection establishing.
+Set raise error timeout, expressed in microseconds.
+This option is only relevant in read mode: if no data arrived in more
+than this time interval, raise error.
+
+@item listen_timeout=@var{microseconds}
+Set listen timeout, expressed in microseconds.
+@end table
+
+The following example shows how to setup a listening TCP connection
+with @command{ffmpeg}, which is then accessed with @command{ffplay}:
@example
ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
ffplay tcp://@var{hostname}:@var{port}
@end example
-@end table
-
@section tls
Transport Layer Security (TLS) / Secure Sockets Layer (SSL)