summaryrefslogtreecommitdiff
path: root/doc/outdevs.texi
diff options
context:
space:
mode:
authorThilo Borgmann <thilo.borgmann@mail.de>2020-06-15 15:09:33 +0200
committerThilo Borgmann <thilo.borgmann@mail.de>2020-06-15 15:09:33 +0200
commitb737575c76ff33ef5ffd602ebf3e30cc71ec536c (patch)
tree2246164229a29ae9ea58658cb234a9645929f9c7 /doc/outdevs.texi
parent9d80f3ec4b08815719ce554c0a08ed27e671d6dc (diff)
lavdevice: Add AudioToolbox output device.
Diffstat (limited to 'doc/outdevs.texi')
-rw-r--r--doc/outdevs.texi46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/outdevs.texi b/doc/outdevs.texi
index 60606eb6e7..aaf247995c 100644
--- 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.