diff mbox series

[FFmpeg-devel] doc/muxers/image2: add mention to image2pipe

Message ID 20240329130354.36725-1-stefasab@gmail.com
State Accepted
Commit 026bef777196946783d24c14aedd056fcead379d
Headers show
Series [FFmpeg-devel] doc/muxers/image2: add mention to image2pipe | expand

Checks

Context Check Description
yinshiyou/configure_loongarch64 warning Failed to apply patch
andriy/configure_x86 warning Failed to apply patch

Commit Message

Stefano Sabatini March 29, 2024, 1:03 p.m. UTC 
Clarify the difference with regards to the image2 muxer.
---
 doc/muxers.texi | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/muxers.texi b/doc/muxers.texi
index 05a0c302cf..5cce26a43f 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -2569,10 +2569,10 @@  Internet Low Bitrate Codec (iLBC) raw muxer.
 It accepts a single @samp{ilbc} audio stream.
 
 @anchor{image2}
-@section image2
+@section image2, image2pipe
 Image file muxer.
 
-The image file muxer writes video frames to image files.
+The @samp{image2} muxer writes video frames to image files.
 
 The output filenames are specified by a pattern, which can be used to
 produce sequentially numbered series of files.
@@ -2603,6 +2603,10 @@  each of the YUV420P components. To read or write this image file format,
 specify the name of the '.Y' file. The muxer will automatically open the
 '.U' and '.V' files as required.
 
+The @samp{image2pipe} muxer accepts the same options as the @samp{image2} muxer,
+but ignores the pattern verification and expansion, as it is supposed to write
+to the command output rather than to an actual stored file.
+
 @subsection Options
 @table @option
 @item frame_pts @var{bool}