summaryrefslogtreecommitdiff
path: root/doc/ffmpeg-devices.texi
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-11-26 23:38:32 +0100
committerStefano Sabatini <stefasab@gmail.com>2012-11-27 23:35:25 +0100
commitd82331721ee6c6e3168399d5b4ab039183b6f9ae (patch)
treecc7be169e8e8abee25dc83d96a9ea86803cc5170 /doc/ffmpeg-devices.texi
parent8ddeae5ae7b83fec9185af32bb191ec249ef96bd (diff)
doc: add libavdevice.texi and ffmpeg-devices.texi files
Diffstat (limited to 'doc/ffmpeg-devices.texi')
-rw-r--r--doc/ffmpeg-devices.texi57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/ffmpeg-devices.texi b/doc/ffmpeg-devices.texi
new file mode 100644
index 0000000000..542dae89c5
--- /dev/null
+++ b/doc/ffmpeg-devices.texi
@@ -0,0 +1,57 @@
+\input texinfo @c -*- texinfo -*-
+
+@settitle FFmpeg Devices Documentation
+@titlepage
+@center @titlefont{FFmpeg Devices Documentation}
+@end titlepage
+
+@top
+
+@contents
+
+@chapter Description
+@c man begin DESCRIPTION
+
+This document describes the input and output devices provided by the
+libavdevice library.
+
+@c man end DESCRIPTION
+
+@chapter Device Options
+@c man begin DEVICE OPTIONS
+
+The libavdevice library provides the same interface as
+libavformat. Namely, an input device is considered like a demuxer, and
+an output device like a muxer, and the interface and generic device
+options are the same provided by libavformat (see the @ref{FFmpeg
+formats} manual page).
+
+In addition each input or output device may support so-called private
+options, which are specific for that component.
+
+Options may be set by specifying -@var{option} @var{value} in the
+FFmpeg tools, or by setting the value explicitly in the device
+@code{AVFormatContext} options or using the @file{libavutil/opt.h} API
+for programmatic use.
+
+@c man end DEVICE OPTIONS
+
+@include indevs.texi
+@include outdevs.texi
+
+@ignore
+
+@setfilename ffmpeg-devices
+@settitle FFmpeg devices
+
+@c man begin SEEALSO
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3), libavdevice(3)
+@c man end
+
+@c man begin AUTHORS
+See Git history (git://source.ffmpeg.org/ffmpeg)
+@c man end
+
+@end ignore
+
+@bye