1pipewire.conf(5) File Formats Manual pipewire.conf(5)
2
3
4
6 pipewire.conf - The PipeWire server configuration file
7
9 $XDG_CONFIG_HOME/pipewire/pipewire.conf
10
11 /etc/pipewire/pipewire.conf
12
13 /usr/share/pipewire/pipewire.conf
14
16 PipeWire is a service that facilitates sharing of multimedia content
17 between devices and applications.
18
19 On startup, the daemon reads a configuration file to configure itself.
20 It executes a series of commands listed in the config file.
21
22 The config files are loaded in the order listed in the SYNOPSIS. The
23 environment variables PIPEWIRE_CONFIG_DIR, PIPEWIRE_CONFIG_PREFIX and
24 PIPEWIRE_CONFIG_NAME can be used to specify an alternative config di‐
25 rectory, subdirectory and file respectively.
26
28 The configuration file format is grouped into sections. A section is
29 either a dictionary, {}, or an array, []. Dictionary and array entries
30 are separated by whitespace and may be simple value assignment, an ar‐
31 ray or a dictionary. For example:
32
33 name = value # simple assignment
34
35 name = { key1 = value1 key2 = value2 } # a dictionary with two entries
36
37 name = [ value1 value2 ] # an array with two entries
38
39 name = [ { k = v1 } { k = v2 } ] # an array of dictionaries
40
42 context.properties (dictionary): These properties configure the
43 pipewire instance.
44
45 context.spa-libs (dictionary): Maps plugin features with globs to a spa
46 library.
47
48 context.modules (array): Each entry in the array is a dictionary with
49 the name of the module to load, including optional args and flags. Most
50 modules support being loaded multiple times.
51
52 context.objects (array): Each entry in the array is a dictionary con‐
53 taining the factory to create an object from and optional extra argu‐
54 ments specific to that factory.
55
56 context.exec (array): Each entry in the array is dictionary containing
57 the path of a program to execute on startup and optional args. This ar‐
58 ray usually contains an entry to start the session manager.
59
61 The PipeWire Developers <https://gitlab.freedesk‐
62 top.org/pipewire/pipewire/issues>; PipeWire is available from
63 http://pipewire.org
64
66 pipewire(1), pw-mon(1),
67
68
69
70Manuals User pipewire.conf(5)