diff options
author | Timothy Gu <timothygu99@gmail.com> | 2013-09-03 17:19:26 -0700 |
---|---|---|
committer | Stefano Sabatini <stefasab@gmail.com> | 2013-10-16 18:32:15 +0200 |
commit | b4da1fa550db697a5d409dfde38457dd1ebb3ec1 (patch) | |
tree | 76e3e550e7b5934e4ec429d3148cefd97421a82c /doc | |
parent | d0b7d24b80b390b2013adc3c8e0e2063836ee293 (diff) | |
download | ffmpeg-streaming-b4da1fa550db697a5d409dfde38457dd1ebb3ec1.zip ffmpeg-streaming-b4da1fa550db697a5d409dfde38457dd1ebb3ec1.tar.gz |
doc/utils: rewrite doc for time duration syntax
Extend description and clarify syntax.
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/utils.texi | 38 |
1 files changed, 33 insertions, 5 deletions
diff --git a/doc/utils.texi b/doc/utils.texi index 243973d..484da5f 100644 --- a/doc/utils.texi +++ b/doc/utils.texi @@ -96,14 +96,42 @@ year-month-day. @anchor{time duration syntax} @section Time duration -The accepted syntax is: +There are two accepted syntaxes for expressing time duration. + +@example +[-][@var{HH}:]@var{MM}:@var{SS}[.@var{m}...] +@end example + +@var{HH} expresses the number of hours, @var{MM} the number of minutes +for a maximum of 2 digits, and @var{SS} the number of seconds for a +maximum of 2 digits. The @var{m} at the end expresses decimal value for +@var{SS}. + +@emph{or} + @example -[-][HH:]MM:SS[.m...] -[-]S+[.m...] +[-]@var{S}+[.@var{m}...] @end example -@var{HH} expresses the number of hours, @var{MM} the number a of minutes -and @var{SS} the number of seconds. +@var{S} expresses the number of seconds, with the optional decimal part +@var{m}. + +In both expressions, the optional @samp{-} indicates negative duration. + +@subsection Examples + +The following examples are all valid time duration: + +@table @samp +@item 55 +55 seconds + +@item 12:03:45 +12 hours, 03 minutes and 45 seconds + +@item 23.189 +23.189 seconds +@end table @anchor{video size syntax} @section Video size |