1libpipewire-module-pulseM-itsucnenlella(n7e)ous InformatliiobnpiMpaenwuiarle-module-pulse-tunnel(7)
2
3
4

NAME

6       libpipewire-module-pulse-tunnel - Pulse Tunnel
7

DESCRIPTION

9       The pulse-tunnel module provides a source or sink that tunnels all
10       audio to a remote PulseAudio connection.
11
12       It is usually used with the PulseAudio or module-protocol-pulse on the
13       remote end to accept the connection.
14
15       This module is usually used together with module-zeroconf-discover that
16       will automatically load the tunnel with the right parameters based on
17       zeroconf information.
18

MODULE NAME

20       libpipewire-module-pulse-tunnel
21

MODULE OPTIONS

23       • tunnel.mode: the desired tunnel to create, must be source or sink.
24         (Default sink)
25
26       • pulse.server.address: the address of the PulseAudio server to tunnel
27         to.
28
29       • pulse.latency: the latency to end-to-end latency in milliseconds to
30         maintain (Default 200).
31
32       • stream.props: Extra properties for the local stream.
33

GENERAL OPTIONS

35       Options with well-known behavior.
36
37       • remote.name
38
39       • audio.format
40
41       • audio.rate
42
43       • audio.channels
44
45       • audio.position
46
47       • node.latency
48
49       • node.name
50
51       • node.description
52
53       • node.group
54
55       • node.virtual
56
57       • media.class
58
59       • target.object to specify the remote node.name or serial.id to link to
60

EXAMPLE CONFIGURATION OF A VIRTUAL SINK

62       context.modules = [
63       {   name = libpipewire-module-pulse-tunnel
64           args = {
65               tunnel.mode = sink
66               # Set the remote address to tunnel to
67               pulse.server.address = "tcp:192.168.1.126"
68               #pulse.latency = 200
69               #audio.rate=<sample rate>
70               #audio.channels=<number of channels>
71               #audio.position=<channel map>
72               #target.object=<remote target name>
73               stream.props = {
74                   # extra sink properties
75               }
76           }
77       }
78       ]
79
80PipeWire                             1.0.0  libpipewire-module-pulse-tunnel(7)
Impressum