aboutsummaryrefslogtreecommitdiffhomepage
path: root/DOCS
diff options
context:
space:
mode:
authorGravatar wm4 <wm4@nowhere>2015-05-22 20:23:47 +0200
committerGravatar wm4 <wm4@nowhere>2015-05-22 20:23:47 +0200
commitf9507fe9271329aba8b9f237ef71befde9e8b9f0 (patch)
tree41c9919467361092d845e4a2732bcdbf35c901b3 /DOCS
parent1eaceb5fae4eae3cc767b9329fdeda21ae1338f3 (diff)
command: add audio-params and audio-out-params properties
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/interface-changes.rst1
-rw-r--r--DOCS/man/input.rst36
2 files changed, 37 insertions, 0 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index 69cf0021a2..69fe7c7a21 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -20,6 +20,7 @@ Interface changes
::
--- mpv 0.10.0 will be released ---
+ - add audio-params and audio-out-params properties
- deprecate "audio-format" property, replaced with "audio-codec-name"
- deprecate --media-title, replaced with --force-media-title
- deprecate "length" property, replaced with "duration"
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 57823497ad..f12d0eb15a 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1156,6 +1156,42 @@ Property list
Number of audio channels. The OSD value of this property is actually the
channel layout, while the raw value returns the number of channels only.
+``audio-params``
+ Audio format as output by the audio decoder.
+ This has a number of sub-properties:
+
+ ``audio-params/format``
+ The sample format as string. This uses the same names as used in other
+ places of mpv.
+
+ ``audio-params/samplerate``
+ Samplerate.
+
+ ``audio-params/channels``
+ The channel layout as a string. This is similar to what the
+ ``--audio-channels`` accepts.
+
+ ``audio-params/channel-count``
+ Number of audio channels. This is redundant to the ``channels`` field
+ described above.
+
+ 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 track)
+ "format" MPV_FORMAT_STRING
+ "samplerate" MPV_FORMAT_INT64
+ "channels" MPV_FORMAT_STRING
+ "channel-count" MPV_FORMAT_INT64
+
+``audio-out-params``
+ Same as ``audio-params``, but the format of the data written to the audio
+ API.
+
``aid`` (RW)
Current audio track (similar to ``--aid``).