diff options
author | rcombs <rcombs@rcombs.me> | 2022-12-16 13:43:30 -0600 |
---|---|---|
committer | rcombs <rcombs@rcombs.me> | 2023-01-28 14:37:24 -0600 |
commit | 3ec2a0988aca7cba4620b6c22929b91a34ea6eb4 (patch) | |
tree | a1c3c70ac18f8301724398231b5cdec6568ab58c /DOCS/man/lua.rst | |
parent | 68a20e7ae44d211bba1de10739734e38117855f5 (diff) | |
download | mpv-3ec2a0988aca7cba4620b6c22929b91a34ea6eb4.tar.bz2 mpv-3ec2a0988aca7cba4620b6c22929b91a34ea6eb4.tar.xz |
docs: document new user-data property
Diffstat (limited to 'DOCS/man/lua.rst')
-rw-r--r-- | DOCS/man/lua.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index ae9c14f55f..8a6a165630 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -824,6 +824,34 @@ strictly part of the guaranteed API. This is a legacy wrapper around calling the ``run`` command with ``mp.commandv`` and other functions. +``utils.udata_set(path, val)`` + Sets a udata value. + + ``path`` is a path within the ``udata`` property. + + This is a convenience wrapper around ``mp.set_property_native``. + +``utils.udata_get(path)`` + Gets a udata value. + + ``path`` is a path within the ``udata`` property. + + This is a convenience wrapper around ``mp.get_property_native``. + +``utils.udata_del(path)`` + Deletes a udata value. + + ``path`` is a path within the ``udata`` property. + + This is a convenience wrapper around ``mp.del_property_native``. + +``utils.udata_observe(path, type, fn)`` + Observes a udata value. + + ``path`` is a path within the ``udata`` property. + + See ``mp.observe_property`` for further details. + ``utils.getpid()`` Returns the process ID of the running mpv process. This can be used to identify the calling mpv when launching (detached) subprocesses. |