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: add sections to index, clarify discussion of properties

Browse source 
Add some sections to index + fix typos and section levels.

Clarify discussion of device properties.
This commit is contained in:
Pauli Virtanen 2024-02-19 20:03:01 +02:00
parent 3c27dcd868
commit aec9bc5217
6 changed files with 72 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

21
doc/dox/config/pipewire.conf.5.md
View file

@ -101,7 +101,7 @@ In "SPA" JSON:
- `,` to separate objects can be replaced with a whitespace character.
- `#` can be used to start a comment until the line end
# CONFIGURATION FILE SECTIONS
# CONFIGURATION FILE SECTIONS @IDX@ pipewire.conf
\par context.properties
Dictionary. These properties configure the PipeWire instance.
@ -129,6 +129,15 @@ this mode of operation has since been demoted to development aid. Avoid
starting a session manager in this way in production environment.
\endparblock
\par node.rules
Array of dictionaries. Match rules for modifying node properties
on the server.
\par device.rules
Array of dictionaries. Match rules for modifying device properties
on the server.
# CONTEXT PROPERTIES @IDX@ pipewire.conf
Available PipeWire properties in `context.properties` and possible
@ -381,7 +390,7 @@ context.exec = [
# MATCH RULES @IDX@ pipewire.conf
Some configuration files can contain match rules. This makes it
Some configuration file sections contain match rules. This makes it
possible to perform some action when an object (usually a node or
stream) is created/updated that matches certain properties.
@ -421,9 +430,9 @@ The available actions and their values depend on the specific rule
that is used. Usually it is possible to update some properties or set
some quirks on the object.
## node.rules
# NODE RULES @IDX@ pipewire.conf
The node.rules are evaluated very time the properties on a node are set
The node.rules are evaluated every time the properties on a node are set
or updated. This can be used on the server side to override client set
properties on arbitrary nodes.
@ -452,9 +461,9 @@ node.rules = [
Will set the `node.force-quantum` property of `jack_simple_client` to 512.
## device.rules
# DEVICE RULES @IDX@ pipewire.conf
The device.rules are evaluated very time the properties on a device are set
The device.rules are evaluated every time the properties on a device are set
or updated. This can be used on the server side to override client set
properties on arbitrary devices.