summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMark Himsley <mark@mdsh.com>2011-11-09 01:17:55 +0100
committerStefano Sabatini <stefasab@gmail.com>2011-11-10 01:28:31 +0100
commit0d602615ab58b14859dc915b94385cd79e21a87e (patch)
treebcbc99c596f94fc9b70052118298792b74f3c81a /doc
parentdea8f6e18b697a9ea9e3426994897f64dd4b4773 (diff)
vf_fade: add support to options parsing
Extend fade syntax, required by a pending patch. Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index f8a2d1b285..2741f96e4f 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -1139,7 +1139,7 @@ For more information about libfreetype, check:
Apply fade-in/out effect to input video.
It accepts the parameters:
-@var{type}:@var{start_frame}:@var{nb_frames}
+@var{type}:@var{start_frame}:@var{nb_frames}[:@var{options}]
@var{type} specifies if the effect type, can be either "in" for
fade-in, or "out" for a fade-out effect.
@@ -1152,6 +1152,22 @@ effect has to last. At the end of the fade-in effect the output video
will have the same intensity as the input video, at the end of the
fade-out transition the output video will be completely black.
+@var{options} is an optional sequence of @var{key}=@var{value} pairs,
+separated by ":". The description of the accepted options follows.
+
+@table @option
+
+@item type, t
+See @var{type}.
+
+@item start_frame, s
+See @var{start_frame}.
+
+@item nb_frames, n
+See @var{nb_frames}.
+
+@end table
+
A few usage examples follow, usable too as test scenarios.
@example
# fade in first 30 frames of video