RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2024-12-22 06:42:03 +00:00
Code Issues Releases Wiki Activity

lua: allow giving fallback values in get_property() calls

Browse Source 
E.g. ``mp.get_property("foo", "value")`` will return ``value`` if the
property can't be read.
This commit is contained in:
wm4 2014-02-17 00:19:30 +01:00
parent 1fa8e2b602
commit 5fd661b50e
2 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
DOCS/man/en/lua.rst
View File

@ -63,22 +63,24 @@ The ``mp`` module is preloaded, although it can be loaded manually with
These two commands are equivalent, except that the first version breaks
if the filename contains spaces or certain special characters.
``mp.get_property(name)``
``mp.get_property(name [,def])``
Return the value of the given property as string. These are the same
properties as used in input.conf. See `Properties`_ for a list of
properties. The returned string is formatted similar to ``${=name}``
(see `Property Expansion`_).
Returns the string on success, or ``nil, error`` on error.
Returns the string on success, or ``def, error`` on error. ``def`` is the
second parameter provided to the function, and is nil if it's missing.
``mp.get_property_osd(name)``
``mp.get_property_osd(name [,def])``
Similar to ``mp.get_property``, but return the property value formatted for
OSD. This is the same string as printed with ``${name}`` when used in
input.conf.
Returns the string on success, or ``"", error`` on error.
Unlike ``get_property()``, assigning the return value to a variable will
always result in a string.
Returns the string on success, or ``def, error`` on error. ``def`` is the
second parameter provided to the function, and is an empty string if it's
missing. Unlike ``get_property()``, assigning the return value to a variable
will always result in a string.
``mp.set_property(name, value)``
Set the given property to the given value. See ``mp.get_property`` and

7
player/lua.c
View File

@ -505,6 +505,8 @@ static int script_get_property(lua_State *L)
const char *name = luaL_checkstring(L, 1);
int type = lua_tointeger(L, lua_upvalueindex(1))
? MPV_FORMAT_OSD_STRING : MPV_FORMAT_STRING;
char *def_fallback = type == MPV_FORMAT_OSD_STRING ? "" : NULL;
char *def = (char *)luaL_optstring(L, 2, def_fallback);
char *result = NULL;
int err = mpv_get_property(ctx->client, name, type, &result);
@ -513,9 +515,10 @@ static int script_get_property(lua_State *L)
talloc_free(result);
return 1;
}
if (type == MPV_FORMAT_OSD_STRING) {
lua_pushstring(L, "");
if (def) {
lua_pushstring(L, def);
lua_pushstring(L, mpv_error_string(err));
return 2;
}
return check_error(L, err);
}