Browse code

doc/muxers: extend and clarify documentation for the segment muxer time options

Stefano Sabatini authored on 2013/01/19 08:50:40
Showing 1 changed files
... ...
@@ -588,11 +588,17 @@ A list file with the suffix @code{".m3u8"} will auto-select this format.
588 588
 If not specified the type is guessed from the list file name suffix.
589 589
 
590 590
 @item segment_time @var{time}
591
-Set segment duration to @var{time}. Default value is "2".
591
+Set segment duration to @var{time}, the value must be a duration
592
+specification. Default value is "2". See also the
593
+@option{segment_times} option.
594
+
595
+Note that splitting may not be accurate, unless you force the
596
+reference stream key-frames at the given time. See the introductory
597
+notice and the examples below.
592 598
 
593 599
 @item segment_time_delta @var{delta}
594 600
 Specify the accuracy time when selecting the start time for a
595
-segment. Default value is "0".
601
+segment, expressed as a duration specification. Default value is "0".
596 602
 
597 603
 When delta is specified a key-frame will start a new segment if its
598 604
 PTS satisfies the relation:
... ...
@@ -614,7 +620,8 @@ the specified time and the time set by @var{force_key_frames}.
614 614
 
615 615
 @item segment_times @var{times}
616 616
 Specify a list of split points. @var{times} contains a list of comma
617
-separated duration specifications, in increasing order.
617
+separated duration specifications, in increasing order. See also
618
+the @option{segment_time} option.
618 619
 
619 620
 @item segment_frames @var{frames}
620 621
 Specify a list of split video frame numbers. @var{frames} contains a