From f9507fe9271329aba8b9f237ef71befde9e8b9f0 Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Fri, 22 May 2015 20:23:47 +0200
Subject: command: add audio-params and audio-out-params properties

---
 DOCS/man/input.rst | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

(limited to 'DOCS/man/input.rst')

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``).
 
-- 
cgit v1.2.3