summaryrefslogtreecommitdiffstats
path: root/DOCS/man/en
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-02-24 22:49:07 +0100
committerwm4 <wm4@nowhere>2014-02-24 22:50:25 +0100
commit0adb8a9aaf1e1c76300d717a0a3dd04849e70d1d (patch)
tree3dd2387c4eacd986a25a6025fac2e99aad621396 /DOCS/man/en
parent5d7007c6448660b2bdbc7758db7f486157ff1fa2 (diff)
downloadmpv-0adb8a9aaf1e1c76300d717a0a3dd04849e70d1d.tar.bz2
mpv-0adb8a9aaf1e1c76300d717a0a3dd04849e70d1d.tar.xz
client API: report pause/unpause reason
Not sure about this... might redo. At least this provides a case of a broadcasted event, which requires per-event data allocation. See github issue #576.
Diffstat (limited to 'DOCS/man/en')
-rw-r--r--DOCS/man/en/lua.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/DOCS/man/en/lua.rst b/DOCS/man/en/lua.rst
index b84984e6ce..338ffec6af 100644
--- a/DOCS/man/en/lua.rst
+++ b/DOCS/man/en/lua.rst
@@ -365,6 +365,25 @@ List of events
``pause``
Playback was paused.
+ Has the following event fields:
+
+ ``real_paused``
+ Current playback pause state as boolean.
+
+ ``user_paused``
+ User requested pause state.
+
+ ``by_command``
+ If the action was triggered by an input command (or via an user key
+ binding). It's false if it was an automatic action.
+
+ ``by_cache``
+ If the action was triggered by a low (or recovering) cache state.
+
+ ``by_keep_open``
+ If the pausing was triggered because the end of playback was reached,
+ and the "keep-open" option is enabled, 0 otherwise.
+
``unpause``
Playback was unpaused.