History

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

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.

nanahi committed 2 years ago

Commit d302fe01 parent ee058042 files · +7 −0Browse files

Unified · Split

2 files
  1. DOCS/interface-changes/user-data-subpath.txt +1 −0
  2. DOCS/man/input.rst +6 −0
DOCS/interface-changes/user-data-subpath.txt+1−0
@@ -0,0 +1 @@
1reserve `user-data/osc` and `user-data/mpv` sub-paths for internal use
DOCS/man/input.rst+6−0
@@ -3549,6 +3549,12 @@ Property list · 3548 unmodified lines
3549 The player itself does not use any data in it (although some builtin scripts may).3549 The player itself does not use any data in it (although some builtin scripts may).
3550 The property is not preserved across player restarts.3550 The property is not preserved across player restarts.
3551 3551
3552 The following sub-paths are reserved for internal uses or have special semantics:
3553 ``user-data/osc``, ``user-data/mpv``. Unless noted otherwise, the semantics of
3554 any properties under these sub-paths can change at any time and may not be relied
3555 upon, and writing to these properties may prevent builtin scripts from working
3556 properly.
3557
3552 Sub-paths can be accessed directly; e.g. ``user-data/my-script/state/a`` can be3558 Sub-paths can be accessed directly; e.g. ``user-data/my-script/state/a`` can be
3553 read, written, or observed.3559 read, written, or observed.
3554 3560

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t