Document new 'blocksize' option of 'pipe' protocol
authorAndrey Utkin <andrey.krieger.utkin@gmail.com>
Wed, 31 Jul 2013 12:22:02 +0000 (15:22 +0300)
committerMichael Niedermayer <michaelni@gmx.at>
Wed, 31 Jul 2013 19:17:03 +0000 (21:17 +0200)
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
doc/protocols.texi

index e8427aa..bae05d5 100644 (file)
@@ -325,6 +325,16 @@ ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
 @end example
 
+This protocol accepts the following options:
+
+@table @option
+@item blocksize
+Set I/O operation maximum block size, in bytes. Default value is
+@code{INT_MAX}, which results in not limiting the requested block size.
+Setting this value reasonably low improves user termination request reaction
+time, which is valuable if data transmission is slow.
+@end table
+
 Note that some formats (typically MOV), require the output protocol to
 be seekable, so they will fail with the pipe output protocol.