Traneptora/FFmpeg
1
Fork 0
forked from FFmpeg/FFmpeg
Code Pull requests Activity

doc/muxers.texi: Don't use confusing variable name

Browse source 
reserve_index_space is a size, not an index.
Also refer to the variable in the description.

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
This commit is contained in:
Andreas Rheinhardt 2024-04-13 00:10:49 +02:00
parent 1f265aa91d
commit f48987f609
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/muxers.texi
View file

@ -2816,14 +2816,14 @@ ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_
@subsection Options @subsection Options
@table @option @table @option
@item reserve_index_space @var{index} @item reserve_index_space @var{size}
By default, this muxer writes the index for seeking (called cues in Matroska By default, this muxer writes the index for seeking (called cues in Matroska
terms) at the end of the file, because it cannot know in advance how much space terms) at the end of the file, because it cannot know in advance how much space
to leave for the index at the beginning of the file. However for some use cases to leave for the index at the beginning of the file. However for some use cases
-- e.g. streaming where seeking is possible but slow -- it is useful to put the -- e.g. streaming where seeking is possible but slow -- it is useful to put the
index at the beginning of the file. index at the beginning of the file.
If this option is set to a non-zero value, the muxer will reserve a given amount If this option is set to a non-zero value, the muxer will reserve @var{size} bytes
of space in the file header and then try to write the cues there when the muxing of space in the file header and then try to write the cues there when the muxing
finishes. If the reserved space does not suffice, no Cues will be written, the finishes. If the reserved space does not suffice, no Cues will be written, the
file will be finalized and writing the trailer will return an error. file will be finalized and writing the trailer will return an error.