1libpipewire-module-pipe-Mtiusncneelll(a7n)eous InformatiloinbpMiapneuwailre-module-pipe-tunnel(7)
2
3
4

NAME

6       libpipewire-module-pipe-tunnel - Unix Pipe Tunnel
7

DESCRIPTION

9       The pipe-tunnel module provides a source or sink that tunnels all audio
10       to or from a unix pipe respectively.
11

MODULE NAME

13       libpipewire-module-pipe-tunnel
14

MODULE OPTIONS

16       • tunnel.mode: the desired tunnel to create. (Default playback)
17
18       • tunnel.may-pause: if the tunnel stream is allowed to pause on xrun
19
20       • pipe.filename: the filename of the pipe.
21
22       • stream.props: Extra properties for the local stream.
23
24       When tunnel.mode is capture, a capture stream on the default source is
25       created. The samples captured from the source will be written to the
26       pipe.
27
28       When tunnel.mode is sink, a sink node is created. Samples played on the
29       sink will be written to the pipe.
30
31       When tunnel.mode is playback, a playback stream on the default sink is
32       created. The samples read from the pipe will be played on the sink.
33
34       When tunnel.mode is source, a source node is created. Samples read from
35       the the pipe will be made available on the source.
36
37       tunnel.may-pause allows the tunnel stream to become inactive (paused)
38       when there is no data in the fifo or when the fifo is full. For capture
39       and playback tunnel.mode this is by default true. For source and sink
40       tunnel.mode, this is by default false. A paused stream will consume no
41       CPU and will resume when the fifo becomes readable or writable again.
42
43       When pipe.filename is not given, a default fifo in /tmp/fifo_input or
44       /tmp/fifo_output will be created that can be written and read
45       respectively, depending on the selected tunnel.mode.
46

GENERAL OPTIONS

48       Options with well-known behavior.
49
50       • remote.name
51
52       • audio.format
53
54       • audio.rate
55
56       • audio.channels
57
58       • audio.position
59
60       • node.latency
61
62       • node.name
63
64       • node.description
65
66       • node.group
67
68       • node.virtual
69
70       • media.class
71
72       • target.object to specify the remote name or serial id to link to
73
74       When not otherwise specified, the pipe will accept or produce a 16
75       bits, stereo, 48KHz sample stream.
76

EXAMPLE CONFIGURATION OF A PIPE PLAYBACK STREAM

78       context.modules = [
79       {   name = libpipewire-module-pipe-tunnel
80           args = {
81               tunnel.mode = playback
82               #tunnel.may-pause = true
83               # Set the pipe name to tunnel to
84               pipe.filename = "/tmp/fifo_output"
85               #audio.format=<sample format>
86               #audio.rate=<sample rate>
87               #audio.channels=<number of channels>
88               #audio.position=<channel map>
89               #target.object=<remote target node>
90               stream.props = {
91                   # extra sink properties
92               }
93           }
94       }
95       ]
96
97PipeWire                             1.0.0   libpipewire-module-pipe-tunnel(7)
Impressum