summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2016-09-01 20:00:43 +0200
committerwm4 <wm4@nowhere>2016-09-01 20:00:43 +0200
commitd32bee5f019f2c51839df16b7c7955dc33651cbe (patch)
tree96424f3477a67ca6b5f6220295bf4c906ac6106a /DOCS
parent17dbb39dec1fcd3280f86e480a7191b6f78cbbcc (diff)
downloadmpv-d32bee5f019f2c51839df16b7c7955dc33651cbe.tar.bz2
mpv-d32bee5f019f2c51839df16b7c7955dc33651cbe.tar.xz
command: add options to property list
Now options are accessible through the property list as well, which unifies them to a degree. Not all options support runtime changes (meaning affected components need to be restarted for the options to take effects). Remove from the manpage those properties which are cleanly mapped to options anyway. From the user-perspective they're just options available through the property interface.
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/interface-changes.rst2
-rw-r--r--DOCS/man/input.rst173
-rw-r--r--DOCS/man/options.rst5
3 files changed, 20 insertions, 160 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index f3861c7b82..fd4193a4e9 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -25,6 +25,8 @@ Interface changes
at parsing time). This does not affect options which start with "--no-",
but do not use the mechanism for negation options.
(Also see client API change for API version 1.23.)
+ - add almost all options to the property list, meaning you can change
+ options without adding "options/" to the property name
--- mpv 0.20.0 ---
- add --image-display-duration option - this also means that image duration
is not influenced by --mf-fps anymore in the general case (this is an
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 5892649fe5..fbc7c8faa3 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -838,20 +838,12 @@ an option at runtime.
Property list
-------------
-``osd-level`` (RW)
- See ``--osd-level``.
+.. note::
-``osd-scale`` (RW)
- OSD font size multiplier, see ``--osd-scale``.
-
-``loop`` (RW)
- See ``--loop``.
-
-``loop-file`` (RW)
- See ``--loop-file`` (uses ``yes``/``no``).
-
-``speed`` (RW)
- See ``--speed``.
+ Most options can be set as runtime via properties as well. Just remove the
+ leading ``--`` from the option name. These are not documented. Only
+ properties which do not exist as option with the same name, or which have
+ very different behavior from the options are documented below.
``audio-speed-correction``, ``video-speed-correction``
Factor multiplied with ``speed`` at which the player attempts to play the
@@ -1078,10 +1070,6 @@ Property list
"title" MPV_FORMAT_STRING
"default" MPV_FORMAT_FLAG
-``ab-loop-a``, ``ab-loop-b`` (RW)
- Set/get A-B loop points. See corresponding options and ``ab-loop`` command
- for details.
-
``angle`` (RW)
Current DVD angle.
@@ -1154,9 +1142,6 @@ Property list
``af-metadata/<filter-label>``
Equivalent to ``vf-metadata/<filter-label>``, but for audio filters.
-``pause`` (RW)
- Pause status. This is usually ``yes`` or ``no``. See ``--pause``.
-
``idle``
Return ``yes`` if no file is loaded, but the player is staying around
because of the ``--idle`` option.
@@ -1236,25 +1221,12 @@ Property list
is loaded, or when switching ordered chapter segments. This is because
the same underlying code is used for seeking and resyncing.)
-``hr-seek`` (RW)
- See ``--hr-seek``.
-
``mixer-active``
Return ``yes`` if the audio mixer is active, ``no`` otherwise.
This option is relatively useless. Before mpv 0.18.1, it could be used to
infer behavior of the ``volume`` property.
-``volume`` (RW)
- Current volume (see ``--volume`` for details).
-
-``volume-max`` (RW)
- Current maximum value the volume property can be set to. (Equivalent to the
- ``--volume-max`` option.)
-
-``mute`` (RW)
- Current mute status (``yes``/``no``).
-
``ao-volume`` (RW)
System volume. This property is available only if mpv audio output is
currently active, and only if the underlying implementation supports volume
@@ -1266,9 +1238,6 @@ Property list
Similar to ``ao-volume``, but controls the mute state. May be unimplemented
even if ``ao-volume`` works.
-``audio-delay`` (RW)
- See ``--audio-delay``.
-
``audio-codec``
Audio codec selected for decoding.
@@ -1316,28 +1285,6 @@ Property list
Same as ``audio-params``, but the format of the data written to the audio
API.
-``aid`` (RW)
- Current audio track (similar to ``--aid``).
-
-``audio`` (RW)
- Alias for ``aid``.
-
-``balance`` (RW)
- Audio channel balance. (The implementation of this feature is rather odd.
- It doesn't change the volumes of each channel, but instead sets up a pan
- matrix to mix the left and right channels.)
-
- Deprecated.
-
-``fullscreen`` (RW)
- See ``--fullscreen``.
-
-``deinterlace`` (RW)
- See ``--deinterlace``.
-
-``field-dominance`` (RW)
- See ``--field-dominance``
-
``colormatrix`` (R)
Redirects to ``video-params/colormatrix``. This parameter (as well as
similar ones) can be overridden with the ``format`` video filter.
@@ -1345,42 +1292,9 @@ Property list
``colormatrix-input-range`` (R)
See ``colormatrix``.
-``video-output-levels`` (RW)
- See ``--video-output-levels``,
-
``colormatrix-primaries`` (R)
See ``colormatrix``.
-``taskbar-progress`` (RW)
- See ``--taskbar-progress``.
-
-``ontop`` (RW)
- See ``--ontop``.
-
-``border`` (RW)
- See ``--border``.
-
-``on-all-workspaces`` (RW)
- See ``--on-all-workspaces``. Unsetting may not work on all WMs.
-
-``framedrop`` (RW)
- See ``--framedrop``.
-
-``gamma`` (RW)
- See ``--gamma``.
-
-``brightness`` (RW)
- See ``--brightness``.
-
-``contrast`` (RW)
- See ``--contrast``.
-
-``saturation`` (RW)
- See ``--saturation``.
-
-``hue`` (RW)
- See ``--hue``.
-
``hwdec`` (RW)
Reflects the ``--hwdec`` option.
@@ -1431,9 +1345,6 @@ Property list
while no video is being decoded. All this reflects how detecting hw decoders
are detected and used internally in mpv.
-``panscan`` (RW)
- See ``--panscan``.
-
``video-format``
Video format as string.
@@ -1600,6 +1511,9 @@ Property list
``video-aspect`` (RW)
Video aspect, see ``--video-aspect``.
+ If video is active, this reports the effective aspect value, instead of
+ the value of the ``--video-aspect`` option.
+
``osd-width``, ``osd-height``
Last known OSD width (can be 0). This is needed if you want to use the
``overlay-add`` command. It gives you the actual OSD size, which can be
@@ -1608,24 +1522,6 @@ Property list
``osd-par``
Last known OSD display pixel aspect (can be 0).
-``vid`` (RW)
- Current video track (similar to ``--vid``).
-
-``video`` (RW)
- Alias for ``vid``.
-
-``video-align-x``, ``video-align-y`` (RW)
- See ``--video-align-x`` and ``--video-align-y``.
-
-``video-pan-x``, ``video-pan-y`` (RW)
- See ``--video-pan-x`` and ``--video-pan-y``.
-
-``video-zoom`` (RW)
- See ``--video-zoom``.
-
-``video-unscaled`` (W)
- See ``--video-unscaled``.
-
``program`` (W)
Switch TS program (write-only).
@@ -1638,36 +1534,6 @@ Property list
On write, a channel-switch to the named channel on the same
card is performed. Can also be used for channel switching.
-``sid`` (RW)
- Current subtitle track (similar to ``--sid``).
-
-``secondary-sid`` (RW)
- Secondary subtitle track (see ``--secondary-sid``).
-
-``sub`` (RW)
- Alias for ``sid``.
-
-``sub-delay`` (RW)
- See ``--sub-delay``.
-
-``sub-pos`` (RW)
- See ``--sub-pos``.
-
-``sub-visibility`` (RW)
- See ``--sub-visibility``.
-
-``sub-forced-only`` (RW)
- See ``--sub-forced-only``.
-
-``sub-scale`` (RW)
- Subtitle font size multiplier.
-
-``ass-force-margins`` (RW)
- See ``--ass-force-margins``.
-
-``sub-use-margins`` (RW)
- See ``--sub-use-margins``.
-
``sub-text``
Return the current subtitle text. Formatting is stripped. If a subtitle
is selected, but no text is currently visible, or the subtitle is not
@@ -1675,12 +1541,6 @@ Property list
This property is experimental and might be removed in the future.
-``ass-vsfilter-aspect-compat`` (RW)
- See ``--ass-vsfilter-aspect-compat``.
-
-``ass-style-override`` (RW)
- See ``--ass-style-override``.
-
``stream-capture`` (RW)
A filename, see ``--stream-capture``. Setting this will start capture using
the given filename. Setting it to an empty string will stop it.
@@ -1891,11 +1751,8 @@ Property list
"title" MPV_FORMAT_STRING
"time" MPV_FORMAT_DOUBLE
-``af`` (RW)
- See ``--af`` and the ``af`` command.
-
-``vf`` (RW)
- See ``--vf`` and the ``vf`` command.
+``af``, ``vf`` (RW)
+ See ``--vf``/``--af`` and the ``vf``/``af`` command.
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
@@ -1913,12 +1770,6 @@ Property list
It's also possible to write the property using this format.
-``video-rotate`` (RW)
- See ``--video-rotate`` option.
-
-``video-stereo-mode`` (RW)
- See ``--video-stereo-mode`` option.
-
``seekable``
Return whether it's generally possible to seek in the current file.
@@ -2158,6 +2009,10 @@ Property list
require reloading the file for changes to take effect. If there is an
equivalent property, prefer setting the property instead.
+ There shouldn't be any reason to access ``options/<name>`` instead of
+ ``<name>``, except in situations in which the properties have different
+ behavior or conflicting semantics.
+
``file-local-options/<name>``
Similar to ``options/<name>``, but when setting an option through this
property, the option is reset to its old value once the current file has
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
index b4a49a75db..e723d5cbbe 100644
--- a/DOCS/man/options.rst
+++ b/DOCS/man/options.rst
@@ -1091,7 +1091,10 @@ Audio
Since mpv 0.18.1, this always controls the internal mixer (aka "softvol").
``--balance=<value>``
- How much left/right channels contribute to the audio.
+ How much left/right channels contribute to the audio. (The implementation
+ of this feature is rather odd. It doesn't change the volumes of each
+ channel, but instead sets up a pan matrix to mix the left and right
+ channels.)
Deprecated.