mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-31 22:25:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: clarify the port id

Browse source 
It might be confused with port.id to state explicitly that this is
actually the object.id of a port.
This commit is contained in:
Wim Taymans 2025-02-13 21:11:06 +01:00
parent dbed1bdf3d
commit cfddbb033a
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/modules/module-link-factory.c
View file

@ -41,20 +41,20 @@
* *
* ## Properties for the create_object call * ## Properties for the create_object call
* *
* - `link.output.node`: The output node to use. This can be the node id, node.name, * - `link.output.node`: The output node to use. This can be the node object.id, node.name,
* node.nick, node.description or object.path of a node. When the * node.nick, node.description or object.path of a node. When the
* property is not given or NULL, the output port should be * property is not given or NULL, the output port should be
* specified. * specified.
* - `link.output.port`: The output port to link. This can be a port id, port.name, * - `link.output.port`: The output port to link. This can be a port object.id, port.name,
* port.alias or object.path. If an output node is specified, the * port.alias or object.path. If an output node is specified, the
* port must belong to the node. If no output port is given, an * port must belong to the node. If no output port is given, an
* output node must be specified and a random (unlinked) port will * output node must be specified and a random (unlinked) port will
* be used from the node. * be used from the node.
* - `link.input.node`: The input node to use. This can be the node id, node.name, * - `link.input.node`: The input node to use. This can be the node object.id, node.name,
* node.nick, node.description or object.path of a node. When the * node.nick, node.description or object.path of a node. When the
* property is not given or NULL, the input port should be * property is not given or NULL, the input port should be
* specified. * specified.
* - `link.input.port`: The input port to link. This can be a port id, port.name, * - `link.input.port`: The input port to link. This can be a port object.id, port.name,
* port.alias or object.path. If an input node is specified, the * port.alias or object.path. If an input node is specified, the
* port must belong to the node. If no input port is given, an * port must belong to the node. If no input port is given, an
* input node must be specified and a random (unlinked) port will * input node must be specified and a random (unlinked) port will