summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2016-11-22 14:47:50 +0100
committerwm4 <wm4@nowhere>2016-11-22 15:54:44 +0100
commitf30c5d09f4478ca40ceabc90d57fea68965778df (patch)
tree13ee64c5b6554cb2c46d0998185f51f4a7c30a25 /DOCS
parent745862131f2e03bfb7b8fae4499d84522f0cc1a2 (diff)
downloadmpv-f30c5d09f4478ca40ceabc90d57fea68965778df.tar.bz2
mpv-f30c5d09f4478ca40ceabc90d57fea68965778df.tar.xz
client API: turn mpv_suspend() and mpv_resume() into stubs
As threatened by the API changes document. This commit also removes or stubs equivalent calls in IPC and Lua scripting. The stubs are left to maintain ABI compatibility. The semantics of the API functions have been close enough to doing nothing that this probably won't even break existing API users. Probably.
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/client-api-changes.rst2
-rw-r--r--DOCS/man/ipc.rst14
-rw-r--r--DOCS/man/lua.rst28
3 files changed, 10 insertions, 34 deletions
diff --git a/DOCS/client-api-changes.rst b/DOCS/client-api-changes.rst
index 1dacbb2c32..5e6e1d3180 100644
--- a/DOCS/client-api-changes.rst
+++ b/DOCS/client-api-changes.rst
@@ -32,6 +32,8 @@ API changes
::
+ --- mpv 0.23.0 ---
+ 1.24 - the deprecated mpv_suspend() and mpv_resume() APIs now do nothing.
--- mpv 0.22.0 ---
1.23 - deprecate setting "no-" options via mpv_set_option*(). For example,
instead of "no-video=" you should set "video=no".
diff --git a/DOCS/man/ipc.rst b/DOCS/man/ipc.rst
index 732056ee01..03be027a20 100644
--- a/DOCS/man/ipc.rst
+++ b/DOCS/man/ipc.rst
@@ -241,20 +241,6 @@ extra commands can also be used as part of the protocol:
By default, most events are enabled, and there is not much use for this
command.
-``suspend``
- Deprecated, will be removed completely in 0.21.0.
-
- Suspend the mpv main loop. There is a long-winded explanation of this in
- the C API function ``mpv_suspend()``. In short, this prevents the player
- from displaying the next video frame, so that you don't get blocked when
- trying to access the player.
-
-``resume``
- Deprecated, will be removed completely in 0.21.0.
-
- Undo one ``suspend`` call. ``suspend`` increments an internal counter, and
- ``resume`` decrements it. When 0 is reached, the player is actually resumed.
-
``get_version``
Returns the client API version the C API of the remote mpv instance
provides.
diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst
index f1d9945055..7d91090ca8 100644
--- a/DOCS/man/lua.rst
+++ b/DOCS/man/lua.rst
@@ -43,9 +43,8 @@ timers added with ``mp.add_timeout`` or similar.
When the player quits, all scripts will be asked to terminate. This happens via
a ``shutdown`` event, which by default will make the event loop return. If your
-script got into an endless loop, mpv will probably behave fine during playback
-(unless the player is suspended, see ``mp.suspend``), but it won't terminate
-when quitting, because it's waiting on your script.
+script got into an endless loop, mpv will probably behave fine during playback,
+but it won't terminate when quitting, because it's waiting on your script.
Internally, the C code will call the Lua function ``mp_event_loop`` after
loading a Lua script. This function is normally defined by the default prelude
@@ -412,27 +411,16 @@ These also live in the ``mp`` module, but are documented separately as they
are useful only in special situations.
``mp.suspend()``
- This function has been deprecated in mpv 0.21.0 (no replacement).
-
- Suspend the mpv main loop. There is a long-winded explanation of this in
- the C API function ``mpv_suspend()``. In short, this prevents the player
- from displaying the next video frame, so that you don't get blocked when
- trying to access the player.
-
- Before mpv 0.17.0, this was automatically called by the event handler.
+ This function has been deprecated in mpv 0.21.0 and does nothing starting
+ with mpv 0.23.0 (no replacement).
``mp.resume()``
- This function has been deprecated in mpv 0.21.0 (no replacement).
-
- Undo one ``mp.suspend()`` call. ``mp.suspend()`` increments an internal
- counter, and ``mp.resume()`` decrements it. When 0 is reached, the player
- is actually resumed.
+ This function has been deprecated in mpv 0.21.0 and does nothing starting
+ with mpv 0.23.0 (no replacement).
``mp.resume_all()``
- This function has been deprecated in mpv 0.21.0 (no replacement).
-
- This resets the internal suspend counter and resumes the player. (It's
- like calling ``mp.resume()`` until the player is actually resumed.)
+ This function has been deprecated in mpv 0.21.0 and does nothing starting
+ with mpv 0.23.0 (no replacement).
``mp.get_wakeup_pipe()``
Calls ``mpv_get_wakeup_pipe()`` and returns the read end of the wakeup