[FFmpeg-devel] [PATCH] lavd/avfoundation: Update documentation to mention audio capabilities.

[Thilo Borgmann]

Am 06.11.14 21:25, schrieb Thilo Borgmann:
> [...]
>>> +The device index can also be given by using -video_device_index and/or -audio_device_index, respectively.
>>
>> Nit: Use @option or @code for option names: @option{-video_device_index}
>>
>> option is more "accurate", but code is what we usually have used, IIRC.
>> Either if fine in my opinion since we aren't consistent in the docs,
>> but they do look different in the rendered output.
>>
>> Otherwise, LGTM.
> 
> New patch using these attached.

Grammar fixed.

-Thilo

-------------- next part --------------
>From 40670e29f096c54646065852552ae2db08a43233 Mon Sep 17 00:00:00 2001
From: Thilo Borgmann <thilo.borgmann at mail.de>
Date: Thu, 6 Nov 2014 21:28:12 +0100
Subject: [PATCH] lavd/avfoundation: Update documentation to mention audio
 capabilities.

---
 doc/indevs.texi | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/doc/indevs.texi b/doc/indevs.texi
index 99e1112..18fc5a2 100644
--- a/doc/indevs.texi
+++ b/doc/indevs.texi
@@ -58,28 +58,30 @@ AVFoundation input device.
 AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.
 The older QTKit framework has been marked deprecated since OSX version 10.7.
 
-The filename passed as input is parsed to contain either a device name or index.
-The device index can also be given by using -video_device_index.
+The filename passed as input is parsed to contain two input streams seperated by ":".
+The first entry selects the video input while the latter selects the audio input @option{"<video>:<audio>"}.
+Each stream can either be specified by the device name or the index.
+The device index can also be given by using @option{-video_device_index <index>} and/or @option{-audio_device_index <index>}, respectively.
 A given device index will override any given device name.
-If the desired device consists of numbers only, use -video_device_index to identify it.
-The default device will be chosen if an empty string  or the device name "default" is given.
-The available devices can be enumerated by using -list_devices.
-The pixel format can be set using -pixel_format.
+If the desired device consists of numbers only, use the device index option to identify it.
+The default device will be chosen if an empty string  or the device name @code{default} is given.
+The available devices can be enumerated by using @option{-list_devices true}.
+The pixel format can be set using @option{-pixel_format <format>}.
 Available formats:
- monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
+ at code{monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
  bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
- yuv420p, nv12, yuyv422, gray
+ yuv420p, nv12, yuyv422, gray}
 
 @example
-ffmpeg -f avfoundation -i "0" out.mpg
+ffmpeg -f avfoundation -i "0:0" out.mpg
 @end example
 
 @example
-ffmpeg -f avfoundation -video_device_index 0 -i "" out.mpg
+ffmpeg -f avfoundation -video_device_index 0 -i ":0" out.mpg
 @end example
 
 @example
-ffmpeg -f avfoundation -pixel_format bgr0 -i "default" out.mpg
+ffmpeg -f avfoundation -pixel_format bgr0 -i "default:default" out.mpg
 @end example
 
 @example
-- 
1.8.3.2