aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2013-07-06 10:27:19 +0200
committerStefano Sabatini <stefasab@gmail.com>2013-07-11 00:35:35 +0200
commitb3ac8a2a606c65157151a08860cc62128c415682 (patch)
treede713678ceeaa74774094c8401b08f81822be5bc
parente7a6962e7650e3c105b8658788c7a3ee9f5f1f2b (diff)
downloadffmpeg-b3ac8a2a606c65157151a08860cc62128c415682.tar.gz
doc/formats: add section describing stream specifiers
-rw-r--r--doc/formats.texi31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/formats.texi b/doc/formats.texi
index 6e69bfa582..e1797551ee 100644
--- a/doc/formats.texi
+++ b/doc/formats.texi
@@ -141,6 +141,37 @@ increase performance in some cases.
@c man end FORMAT OPTIONS
+@anchor{Format stream specifiers}
+@section Format stream specifiers
+
+Format stream specifiers allow selection of one or more streams that
+match specific properties.
+
+Possible forms of stream specifiers are:
+@table @option
+@item @var{stream_index}
+Matches the stream with this index.
+
+@item @var{stream_type}[:@var{stream_index}]
+@var{stream_type} is one of following: 'v' for video, 'a' for audio,
+'s' for subtitle, 'd' for data, and 't' for attachments. If
+@var{stream_index} is given, then it matches the stream number
+@var{stream_index} of this type. Otherwise, it matches all streams of
+this type.
+
+@item p:@var{program_id}[:@var{stream_index}]
+If @var{stream_index} is given, then it matches the stream with number
+@var{stream_index} in the program with the id
+@var{program_id}. Otherwise, it matches all streams in the program.
+
+@item #@var{stream_id}
+Matches the stream by a format-specific ID.
+@end table
+
+The exact semantics of stream specifiers is defined by the
+@code{avformat_match_stream_specifier()} function declared in the
+@file{libavformat/avformat.h} header.
+
@include demuxers.texi
@include muxers.texi
@include metadata.texi