avfilter/transform: Stop exporting internal functions

[ffmpeg] / doc / outdevs.texi

diff --git a/doc/outdevs.texi b/doc/outdevs.texi
index c96d2d0e43b0932ba0f1dd603fbdb3311d442e12..aaf247995cc5e50f4176b80b46c3adc723ee30a9 100644 (file)
--- a/doc/outdevs.texi
+++ b/doc/outdevs.texi
@@ -38,6 +38,52 @@ ffmpeg -i INPUT -f alsa hw:1,7
 @end example
 @end itemize
 
+@section AudioToolbox
+
+AudioToolbox output device.
+
+Allows native output to CoreAudio devices on OSX.
+
+The output filename can be empty (or @code{-}) to refer to the default system output device or a number that refers to the device index as shown using: @code{-list_devices true}.
+
+Alternatively, the audio input device can be chosen by index using the
+@option{
+    -audio_device_index <INDEX>
+}
+, overriding any device name or index given in the input filename.
+
+All available devices can be enumerated by using @option{-list_devices true}, listing
+all device names, UIDs and corresponding indices.
+
+@subsection Options
+
+AudioToolbox supports the following options:
+
+@table @option
+
+@item -audio_device_index <INDEX>
+Specify the audio device by its index. Overrides anything given in the output filename.
+
+@end table
+
+@subsection Examples
+
+@itemize
+
+@item
+Print the list of supported devices and output a sine wave to the default device:
+@example
+$ ffmpeg -f lavfi -i sine=r=44100 -f audiotoolbox -list_devices true -
+@end example
+
+@item
+Output a sine wave to the device with the index 2, overriding any output filename:
+@example
+$ ffmpeg -f lavfi -i sine=r=44100 -f audiotoolbox -audio_device_index 2 -
+@end example
+
+@end itemize
+
 @section caca
 
 CACA output device.
@@ -140,8 +186,8 @@ device with @command{-list_formats 1}. Audio sample rate is always 48 kHz.
 
 @item list_devices
 If set to @option{true}, print a list of devices and exit.
-Defaults to @option{false}. Alternatively you can use the @code{-sinks}
-option of ffmpeg to list the available output devices.
+Defaults to @option{false}. This option is deprecated, please use the
+@code{-sinks} option of ffmpeg to list the available output devices.
 
 @item list_formats
 If set to @option{true}, print a list of supported formats and exit.
@@ -168,7 +214,7 @@ Defaults to @samp{unset}.
 @item
 List output devices:
 @example
-ffmpeg -i test.avi -f decklink -list_devices 1 dummy
+ffmpeg -sinks decklink
 @end example
 
 @item
@@ -329,6 +375,8 @@ ffmpeg  -i INPUT -f pulse "stream name"
 
 SDL (Simple DirectMedia Layer) output device.
 
+"sdl2" can be used as alias for "sdl".
+
 This output device allows one to show a video stream in an SDL
 window. Only one SDL window is allowed per application, so you can
 have only one instance of this output device in an application.