1PIPEWIRE.CONF(5)              File Formats Manual             PIPEWIRE.CONF(5)
2
3
4

NAME

6       pipewire.conf - The PipeWire server configuration file
7

SYNOPSIS

9       $XDG_CONFIG_HOME/pipewire/pipewire.conf
10
11       /etc/pipewire/pipewire.conf
12
13       /usr/share/pipewire/pipewire.conf
14

DESCRIPTION

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

CONFIGURATION FILE FORMAT

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

CONFIGURATION FILE SECTIONS

42       context.properties
43              Dictionary. These properties configure the PipeWire instance.
44
45       context.spa-libs
46              Dictionary. Maps plugin features with globs to a spa library.
47
48       context.modules
49              Array  of  dictionaries. Each entry in the array is a dictionary
50              with the name of the module to load, including optional args and
51              flags. Most modules support being loaded multiple times.
52
53       context.objects
54              Array  of  dictionaries. Each entry in the array is a dictionary
55              containing the factory to create an object from and optional ex‐
56              tra arguments specific to that factory.
57
58       context.exec
59              Array  of  dictionaries.  Each  entry in the array is dictionary
60              containing the path of a program to execute on startup  and  op‐
61              tional args.
62
63              This array used to contain an entry to start the session manager
64              but this mode of operation has since been demoted to development
65              aid.  Avoid starting a session manager in this way in production
66              environment.
67

AUTHORS

69       The                PipeWire                Developers                <‐
70       https://gitlab.freedesktop.org/pipewire/pipewire/issues>;  PipeWire  is
71       available from https://pipewire.org
72

SEE ALSO

74       pipewire(1), pw-mon(1),
75
76
77
78
79                                                              PIPEWIRE.CONF(5)
Impressum