summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2020-03-22 19:42:59 +0100
committerwm4 <wm4@nowhere>2020-03-22 19:42:59 +0100
commit37f441d61b1e2f92a31fe8f71dc965254d8e0d95 (patch)
tree6bccb926eb4c64dba4f4120010b9c932cbe06944 /DOCS
parent3fedf61532337e808587a2cd22cbbebad278be5f (diff)
downloadmpv-37f441d61b1e2f92a31fe8f71dc965254d8e0d95.tar.bz2
mpv-37f441d61b1e2f92a31fe8f71dc965254d8e0d95.tar.xz
lua: restore recent end-file event, and deprecate it
Lua changed behavior for this specific event. I considered the change minor enough that it would not need to go through deprecation, but someone hit it immediately and ask on the -dev channel. It's probably better to restore the behavior. But mark it as deprecated, since it's problematic (mismatch with the C API). Unfortunately, no automatic warning is possible. (Or maybe it is, by playing sophisticated Lua tricks such as setting a metatable and overriding indexing, but let's not.)
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/interface-changes.rst6
-rw-r--r--DOCS/man/input.rst5
2 files changed, 7 insertions, 4 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index 2290c6c6b1..5b1ab8602f 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -54,8 +54,10 @@ Interface changes
Using the "playlist-play-index" command is recommended instead.
- add "playlist-play-index" command
- add playlist-current-pos, playlist-playing-pos properties
- - Lua end-file events do not set the "error" field anymore, use "file_error"
- instead.
+ - Lua end-file events set the "error" field; this is deprecated; use the
+ "file_error" instead for this specific event. Scripts relying on the
+ "error" field for end-file will silently break at some point in the
+ future.
- deprecate encoding mode (lack of maintainer)
--- mpv 0.32.0 ---
- change behavior when using legacy option syntax with options that start
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 7a4c5dcdc2..bcc7c0100d 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1350,8 +1350,9 @@ This list uses the event name field value, and the C API symbol in brackets:
``file_error``
Set to mpv error string describing the approximate reason why playback
failed. Unset if no error known. (In Lua scripting, this value was set
- on the ``error`` field directly before mpv 0.33.0. Now the ``error``
- field always indicates success, i.e. is not set.)
+ on the ``error`` field directly. This is deprecated since mpv 0.33.0.
+ In the future, this ``error`` field will be unset for this specific
+ event.)
``file-loaded`` (``MPV_EVENT_FILE_LOADED``)
Happens after a file was loaded and begins playback.