1libpipewire-module-protoMcioslc-enlaltainveeo(u7s)InforlmiabtpiiopnewMiarneu-amlodule-protocol-native(7)
2
3
4

NAME

6       libpipewire-module-protocol-native - Protocol Native
7

DESCRIPTION

9       The native protocol module implements the PipeWire communication
10       between a client and a server using unix local sockets.
11
12       Normally this module is loaded in both client and server config files
13       so that they cam communicate.
14

MODULE NAME

16       libpipewire-module-protocol-native
17

MODULE OPTIONS

19       The module supports the following arguments:
20
21       • sockets: [ { name = 'socket-name', owner = 'owner', group = 'group',
22         mode = 'mode', selinux.context = 'context' }, ... ]
23
24       Array of Unix socket names and (optionally) owner/permissions to serve,
25       if the context is a server. If not absolute paths, the sockets are
26       created in the default runtime directory.
27
28       Has the default value [ { name = 'CORENAME' }, { name = 'CORENAME-
29       manager' } ], where CORENAME is the name of the PipeWire core, usually
30       pipewire-0.
31
32       The permissions have no effect for sockets from Systemd socket
33       activation. Those should be configured via the systemd.socket(5)
34       mechanism.
35

GENERAL OPTIONS

37       The name of the core is obtained as:
38
39       • PIPEWIRE_CORE : the environment variable with the name of the core
40
41       • core.name : in the context properties
42
43       • a name based on the process id
44
45       The context will also become a server if:
46
47       • PIPEWIRE_DAEMON : the environment is true
48
49       • core.daemon : in the context properties is true
50
51       The socket will be located in the directory obtained by looking at the
52       following environment variables:
53
54       • PIPEWIRE_RUNTIME_DIR
55
56       • XDG_RUNTIME_DIR
57
58       • USERPROFILE
59
60       The socket address will be written into the notification file
61       descriptor if the following environment variable is set:
62
63       • PIPEWIRE_NOTIFICATION_FD
64
65       When a client connect, the connection will be made to:
66
67       • PIPEWIRE_REMOTE : the environment with the remote name
68
69       • remote.name : the property in the context.
70
71       • The default remote named 'pipewire-0'
72
73       A Special remote named 'internal' can be used to make a connection to
74       the local context. This can be done even when the server is not a
75       daemon. It can be used to treat a local context as if it was a server.
76

EXAMPLE CONFIGURATION

78       context.modules = [
79       { name = libpipewire-module-protocol-native }
80       ]
81
82       context.modules = [
83        { name = libpipewire-module-protocol-native,
84          args = { sockets = [ { name = "pipewire-0" }, { name = "pipewire-0-manager" } ] } }
85       ]
86
87PipeWire                             1.0.0libpipewire-module-protocol-native(7)
Impressum