summaryrefslogtreecommitdiffstats
path: root/DOCS/man/en/ao.rst
diff options
context:
space:
mode:
Diffstat (limited to 'DOCS/man/en/ao.rst')
-rw-r--r--DOCS/man/en/ao.rst122
1 files changed, 61 insertions, 61 deletions
diff --git a/DOCS/man/en/ao.rst b/DOCS/man/en/ao.rst
index f8af559ee9..8ccb8a6711 100644
--- a/DOCS/man/en/ao.rst
+++ b/DOCS/man/en/ao.rst
@@ -1,20 +1,20 @@
-.. _audio_outputs:
-
AUDIO OUTPUT DRIVERS
====================
Audio output drivers are interfaces to different audio output facilities. The
syntax is:
---ao=<driver1[:suboption1[=value]:...],driver2,...[,]>
+``--ao=<driver1[:suboption1[=value]:...],driver2,...[,]>``
Specify a priority list of audio output drivers to be used.
-If the list has a trailing ',' mpv will fall back on drivers not contained
+If the list has a trailing ',', mpv will fall back on drivers not contained
in the list. Suboptions are optional and can mostly be omitted.
-*NOTE*: See ``--ao=help`` for a list of compiled-in audio output drivers.
+.. note::
+
+ See ``--ao=help`` for a list of compiled-in audio output drivers.
-*EXAMPLE*:
+.. admonition:: Examples
- ``--ao=alsa,oss,`` Try the ALSA driver, then the OSS driver, then others.
- ``--ao=alsa:noblock:device=hw=0.3`` Sets noblock-mode and the device-name
@@ -22,132 +22,132 @@ in the list. Suboptions are optional and can mostly be omitted.
Available audio output drivers are:
-alsa
+``alsa`` (Linux only)
ALSA 0.9/1.x audio output driver
- noblock
+ ``noblock``
Sets noblock-mode.
- device=<device>
+ ``device=<device>``
Sets the device name. Replace any ',' with '.' and any ':' with '=' in
the ALSA device name. For hwac3 output via S/PDIF, use an "iec958" or
"spdif" device, unless you really know how to set it correctly.
-oss
+``oss``
OSS audio output driver
- <dsp-device>
+ ``<dsp-device>``
Sets the audio output device (default: ``/dev/dsp``).
- <mixer-device>
+ ``<mixer-device>``
Sets the audio mixer device (default: ``/dev/mixer``).
- <mixer-channel>
- Sets the audio mixer channel (default: pcm).
+ ``<mixer-channel>``
+ Sets the audio mixer channel (default: ``pcm``).
-jack
- audio output through JACK (Jack Audio Connection Kit)
+``jack``
+ JACK (Jack Audio Connection Kit) audio output driver
- port=<name>
+ ``port=<name>``
Connects to the ports with the given name (default: physical ports).
- name=<client>
+ ``name=<client>``
Client name that is passed to JACK (default: mpv [<PID>]). Useful
if you want to have certain connections established automatically.
- (no-)estimate
+ ``(no-)estimate``
Estimate the audio delay, supposed to make the video playback smoother
(default: enabled).
- (no-)autostart
+ ``(no-)autostart``
Automatically start jackd if necessary (default: disabled). Note that
- this seems unreliable and will spam stdout with server messages.
- (no-)connect
+ this tends to be unreliable and will flood stdout with server messages.
+ ``(no-)connect``
Automatically create connections to output ports (default: enabled).
When enabled, the maximum number of output channels will be limited to
the number of available output ports.
- std-channel-layout=alsa|waveext|any
+ ``std-channel-layout=alsa|waveext|any``
Select the standard channel layout (default: alsa). JACK itself has no
notion of channel layouts (i.e. assigning which speaker a given
channel is supposed to map to) - it just takes whatever the application
outputs, and reroutes it to whatever the user defines. This means the
- user and the application is in charge of dealing with the channel
+ user and the application are in charge of dealing with the channel
layout. ``alsa`` uses the old MPlayer layout, which is inspired by
ALSA's standard layouts. In this mode, ao_jack will refuse to play 3
- or 7 channels (because these don't really have a defined meaning in
- MPlayer). ``waveext`` uses WAVE_FORMAT_EXTENSIBLE order, which even
+ or 7 channels (because these do not really have a defined meaning in
+ MPlayer). ``waveext`` uses WAVE_FORMAT_EXTENSIBLE order, which, even
though it was defined by Microsoft, is the standard on many systems.
The value ``any`` makes JACK accept whatever comes from the audio
filter chain, regardless of channel layout and without reordering. This
- mode is probably not very useful, other than debugging or when used
+ mode is probably not very useful, other than for debugging or when used
with fixed setups.
-coreaudio (Mac OS X only)
- native Mac OS X audio output driver
+``coreaudio`` (Mac OS X only)
+ Native Mac OS X audio output driver
- device_id=<id>
+ ``device_id=<id>``
ID of output device to use (0 = default device)
- help
+ ``help``
List all available output devices with their IDs.
-openal
+``openal``
Experimental OpenAL audio output driver
-pulse
+``pulse``
PulseAudio audio output driver
- [<host>][:<output sink>]
+ ``[<host>][:<output sink>]``
Specify the host and optionally output sink to use. An empty <host>
string uses a local connection, "localhost" uses network transfer
(most likely not what you want).
-portaudio
- PortAudio audio output driver. This works on all platforms, and has extensive
- MS Windows support.
+``portaudio``
+ PortAudio audio output driver. This works on all platforms, and has
+ extensive MS Windows support.
- device
+ ``device``
Specify the subdevice to use. Giving ``help`` as device name lists all
devices found by PortAudio. Devices can be given as numeric values,
starting from ``1``.
-dsound (Windows only)
+``dsound`` (Windows only)
DirectX DirectSound audio output driver
- device=<devicenum>
+ ``device=<devicenum>``
Sets the device number to use. Playing a file with ``-v`` will show a
list of available devices.
-sdl
- SDL 1.2+ audio output driver. Should work everywhere where SDL 1.2 builds,
- but may require the SDL_AUDIODRIVER environment variable to be set
+``sdl``
+ SDL 1.2+ audio output driver. Should work on any platform supported by SDL
+ 1.2, but may require the ``SDL_AUDIODRIVER`` environment variable to be set
appropriately for your system.
- buflen=<length>
- Sets the audio buffer length in seconds. Is used only approximately,
- or even disaregarded entirely by the sound system. Playing a file with
- ``-v`` will show the requested and obtained exact buffer size. A value
- of 0 selects the sound system default.
+ ``buflen=<length>``
+ Sets the audio buffer length in seconds. Is used only as a hint by the
+ sound system. Playing a file with ``-v`` will show the requested and
+ obtained exact buffer size. A value of 0 selects the sound system
+ default.
- bufcnt=<count>
+ ``bufcnt=<count>``
Sets the number of extra audio buffers in mpv. Usually needs not be
changed.
-null
+``null``
Produces no audio output but maintains video playback speed. Use
``--no-audio`` for benchmarking.
-pcm
- raw PCM/wave file writer audio output
+``pcm``
+ Raw PCM/WAVE file writer audio output
- (no-)waveheader
- Include or do not include the wave header (default: included). When
+ ``(no-)waveheader``
+ Include or do not include the WAVE header (default: included). When
not included, raw PCM will be generated.
- file=<filename>
- Write the sound to <filename> instead of the default
- ``audiodump.wav``. If nowaveheader is specified, the default is
+ ``file=<filename>``
+ Write the sound to ``<filename>`` instead of the default
+ ``audiodump.wav``. If ``no-waveheader`` is specified, the default is
``audiodump.pcm``.
-rsound
- audio output to an RSound daemon
+``rsound``
+ Audio output to an RSound daemon
- host=<name/path>
+ ``host=<name/path>``
Set the address of the server (default: localhost). Can be either a
network hostname for TCP connections or a Unix domain socket path
starting with '/'.
- port=<number>
+ ``port=<number>``
Set the TCP port used for connecting to the server (default: 12345).
Not used if connecting to a Unix domain socket.