summaryrefslogtreecommitdiffstats
path: root/DOCS/man/input.rst
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2016-09-01 20:57:33 +0200
committerwm4 <wm4@nowhere>2016-09-01 20:57:33 +0200
commit1393d79417278dfa63a7a5c767093eaf3504edce (patch)
tree3a33c48248a5a32daecbe8f2a8f98c7c7c010fca /DOCS/man/input.rst
parent192a7344d91de24d486effba73383b1c2790acc2 (diff)
downloadmpv-1393d79417278dfa63a7a5c767093eaf3504edce.tar.bz2
mpv-1393d79417278dfa63a7a5c767093eaf3504edce.tar.xz
command: fix or document some property/option consistency issues
Make some existing properties behave more like options. This mostly means they don't deny access if the associated component is not active, but redirects to the option. One kind of fishy change is that we apply --brightness etc. only if they're not set to the default value. This won't necessarily work with --vo=xv, but affects only cases where 1. the Xv adapter has been changed to non-defaults, and 2. the user tries to reset them with mpv by passing e.g. --brightness=0. We don't care about Xv, and the noted use-case is dumb, so this change is acceptable.
Diffstat (limited to 'DOCS/man/input.rst')
-rw-r--r--DOCS/man/input.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index baeb1703d9..56fa6b355e 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -2062,6 +2062,42 @@ Property list
is not a map, as order matters and duplicate entries are possible. Recursive
profiles are not expanded, and show up as special ``profile`` options.
+Inconsistencies between options and properties
+----------------------------------------------
+
+You can access (almost) all options as properties, though there are some
+caveats with some properties (due to historical reasons):
+
+``vid``, ``aid``, ``sid``
+ While playback is active, you can set existing tracks only. (The option
+ allows setting any track ID, and which tracks to enable is chosen at
+ loading time.)
+
+``deinterlace``
+ While video is active, this behaves differently from the option. It will
+ never return the ``auto`` value (but the state as observed by the video
+ chain). You cannot set ``auto`` either.
+
+``video-aspect``
+ While video is active, always returns the effective aspect ratio.
+
+``brightness`` (and other color options)
+ If ``--vo=xv`` is used, these properties may return the adapter's current
+ values instead of the option values.
+
+``display-fps``
+ If a VO is created, this will return either the actual display FPS, or
+ an invalid value, instead of the option value.
+
+``cache``
+ This behaves completely different as property: instead of configuring the
+ cache size like the option, it returns the cache state in percent.
+
+``demuxer``, ``idle``, ``length``, ``audio-samplerate``, ``audio-channels``, ``audio-format``, ``fps``
+ These behave completely different as property, but are deprecated (newer
+ aliases which don't conflict have been added). After the deprecation period
+ they will be changed to the proper option behavior.
+
Property Expansion
------------------