[FFmpeg-devel] [PATCH 3/3] doc/muxers: add fifo_test

[Stefano Sabatini]

---
 doc/muxers.texi | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/doc/muxers.texi b/doc/muxers.texi
index 0aaef2b520..ccbb741992 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -1556,6 +1556,36 @@ ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv \
   -map 0:v -map 0:a rtmp://example.com/live/stream_name
 @end example
 
+ at anchor{fifo_test}
+ at section fifo_test
+ at ref{fifo} muxer test muxer.
+
+This is a testing muxer, it is supposed to be used only to test the
+ at ref{fifo} muxer.
+
+ at subsection Options
+ at table @option
+ at item print_deinit_summary @var{bool}
+print summary when deinitializing muxer, default is @code{true}
+
+ at item write_header_ret @var{int}
+set @code{write_header()} return value
+
+ at item write_trailer_ret @var{int}
+set @code{write_trailer()} return value
+ at end table
+
+ at subsection Example
+
+Use @command{ffmpeg} to write to a file using the @samp{fifo} muxer
+using the internal @samp{fifo_test} muxer, simulate a write header
+error using the @option{write_header_ret} option:
+ at example
+ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format fifo_test -format_opts write_header_ret=-22 \
+  -map 0:v -map 0:a \
+  -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 out.test
+ at end example
+
 @section flv
 
 Adobe Flash Video Format muxer.
-- 
2.34.1