summaryrefslogtreecommitdiffstats
path: root/DOCS/man/en
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-04-11 01:00:13 +0200
committerwm4 <wm4@nowhere>2014-04-11 01:05:06 +0200
commitd3e9f51c71a1691b76ee0918d228c5fe987e4ffa (patch)
treeb34c941a54456a4901259e1e2444057e30d4424a /DOCS/man/en
parent55d6e1f98d476edf488d65578d37ece7069d4ce4 (diff)
downloadmpv-d3e9f51c71a1691b76ee0918d228c5fe987e4ffa.tar.bz2
mpv-d3e9f51c71a1691b76ee0918d228c5fe987e4ffa.tar.xz
manpage: document how the client API retrieves the complicated properties
"Complicated" as in they use sub-properties, and using MPV_FORMAT_NODE allows an application to retrieve all information at once.
Diffstat (limited to 'DOCS/man/en')
-rw-r--r--DOCS/man/en/input.rst82
1 files changed, 82 insertions, 0 deletions
diff --git a/DOCS/man/en/input.rst b/DOCS/man/en/input.rst
index e64bc7ebef..2672d3c6af 100644
--- a/DOCS/man/en/input.rst
+++ b/DOCS/man/en/input.rst
@@ -534,6 +534,9 @@ If an option is referenced, the property will normally take/return exactly the
same values as the option. In these cases, properties are merely a way to change
an option at runtime.
+Property list
+-------------
+
``osd-level`` (RW)
See ``--osd-level``.
@@ -663,6 +666,17 @@ an option at runtime.
``edition-list/N/title``
Edition title as stored in the file. Not always available.
+ 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 edition)
+ "id" MPV_FORMAT_INT64
+ "title" MPV_FORMAT_STRING
+ "default" MPV_FORMAT_FLAG
``angle`` (RW)
Current DVD angle.
@@ -699,6 +713,15 @@ an option at runtime.
The layout of this property might be subject to change. Suggestions are
welcome how exactly this property should work.
+ 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_MAP
+ (key and string value for each metdata entry)
+
``chapter-metadata``
Metadata of current chapter. Works similar to ``metadata`` property. IT
also allows the same access methods (using sub-properties).
@@ -854,6 +877,25 @@ an option at runtime.
``video-params/chroma-location``
Chroma location as string. (Exact values subject to change.)
+ 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)
+ "pixelformat" MPV_FORMAT_STRING
+ "w" MPV_FORMAT_INT64
+ "h" MPV_FORMAT_INT64
+ "dw" MPV_FORMAT_INT64
+ "dh" MPV_FORMAT_INT64
+ "aspect" MPV_FORMAT_DOUBLE
+ "par" MPV_FORMAT_DOUBLE
+ "colormatrix" MPV_FORMAT_STRING
+ "colorlevels" MPV_FORMAT_STRING
+ "chroma-location" MPV_FORMAT_STRING
+
``dwidth``, ``dheight``
Video display size. This is the video size after filters and aspect scaling
have been applied. The actual video window size can still be different
@@ -970,6 +1012,16 @@ an option at runtime.
``playlist/N/filename``
Filename of the Nth entry.
+ 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 playlist entry)
+ "filename" MPV_FORMAT_STRING
+
``track-list``
List of audio/video/sub tracks, current entry marked. Currently, the raw
property value is useless.
@@ -1020,6 +1072,25 @@ an option at runtime.
``track-list/N/selected``
``yes`` if the track is currently decoded, ``no`` otherwise.
+ 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)
+ "id" MPV_FORMAT_INT64
+ "type" MPV_FORMAT_STRING
+ "src-id" MPV_FORMAT_INT64
+ "title" MPV_FORMAT_STRING
+ "lang" MPV_FORMAT_STRING
+ "albumart" MPV_FORMAT_FLAG
+ "default" MPV_FORMAT_FLAG
+ "external" MPV_FORMAT_FLAG
+ "external-filename" MPV_FORMAT_STRING
+ "codec" MPV_FORMAT_STRING
+
``chapter-list``
List of chapters, current entry marked. Currently, the raw property value
is useless.
@@ -1036,6 +1107,17 @@ an option at runtime.
``chapter-list/N/time``
Chapter start time in seconds as float.
+ 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 chapter)
+ "title" MPV_FORMAT_STRING
+ "time" MPV_FORMAT_DOUBLE
+
``quvi-format`` (RW)
See ``--quvi-format``. Cycling this property (``cycle``) will attempt to
cycle through known format, although currently this feature doesn't work