colin/wireplumber
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: lua: document missing Core functions

Browse Source
This commit is contained in:
George Kiagiadakis
2023-12-14 12:30:13 +02:00
parent c4a0f5317e
commit f63174ad5f
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/rst/lua_api/lua_core_api.rst
View File

@@ -8,6 +8,17 @@ object is not exposed to the scripts.
For some functionality, though, the following static functions are exposed. For some functionality, though, the following static functions are exposed.
.. function:: Core.get_properties()
Binds :c:func:`wp_core_get_properties`
Returns a table with the properties of the core. These are the same
properties that appear on WirePlumber's *client* object in the PipeWire
global registry.
:returns: the properties of the core
:rtype: table
.. function:: Core.get_info() .. function:: Core.get_info()
Returns a table with information about the core. The table contains Returns a table with information about the core. The table contains
@@ -120,3 +131,14 @@ For some functionality, though, the following static functions are exposed.
the api plugins to load, if they are not already loaded the api plugins to load, if they are not already loaded
:param callback: the function to call after the plugins have been loaded; :param callback: the function to call after the plugins have been loaded;
this function takes references to the plugins as parameters this function takes references to the plugins as parameters
.. function:: Core.test_feature()
Binds :c:func:`wp_core_test_feature`
Tests if the specified feature is provided in the current WirePlumber
configuration.
:param string feature: the name of the feature to test
:returns: true if the feature is provided, false otherwise
:rtype: boolean