PipeWire 1.2.6
|
The PipeWire client configuration file.
$XDG_CONFIG_HOME/pipewire/client.conf
/etc/pipewire/client.conf
/usr/share/pipewire/client.conf
/usr/share/pipewire/client.conf.d/
/etc/pipewire/client.conf.d/
$XDG_CONFIG_HOME/pipewire/client.conf.d/
$XDG_CONFIG_HOME/pipewire/client-rt.conf
/etc/pipewire/client-rt.conf
/usr/share/pipewire/client-rt.conf
/usr/share/pipewire/client-rt.conf.d/
/etc/pipewire/client-rt.conf.d/
$XDG_CONFIG_HOME/pipewire/client-rt.conf.d/
Configuration for PipeWire native clients, and for PipeWire's ALSA plugin.
A PipeWire native client program selects the default config to load, and if nothing is specified, it usually loads client.conf
.
The ALSA plugin uses the client-rt.conf
file, as do some PipeWire native clients such as pw-cat(1).
The configuration file format and lookup logic is the same as for pipewire.conf(5).
Drop-in configuration files client.conf.d/*.conf
can be used, and are recommended. See pipewire.conf(5).
In addition, the PipeWire context configuration sections may also be specified, see pipewire.conf(5).
The client configuration files contain a stream.properties section that configures the options for client streams:
Some of the properties refer to different aspects of the stream:
A list of object properties that can be applied to streams can be found in pipewire-props(7) Common Node Properties and pipewire-props(7) Audio Adapter Properties
You can add match rules, see pipewire(1) to set properties for certain streams and filters.
stream.rules
and filter.rules
provides an update-props
action that takes an object with properties that are updated on the node object of the stream and filter.
Add a stream.rules
or filter.rules
section in the config file like this:
Will set the node.name of Firefox to "My Name".
An alsa.properties
section can be added to configure client applications that connect via the PipeWire ALSA plugin.
cubic
and linear
. The default is to use cubic
.It is possible to set ALSA client specific properties by using Match rules, see pipewire(1). You can set any of the above ALSA properties or any of the stream.properties
.
See pipewire(1) for common environment variables. Many of these also apply to client applications.
The environment variables also influence ALSA applications that are using PipeWire's ALSA plugin.
This can be an object with properties from alsa.properties
or stream.properties
that will be used to construct the client and streams.
For example:
Starts aplay with custom properties.
Instructs the ALSA client to link to a particular sink or source object.serial
or node.name
.
For example:
Makes aplay play on the give audio sink.
The PipeWire Developers <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from <https://pipewire.org>
libpipewire-module-protocol-pulse(7), pipewire.conf(5), pipewire-pulse(1), pipewire-pulse-modules(7)