summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-10-10 19:46:21 +0200
committerwm4 <wm4@nowhere>2014-10-10 19:49:10 +0200
commit2f28e071c82df90ec407e94f11fc2cb2ac95761e (patch)
tree68ca6064dd9477ce7e27e552fafc3b36db25cb43 /DOCS
parent04a5d25bf792ca083e9a3956b2298e6e4dbe90cc (diff)
downloadmpv-2f28e071c82df90ec407e94f11fc2cb2ac95761e.tar.bz2
mpv-2f28e071c82df90ec407e94f11fc2cb2ac95761e.tar.xz
command: make audio device list available to the client API
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/input.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 301d779850..269783c45b 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1334,6 +1334,27 @@ Property list
Note that you need to escape the ``\`` character, because the string is
processed for C escape sequences before passing it to the OSD code.
+``audio-device-list``
+ Return the list of discovered audio devices. This is mostly for use with
+ the client API, and reflects what ``--audio-device=help`` with the command
+ line player returns.
+
+ When querying the property with the client API using ``MPV_FORMAT_NODE``,
+ or with Lua ``mp.get_property_native``, this will return a mpv_node with
+ the following contents:
+
+ ::
+
+ MPV_FORMAT_NODE_ARRAY
+ MPV_FORMAT_NODE_MAP (for each device entry)
+ "name" MPV_FORMAT_STRING
+ "description" MPV_FORMAT_STRING
+
+ The ``name`` is what is to be passed to the ``--audio-device`` option (and
+ often a rather cryptic audio API-specific ID), while ``description`` is
+ human readable free form text. The description is an empty string if none
+ was received.
+
``options/<name>`` (RW)
Read-only access to value of option ``--<name>``. Most options can be
changed at runtime by writing to this property. Note that many options