diff options
Diffstat (limited to 'DOCS/man/input.rst')
| -rw-r--r-- | DOCS/man/input.rst | 52 |
1 files changed, 36 insertions, 16 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index c3e69b3731..ed523b2135 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -418,7 +418,7 @@ List of Input Commands <reselect> (default) Select the default audio and subtitle streams, which typically selects - external files with highest preference. (The implementation is not + external files with the highest preference. (The implementation is not perfect, and could be improved on request.) <keep-selection> @@ -546,6 +546,12 @@ Input Commands that are Possibly Subject to Change Always bind a key. (The input section that was made active most recently wins if there are ambiguities.) + This command can be used to dispatch arbitrary keys to a script or a client + API user. If the input section defines ``script-binding`` commands, it is + also possible to get separate events on key up/down, and relatively detailed + information about the key state. The special key name ``unmapped`` can be + used to match any unmapped key. + ``overlay-add <id> <x> <y> "<file>" <offset> "<fmt>" <w> <h> <stride>`` Add an OSD overlay sourced from raw data. This might be useful for scripts and applications controlling mpv, and which want to display things on top @@ -647,14 +653,20 @@ Input Commands that are Possibly Subject to Change For completeness, here is how this command works internally. The details could change any time. On any matching key event, ``script_message_to`` or ``script_message`` is called (depending on whether the script name is - included), where the first argument is the string ``key-binding``, the - second argument is the name of the binding, and the third argument is the - key state as string. The key state consists of a number of letters. The - first letter is one of ``d`` (key was pressed down), ``u`` (was released), - ``r`` (key is still down, and was repeated; only if key repeat is enabled - for this binding), ``p`` (key was pressed; happens if up/down can't be - tracked). The second letter whether the event originates from the mouse, - either ``m`` (mouse button) or ``-`` (something else). + included), with the following arguments: + + 1. The string ``key-binding``. + 2. The name of the binding (as established above). + 3. The key state as string (see below). + 4. The key name (since mpv 0.15.0). + + The key state consists of 2 letters: + + 1. One of ``d`` (key was pressed down), ``u`` (was released), ``r`` (key + is still down, and was repeated; only if key repeat is enabled for this + binding), ``p`` (key was pressed; happens if up/down can't be tracked). + 2. Whether the event originates from the mouse, either ``m`` (mouse button) + or ``-`` (something else). ``ab-loop`` Cycle through A-B loop states. The first command will set the ``A`` point @@ -782,7 +794,7 @@ Input sections group a set of bindings, and enable or disable them at once. In ``input.conf``, each key binding is assigned to an input section, rather than actually having explicit text sections. -Also see ``enable_section`` and ``disable_section`` commands. +See also: ``enable_section`` and ``disable_section`` commands. Predefined bindings: @@ -961,9 +973,8 @@ Property list ``playback-time`` (RW) Position in current file in seconds. Unlike ``time-pos``, the time is clamped to the range of the file. (Inaccurate file durations etc. could - make it go out of range. Also helpful when the user attempts to seek - outside of the file, as the seek target time is considered the current - position during seeking.) + make it go out of range. Useful on attempts to seek outside of the file, + as the seek target time is considered the current position during seeking.) ``chapter`` (RW) Current chapter number. The number of the first chapter is 0. @@ -1109,13 +1120,13 @@ Property list ``vf-metadata/<filter-label>`` Metadata added by video filters. Accessed by the filter label, - which if not explicitly specified using the ``@filter-label:`` syntax, + which, if not explicitly specified using the ``@filter-label:`` syntax, will be ``<filter-name>NN``. Works similar to ``metadata`` property. It allows the same access methods (using sub-properties). - An example of these kind of metadata are the cropping parameters + An example of this kind of metadata are the cropping parameters added by ``--vf=lavfi=cropdetect``. ``af-metadata/<filter-label>`` @@ -1142,7 +1153,7 @@ Property list ``cache-size`` (RW) Network cache size in KB. This is similar to ``--cache``. This allows - to set the cache size at runtime. Currently, it's not possible to enable + setting the cache size at runtime. Currently, it's not possible to enable or disable the cache at runtime using this property, just to resize an existing cache. @@ -1531,6 +1542,15 @@ Property list ``program`` (W) Switch TS program (write-only). +``dvb-channel`` (W) + Pair of integers: card,channel of current DVB stream. + Can be switched to switch to another channel on the same card. + +``dvb-channel-name`` (RW) + Name of current DVB program. + 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``). |