diff mbox series

[FFmpeg-devel,v2,9/9] doc/protocols: clarify SRT timeout options docs

Message ID 20200217003653.20027-9-cus@passwd.hu
State New
Headers show
Series [FFmpeg-devel,v2,1/9] avformat/libsrt: fix timeout unit confusion between milisec and microsec
Related show

Checks

Context Check Description
andriy/ffmpeg-patchwork pending
andriy/ffmpeg-patchwork success Applied patch
andriy/ffmpeg-patchwork success Configure finished
andriy/ffmpeg-patchwork success Make finished
andriy/ffmpeg-patchwork success Make fate finished

Commit Message

Marton Balint Feb. 17, 2020, 12:36 a.m. UTC
Signed-off-by: Marton Balint <cus@passwd.hu>
---
 doc/protocols.texi | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/doc/protocols.texi b/doc/protocols.texi
index 57814c7831..54a287f488 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -1348,11 +1348,9 @@  Set UDP receive buffer size, expressed in bytes.
 Set UDP send buffer size, expressed in bytes.
 
 @item timeout
-Set raise error timeout for read/write optations.
-
-This option is only relevant in read mode:
-if no data arrived in more than this time
-interval, raise error.
+Set raise error timeouts for read, write and connect operations. Note that the
+SRT library has internal timeouts which can be controlled separately, the
+value set here is only a cap on those.
 
 @item tlpktdrop=@var{1|0}
 Too-late Packet Drop. When enabled on receiver, it skips