diff options
| author | wm4 <wm4@nowhere> | 2014-11-08 09:59:38 +0100 |
|---|---|---|
| committer | wm4 <wm4@nowhere> | 2014-11-08 10:19:07 +0100 |
| commit | f5c2e3d6e2372546c46dd32ceab1a5c41e19465b (patch) | |
| tree | 138c51b8484d04ed913a7a5b57378b04fe9e3929 /DOCS/man | |
| parent | 1a5650b62837308a0106a365a9fd26057defaf67 (diff) | |
| download | mpv-f5c2e3d6e2372546c46dd32ceab1a5c41e19465b.tar.bz2 mpv-f5c2e3d6e2372546c46dd32ceab1a5c41e19465b.tar.xz | |
client API: deprecate some events
Following the discussion in #1253.
The events won't be removed for a while, though. (Or maybe never, unless
we run out of bits for the uint64_t event mask.)
This is not a real change (the events still work, and the alternative
mechanisms were established a few API revisions earlier), but for the
sake of notifying API users, update DOCS/client-api-changes.rst.
Diffstat (limited to 'DOCS/man')
| -rw-r--r-- | DOCS/man/lua.rst | 25 |
1 files changed, 3 insertions, 22 deletions
diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index f35af85079..fbba495a4f 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -648,28 +648,11 @@ List of events ``playback-restart`` Start of playback after seek or after file was loaded. -``tracks-changed`` - The list of video/audio/sub tracks was updated. (This happens on playback - start, and very rarely during playback.) - -``track-switched`` - A video/audio/subtitle track was switched on or off. This usually happens - when the user (or a script) changes the subtitle track and so on. - ``idle`` Idle mode is entered. This happens when playback ended, and the player was started with ``--idle`` or ``--force-window``. This mode is implicitly ended when the ``start-file`` or ``shutdown`` events happen. -``pause`` - 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" property), and you - might receive multiple ``pause`` events in a row. - -``unpause`` - Playback was unpaused. See above for details. - ``tick`` Called after a video frame was displayed. This is a hack, and you should avoid using it. Use timers instead and maybe watch pausing/unpausing events @@ -729,11 +712,9 @@ List of events ``audio-reconfig`` Happens on audio output or filter reconfig. -``metadata-update`` - Metadata (like file tags) was updated. - -``chapter-change`` - The current chapter possibly changed. +The following events also happen, but are deprecated: ``tracks-changed``, +``track-switched``, ``pause``, ``unpause``, ``metadata-update``, +``chapter-change``. Use ``mp.observe_property()`` instead. Extras ------ |