diff options
author | wm4 <wm4@nowhere> | 2016-09-05 21:07:30 +0200 |
---|---|---|
committer | wm4 <wm4@nowhere> | 2016-09-05 21:26:39 +0200 |
commit | 13786dc643fe250a9560792ef342751585ea15e9 (patch) | |
tree | 90c76da55639d200558d9372e507da72684194a9 /DOCS | |
parent | 69283bc0f8905e7748343f2c5389791f858a5f4c (diff) | |
download | mpv-13786dc643fe250a9560792ef342751585ea15e9.tar.bz2 mpv-13786dc643fe250a9560792ef342751585ea15e9.tar.xz |
audio/out: deprecate device sub-options
We have --audio-device, which can force the device. Also add something
describing to this extent to the manpage.
Diffstat (limited to 'DOCS')
-rw-r--r-- | DOCS/interface-changes.rst | 1 | ||||
-rw-r--r-- | DOCS/man/ao.rst | 13 | ||||
-rw-r--r-- | DOCS/man/options.rst | 19 |
3 files changed, 17 insertions, 16 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst index ef9d61e931..3b2ff485ad 100644 --- a/DOCS/interface-changes.rst +++ b/DOCS/interface-changes.rst @@ -24,6 +24,7 @@ Interface changes replaced by global options, which do exactly the same. For example, "--vo=opengl:scale=nearest" turns into "--scale=nearest". In some cases, the global option is prefixed. + - deprecate the device/sink options on all AOs. Use --audio-device instead. - subtle changes in how "--no-..." options are treated mean that they are not accessible under "options/..." anymore (instead, these are resolved at parsing time). This does not affect options which start with "--no-", diff --git a/DOCS/man/ao.rst b/DOCS/man/ao.rst index 4583acff14..e82c541024 100644 --- a/DOCS/man/ao.rst +++ b/DOCS/man/ao.rst @@ -51,6 +51,7 @@ Available audio output drivers are: ``--oss-device`` Sets the audio output device (default: ``/dev/dsp``). + Deprecated, use ``--audio-device``. ``--oss-mixer-device`` Sets the audio mixer device (default: ``/dev/mixer``). ``--oss-mixer-channel`` @@ -129,6 +130,7 @@ Available audio output drivers are: 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). + Deprecated, use ``--audio-device``. ``--pulse-buffer=<1-2000|native>`` Set the audio buffer size in milliseconds. A higher value buffers @@ -238,6 +240,9 @@ Available audio output drivers are: Set the TCP port used for connecting to the server (default: 12345). Not used if connecting to a Unix domain socket. + These options are deprecated. If anyone cares enough, their functionality + can be added back using ``--audio-device``. + ``sndio`` Audio output to the OpenBSD sndio sound system @@ -250,6 +255,7 @@ Available audio output drivers are: ``--ao-sndio-device=<device>`` sndio device to use (default: ``$AUDIODEVICE``, resp. ``snd0``). + Deprecated, use ``--audio-device``. ``wasapi`` Audio output to the Windows Audio Session API. @@ -260,6 +266,8 @@ Available audio output drivers are: Requests exclusive, direct hardware access. By definition prevents sound playback of any other program until mpv exits. ``--ao-wasapi-device=<id>`` + Deprecated, use ``--audio-device``. + Uses the requested endpoint instead of the system's default audio endpoint. Both an ordinal number (0,1,2,...) and the GUID String are valid; the GUID string is guaranteed to not change @@ -267,8 +275,3 @@ Available audio output drivers are: Also supports searching active devices by human-readable name. If more than one device matches the name, refuses loading it. - - This option is mostly deprecated in favour of the more general - ``--audio-device`` option. That said, ``--audio-device=help`` will give - a list of valid device GUIDs (prefixed with ``wasapi/``), as well as - their human readable names, which should work here. diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index 6668849320..5d361d10b3 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -995,21 +995,18 @@ Audio ``--audio-device=<name>`` Use the given audio device. This consists of the audio output name, e.g. ``alsa``, followed by ``/``, followed by the audio output specific device - name. + name. The default value for this option is ``auto``, which tries every audio + output in preference order with the default device. You can list audio devices with ``--audio-device=help``. This outputs the device name in quotes, followed by a description. The device name is what - you have to pass to the ``--audio-device`` option. - - The default value for this option is ``auto``, which tries every audio - output in preference order with the default device. - - Note that many AOs have a ``device`` sub-option, which overrides the - device selection of this option (but not the audio output selection). - Likewise, forcing an AO with ``--ao`` will override the audio output - selection of ``--audio-device`` (but not the device selection). + you have to pass to the ``--audio-device`` option. The list of audio devices + can be retrieved by API by using the ``audio-device-list`` property. - Currently not implemented for most AOs. + While the option normally takes one of the strings as indicated by the + methods above, you can also force the device for most AOs by building it + manually. For example ``name/foobar`` forces the AO ``name`` to use the + device ``foobar``. ``--audio-fallback-to-null=<yes|no>`` If no audio device can be opened, behave as if ``--ao=null`` was given. This |