From 27b4bdfe4c802ef5267b2f40838bdf53ad569032 Mon Sep 17 00:00:00 2001 From: wm4 Date: Sat, 28 Mar 2020 00:41:56 +0100 Subject: manpage: clarify some event/hook details --- DOCS/man/input.rst | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index c19a8fdd65..9bf4701e2f 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -1287,6 +1287,10 @@ This is a partial list of events. This section describes what IPC sees. Note that the C API has separate C-level declarations with ``mpv_event``, which may be slightly different. +Note that events are asynchronous: the player core continues running while +events are delivered to scripts and other clients. In some cases, you can hooks +to enforce synchronous execution. + All events can have the following fields: ``event`` @@ -1423,16 +1427,16 @@ This list uses the event name field value, and the C API symbol in brackets: provides a better API around this with ``mp.add_hook()``. ``get-property-reply`` (``MPV_EVENT_GET_PROPERTY_REPLY``) - Undocumented. + See C API. ``set-property-reply`` (``MPV_EVENT_SET_PROPERTY_REPLY``) - Undocumented. + See C API. ``command-reply`` (``MPV_EVENT_COMMAND_REPLY``) 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. + not pass the actual event to the user. See C API. The event has the following fields: @@ -1489,12 +1493,17 @@ The following hooks are currently defined: ``file-local-options/