RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity

manpage: lua: mention recent deprecations 

These are listed in interface-changes.rst, but the documentation in the
manpage wasn't updated.
This commit is contained in:
wm4 2016-09-21 12:45:27 +02:00
parent f66f0b34c8
commit 33598182a0
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
DOCS/man/lua.rst
View File

@ -412,6 +412,8 @@ These also live in the ``mp`` module, but are documented separately as they
are useful only in special situations. are useful only in special situations.
``mp.suspend()`` ``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 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 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 from displaying the next video frame, so that you don't get blocked when
@ -420,11 +422,15 @@ are useful only in special situations.
Before mpv 0.17.0, this was automatically called by the event handler. Before mpv 0.17.0, this was automatically called by the event handler.
``mp.resume()`` ``mp.resume()``
This function has been deprecated in mpv 0.21.0 (no replacement).
Undo one ``mp.suspend()`` call. ``mp.suspend()`` increments an internal Undo one ``mp.suspend()`` call. ``mp.suspend()`` increments an internal
counter, and ``mp.resume()`` decrements it. When 0 is reached, the player counter, and ``mp.resume()`` decrements it. When 0 is reached, the player
is actually resumed. is actually resumed.
``mp.resume_all()`` ``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 This resets the internal suspend counter and resumes the player. (It's
like calling ``mp.resume()`` until the player is actually resumed.) like calling ``mp.resume()`` until the player is actually resumed.)
@ -633,8 +639,6 @@ strictly part of the guaranteed API.
Set to ``true`` if the process has been killed by mpv as a result Set to ``true`` if the process has been killed by mpv as a result
of ``cancellable`` being set to ``true``. of ``cancellable`` being set to ``true``.
In all cases, ``mp.resume_all()`` is implicitly called.
``utils.subprocess_detached(t)`` ``utils.subprocess_detached(t)``
Runs an external process and detaches it from mpv's control. Runs an external process and detaches it from mpv's control.
@ -646,8 +650,6 @@ strictly part of the guaranteed API.
The function returns ``nil``. The function returns ``nil``.
In all cases, ``mp.resume_all()`` is implicitly called.
``utils.parse_json(str [, trail])`` ``utils.parse_json(str [, trail])``
Parses the given string argument as JSON, and returns it as a Lua table. On Parses the given string argument as JSON, and returns it as a Lua table. On
error, returns ``nil, error``. (Currently, ``error`` is just a string error, returns ``nil, error``. (Currently, ``error`` is just a string