summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2020-03-21 22:09:07 +0100
committerwm4 <wm4@nowhere>2020-03-21 22:09:07 +0100
commitd375cc304aec11f09ed685ffd2f2e7af0abf8910 (patch)
tree26da9432e6411576f040b83934d62cba70cbe847 /DOCS
parent0fbe7f9e54fc2fe2d5b1e466906c6ffcab448e5a (diff)
downloadmpv-d375cc304aec11f09ed685ffd2f2e7af0abf8910.tar.bz2
mpv-d375cc304aec11f09ed685ffd2f2e7af0abf8910.tar.xz
client API, lua: unify event code further
Move some parts that can be generic to the client API code. It turns out lua.c doesn't need anything special. This adds the "id" field. I think this was actually missing from the JSON IPC code (i.e. it's a very recent regression that is fixed with this commit).
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/input.rst22
1 files changed, 20 insertions, 2 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index a4567be3aa..7a4c5dcdc2 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1288,6 +1288,10 @@ All events can have the following fields:
``event``
Name as the event (as returned by ``mpv_event_name()``).
+``id``
+ The ``reply_userdata`` field (opaque user value). If ``reply_userdata`` is 0,
+ the field is not added.
+
``error``
Set to an error string (as returned by ``mpv_error_string()``). This field
is missing if no error happened, or the event type does not report error.
@@ -1403,10 +1407,24 @@ This list uses the event name field value, and the C API symbol in brackets:
Undocumented.
``command-reply`` (``MPV_EVENT_COMMAND_REPLY``)
- Undocumented.
+ This is one of the commands for which the ```error`` field is meaningful.
+
+ JSON IPC and Lua and possibly other backends treat this specially and may
+ not pass the actual event to the user.
+
+ The event has the following fields:
+
+ ``result``
+ The result (on success) of any ``mpv_node`` type, if any.
``client-message`` (``MPV_EVENT_CLIENT_MESSAGE``)
- Undocumented.
+ Lua and possibly other backends treat this specially and may not pass the
+ actual event to the user.
+
+ The event has the following fields:
+
+ ``args``
+ Array of strings with the message data.
``video-reconfig`` (``MPV_EVENT_VIDEO_RECONFIG``)
Happens on video output or filter reconfig.