docs: complete lua Node api docs and fix some ref links
This commit is contained in:
@@ -13,7 +13,7 @@ Constructors
|
||||
Combines :c:func:`wp_object_manager_new` and
|
||||
:c:func:`wp_object_manager_add_interest_full`
|
||||
|
||||
:param table interest_list: a list of `interests <lua_object_interest_api>`_
|
||||
:param table interest_list: a list of :ref:`interests <lua_object_interest_api>`
|
||||
to objects
|
||||
:returns: a new object manager
|
||||
:rtype: ObjectManager
|
||||
@@ -41,15 +41,17 @@ Methods
|
||||
Binds :c:func:`wp_object_manager_new_filtered_iterator_full`
|
||||
|
||||
:param self: the object manager
|
||||
:param ObjectInterest interest: an interest to filter objects, or nil
|
||||
:param interest: an interest to filter objects
|
||||
:type interest: :ref:`Interest <lua_object_interest_api>` or nil or none
|
||||
:returns: all the managed objects that match the interest
|
||||
:rtype: Iterator; the iteration items are of type `GObject <lua_gobject>`_
|
||||
:rtype: Iterator; the iteration items are of type :ref:`GObject <lua_gobject>`
|
||||
|
||||
.. function:: ObjectManager.lookup(self, interest)
|
||||
|
||||
Binds :c:func:`wp_object_manager_lookup`
|
||||
|
||||
:param self: the object manager
|
||||
:param ObjectInterest interest: the interest to use for the lookup, or nil
|
||||
:param interest: the interest to use for the lookup
|
||||
:type interest: :ref:`Interest <lua_object_interest_api>` or nil or none
|
||||
:returns: the first managed object that matches the interest
|
||||
:rtype: `GObject <lua_gobject>`_
|
||||
:rtype: :ref:`GObject <lua_gobject>`
|
||||
|
@@ -30,7 +30,7 @@ contain the following methods:
|
||||
:param string param_name: the PipeWire param name to enumerate,
|
||||
ex "Props", "Route"
|
||||
:returns: the available parameters
|
||||
:rtype: Iterator; the iteration items are `Spa Pod <lua_spa_pod>`_ objects
|
||||
:rtype: Iterator; the iteration items are :ref:`Spa Pod <lua_spa_pod>` objects
|
||||
|
||||
.. function:: PipewireObject.set_param(self, param_name, pod)
|
||||
|
||||
@@ -57,6 +57,57 @@ PipeWire Node
|
||||
|
||||
Lua objects that bind a :ref:`WpNode <node_api>` contain the following methods:
|
||||
|
||||
.. function:: Node.get_state(self)
|
||||
|
||||
Binds :c:func:`wp_node_get_state`
|
||||
|
||||
:param self: the proxy
|
||||
:returns: the current state of the node and an error message, if any
|
||||
:rtype: string (:c:enum:`WpNodeState`), string (error message)
|
||||
|
||||
.. function:: Node.get_n_input_ports(self)
|
||||
|
||||
Binds :c:func:`wp_node_get_n_input_ports`
|
||||
|
||||
:param self: the proxy
|
||||
:returns: the current and max numbers of input ports on the node
|
||||
:rtype: integer (current), integer (max)
|
||||
|
||||
.. function:: Node.get_n_output_ports(self)
|
||||
|
||||
Binds :c:func:`wp_node_get_n_output_ports`
|
||||
|
||||
:param self: the proxy
|
||||
:returns: the current and max numbers of output ports on the node
|
||||
:rtype: integer (current), integer (max)
|
||||
|
||||
.. function:: Node.get_n_ports(self)
|
||||
|
||||
Binds :c:func:`wp_node_get_n_ports`
|
||||
|
||||
:param self: the proxy
|
||||
:returns: the number of ports on the node
|
||||
|
||||
.. function:: Node.iterate_ports(self, interest)
|
||||
|
||||
Binds :c:func:`wp_node_iterate_ports`
|
||||
|
||||
:param self: the proxy
|
||||
:param interest: an interest to filter objects
|
||||
:type interest: :ref:`Interest <lua_object_interest_api>` or nil or none
|
||||
:returns: all the ports of this node that that match the interest
|
||||
:rtype: Iterator; the iteration items are of type :ref:`WpPort <port_api>`
|
||||
|
||||
.. function:: Node.lookup_port(self, interest)
|
||||
|
||||
Binds :c:func:`wp_node_lookup_port`
|
||||
|
||||
:param self: the proxy
|
||||
:param interest: the interest to use for the lookup
|
||||
:type interest: :ref:`Interest <lua_object_interest_api>` or nil or none
|
||||
:returns: the first port of this node that matches the interest
|
||||
:rtype: :ref:`WpPort <port_api>`
|
||||
|
||||
.. function:: Node.send_command(self, command)
|
||||
|
||||
Binds :c:func:`wp_node_send_command`
|
||||
@@ -64,7 +115,6 @@ Lua objects that bind a :ref:`WpNode <node_api>` contain the following methods:
|
||||
:param self: the proxy
|
||||
:param string command: the command to send to the node (ex "Suspend")
|
||||
|
||||
|
||||
PipeWire Client
|
||||
...............
|
||||
|
||||
|
Reference in New Issue
Block a user