summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authortorque <torque@1>2015-06-10 16:56:56 -0700
committerwm4 <wm4@nowhere>2015-06-11 21:42:09 +0200
commitd0fe5e08b984db840545c1b341a1e56fad304593 (patch)
tree67b8ad9092b82bcd7dff3d77c0b30c144c93944d /DOCS
parentb655ed5ed0c6d58a7e8937c28a7b2a0ccdf9c97e (diff)
downloadmpv-d0fe5e08b984db840545c1b341a1e56fad304593.tar.bz2
mpv-d0fe5e08b984db840545c1b341a1e56fad304593.tar.xz
command: add keypress, keydown, and keyup commands.
These commands are used to simulate keypresses using the key names from input.conf.
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/interface-changes.rst1
-rw-r--r--DOCS/man/input.rst17
2 files changed, 18 insertions, 0 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index b6a77b6bd5..b7e693edd7 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -20,6 +20,7 @@ Interface changes
::
--- mpv 0.10.0 will be released ---
+ - add "keypress", "keydown", and "keyup" commands
- deprecate --ad-spdif-dtshd and enabling passthrough via --ad
add --audio-spdif as replacement
- remove "get_property" command
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index fb80007eb9..397e425c1e 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -395,6 +395,23 @@ List of Input Commands
<double>
The mouse event represents double-click.
+``keypress <key_name>``
+ Send a key event through mpv's input handler, triggering whatever
+ behavior is configured to that key. ``key_name`` uses the ``input.conf``
+ naming scheme for keys and modifiers. Useful for the client API: key events
+ can be sent to libmpv to handle internally.
+
+``keydown <key_name>``
+ Similar to ``keypress``, but sets the ``KEYDOWN`` flag so that if the key is
+ bound to a repeatable command, it will be run repeatedly with mpv's key
+ repeat timing until the ``keyup`` command is called.
+
+``keyup [<key_name>]``
+ Set the ``KEYUP`` flag, stopping any repeated behavior that had been
+ triggered. ``key_name`` is optional. If ``key_name`` is not given or is an
+ empty string, ``KEYUP`` will be set on all keys. Otherwise, ``KEYUP`` will
+ only be set on the key specified by ``key_name``.
+
``audio-add "<file>" [<flags> [<title> [<lang>]]]``
Load the given audio file. See ``sub-add`` command.