summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-04-14 22:33:41 +0200
committerwm4 <wm4@nowhere>2014-04-14 22:33:41 +0200
commit196619671d8bde5112f82b5ec5db881ff8e99f43 (patch)
treec99a86dc469a0ffb7e3026cb7251142e5710cb4d /DOCS
parent60b900487257a3435df02c2b2ce54551c59e4311 (diff)
downloadmpv-196619671d8bde5112f82b5ec5db881ff8e99f43.tar.bz2
mpv-196619671d8bde5112f82b5ec5db881ff8e99f43.tar.xz
client API: remove mpv_event_pause_reason
And slightly adjust the semantics of MPV_EVENT_PAUSE/MPV_EVENT_UNPAUSE. The real pause state can now be queried with the "core-idle" property, the user pause state with the "pause" property, whether the player is paused due to cache with "paused-for-cache", and the keep open event can be guessed with the "eof-reached" property.
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/en/lua.rst26
1 files changed, 5 insertions, 21 deletions
diff --git a/DOCS/man/en/lua.rst b/DOCS/man/en/lua.rst
index f29df4a6d9..2cea513327 100644
--- a/DOCS/man/en/lua.rst
+++ b/DOCS/man/en/lua.rst
@@ -464,29 +464,13 @@ List of events
when the ``start-file`` or ``shutdown`` events happen.
``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.
+ Playback was paused. This also happens when for example the player is
+ paused on low network cache. Then the event type indicates the pause state
+ (like the property "pause" as opposed to the "core-idle" propetty), and you
+ might be multiple ``pause`` events in a row.
``unpause``
- Playback was unpaused.
+ Playback was unpaused. See above for details.
``tick``
Called after a video frame was displayed. This is a hack, and you should