[FFmpeg-devel] [PATCH 6/7] doc: add documentation for dshow indev

[Ramiro Polla]

---
 doc/indevs.texi |   73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 73 insertions(+), 0 deletions(-)

diff --git a/doc/indevs.texi b/doc/indevs.texi
index c38031f..af95e00 100644
--- a/doc/indevs.texi
+++ b/doc/indevs.texi
@@ -55,6 +55,79 @@ For more information see:
 
 BSD video input device.
 
+ at section dshow
+
+Windows DirectShow input device.
+
+DirectShow support is enabled when FFmpeg is built with mingw-w64.
+Currently only audio and video devices are supported.
+
+Multiple devices may be opened as separate inputs, but they may also be
+opened on the same input, which should improve synchronism between them.
+
+The input name should be in the format:
+
+ at example
+ at var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
+ at end example
+
+where @var{TYPE} can be either @var{audio} or @var{video},
+and @var{NAME} is the device's name.
+
+ at subsection Options
+
+If no options are specified, the device's defaults are used.
+If the device does not support the requested options, FFmpeg
+will fail to open it.
+
+ at table @option
+
+ at item video_size
+Set the video size in the captured video.
+
+ at item framerate
+Set the framerate in the captured video.
+
+ at item sample_rate
+Set the sample rate (in Hz) of the captured audio.
+
+ at item sample_size
+Set the sample size (in bits) of the captured audio.
+
+ at item channels
+Set the number of channels in the captured audio.
+
+ at item list_devices
+If set to @option{true}, print a list of devices and exit.
+
+ at item list_options
+If set to @option{true}, print a list of selected device's options
+and exit.
+
+ at end table
+
+ at subsection Examples
+
+Print the list of DirectShow supported devices and exit:
+ at example
+$ ffmpeg -list_devices true -f dshow -i dummy
+ at end example
+
+Open video device @var{Camera}:
+ at example
+$ ffmpeg -f dshow -i video="Camera"
+ at end example
+
+Open video device @var{Camera} and audio device @var{Microphone}:
+ at example
+$ ffmpeg -f dshow -i video="Camera":audio="Microphone"
+ at end example
+
+Print the list of supported options in selected device and exit:
+ at example
+$ ffmpeg -list_options true -f dshow -i video="Camera"
+ at end example
+
 @section dv1394
 
 Linux DV 1394 input device.
-- 
1.7.4.1