aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndreas Rheinhardt <andreas.rheinhardt@outlook.com>2024-04-13 00:10:49 +0200
committerAndreas Rheinhardt <andreas.rheinhardt@outlook.com>2024-04-14 17:25:16 +0200
commitf48987f609cbbc05f08cb233846a7679907fb96f (patch)
tree4202a67cd268f7b1bd7c3ae493f5ce671ba9f15d /doc
parent1f265aa91d6ce11fbf499ee867eae13bc7117e9d (diff)
downloadffmpeg-f48987f609cbbc05f08cb233846a7679907fb96f.tar.gz
doc/muxers.texi: Don't use confusing variable name
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/muxers.texi4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/muxers.texi b/doc/muxers.texi
index 4b30970b78..489f22288b 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -2816,14 +2816,14 @@ ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_
@subsection Options
@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
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
-- e.g. streaming where seeking is possible but slow -- it is useful to put the
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
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.