libpipewire-module-loopback(7)

1libpipewire-module-loopbMaicskc(e7l)laneous InformationlMiabnpuiaplewire-module-loopback(7)
2
3
4

NAME

6       libpipewire-module-loopback - Loopback
7

DESCRIPTION

9       The loopback module passes the output of a capture stream unmodified to
10       a playback stream.
11
12       It can be used to construct a link between a source and sink but also
13       to create new virtual sinks or sources or to remap channel between
14       streams.
15
16       Because both ends of the loopback are built with streams, the session
17       manager can manage the configuration and connection with the sinks and
18       sources.
19

MODULE NAME

21       libpipewire-module-loopback
22

MODULE OPTIONS

24       • node.description: a human readable name for the loopback streams
25
26       • target.delay.sec: delay in seconds as float (Since 0.3.60)
27
28       • capture.props = {}: properties to be passed to the input stream
29
30       • playback.props = {}: properties to be passed to the output stream
31

GENERAL OPTIONS

33       Options with well-known behavior. Most options can be added to the
34       global configuration or the individual streams:
35
36       • remote.name
37
38       • audio.rate
39
40       • audio.channels
41
42       • audio.position
43
44       • media.name
45
46       • node.latency
47
48       • node.description
49
50       • node.group
51
52       • node.link.group
53
54       • node.virtual
55
56       • node.name: See notes below. If not specified, defaults to
57         'loopback-<pid>-<module-id>'.
58
59       Stream only properties:
60
61       • media.class
62
63       • node.name: if not given per stream, the global node.name will be
64         prefixed with 'input.' and 'output.' to generate a capture and
65         playback stream node.name respectively.
66

EXAMPLE CONFIGURATION OF A VIRTUAL SINK

68       This Virtual sink routes stereo input to the rear channels of a 7.1
69       sink.
70
71       context.modules = [
72       {   name = libpipewire-module-loopback
73           args = {
74               node.description = "CM106 Stereo Pair 2"
75               #target.delay.sec = 1.5
76               capture.props = {
77                   node.name = "CM106_stereo_pair_2"
78                   media.class = "Audio/Sink"
79                   audio.position = [ FL FR ]
80               }
81               playback.props = {
82                   node.name = "playback.CM106_stereo_pair_2"
83                   audio.position = [ RL RR ]
84                   target.object = "alsa_output.usb-0d8c_USB_Sound_Device-00.analog-surround-71"
85                   node.dont-reconnect = true
86                   stream.dont-remix = true
87                   node.passive = true
88               }
89           }
90       }
91       ]
92

EXAMPLE CONFIGURATION OF A VIRTUAL SOURCE

94       This Virtual source routes the front-left channel of a multi-channel
95       input to a mono channel. This is useful for splitting up multi-channel
96       inputs from USB audio interfaces that are not yet fully supported by
97       alsa.
98
99       context.modules = [
100       {   name = libpipewire-module-loopback
101           args = {
102             node.description = "Scarlett Focusrite Line 1"
103             capture.props = {
104                 audio.position = [ FL ]
105                 stream.dont-remix = true
106                 node.target = "alsa_input.usb-Focusrite_Scarlett_Solo_USB_Y7ZD17C24495BC-00.analog-stereo"
107                 node.passive = true
108             }
109             playback.props = {
110                 node.name = "SF_mono_in_1"
111                 media.class = "Audio/Source"
112                 audio.position = [ MONO ]
113             }
114           }
115       }
116       ]
117