aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2013-01-18 18:56:29 +0100
committerStefano Sabatini <stefasab@gmail.com>2013-01-18 23:17:47 +0100
commit2852bd704a349b1dbea4a2546b11adddf4dfb0be (patch)
treeb03cc1d3e7bd3108387b49b242fb0bce97170764 /doc
parent44d5a28b7d9e937b45150a498584aff417dba9f3 (diff)
downloadffmpeg-2852bd704a349b1dbea4a2546b11adddf4dfb0be.tar.gz
lavfi/fade: accept shorthand syntax
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi32
1 files changed, 13 insertions, 19 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index be65350c91..9def1dc071 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -2276,33 +2276,27 @@ edgedetect=low=0.1:high=0.4
Apply fade-in/out effect to input video.
-It accepts the parameters:
-@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.
-
-@var{start_frame} specifies the number of the start frame for starting
-to apply the fade effect.
-
-@var{nb_frames} specifies the number of frames for which the fade
-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.
+The filter accepts parameters as a list of @var{key}=@var{value}
+pairs, separated by ":". If the key of the first options is omitted,
+the arguments are interpreted according to the syntax
+@var{type}:@var{start_frame}:@var{nb_frames}.
-@var{options} is an optional sequence of @var{key}=@var{value} pairs,
-separated by ":". The description of the accepted options follows.
+A description of the accepted parameters follows.
@table @option
-
@item type, t
-See @var{type}.
+Specify if the effect type, can be either @code{in} for fade-in, or
+@code{out} for a fade-out effect. Default is @code{in}.
@item start_frame, s
-See @var{start_frame}.
+Specify the number of the start frame for starting to apply the fade
+effect. Default is 0.
@item nb_frames, n
-See @var{nb_frames}.
+Specify the number of frames for which the fade 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. Default is 25.
@item alpha
If set to 1, fade only alpha channel, if one exists on the input.