RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2025-02-17 21:27:08 +00:00
Code Issues Releases Wiki Activity

DOCS/man/input: reserve user-data/osc and user-data/mpv sub-paths

Browse Source 
Currently user-data/osc is used for interpolation between the osc and
other internal scripts. Reserve this sub-path and also user-data/mpv
to make sure external scripts can only use these values as directed.
New internal uses of user-data should use user-data/mpv instead.
This commit is contained in:
nanahi 2024-08-02 01:26:49 -04:00 committed by Kacper Michajłow
parent ee05804bfa
commit d302fe0de5
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
DOCS/interface-changes/user-data-subpath.txt Normal file
View File

@ -0,0 +1 @@
reserve `user-data/osc` and `user-data/mpv` sub-paths for internal use

6
DOCS/man/input.rst
View File

@ -3549,6 +3549,12 @@ Property list
The player itself does not use any data in it (although some builtin scripts may).
The property is not preserved across player restarts.
The following sub-paths are reserved for internal uses or have special semantics:
``user-data/osc``, ``user-data/mpv``. Unless noted otherwise, the semantics of
any properties under these sub-paths can change at any time and may not be relied
upon, and writing to these properties may prevent builtin scripts from working
properly.
Sub-paths can be accessed directly; e.g. ``user-data/my-script/state/a`` can be
read, written, or observed.