pw-loopback - Man Page
PipeWire loopback client
Examples (TL;DR)
- Create a loopback device with the default loopback behavior:
pw-loopback
- Create a loopback device that automatically connects to the speakers:
pw-loopback -m '[FL FR]' --capture-props='media.class=Audio/Sink'
- Create a loopback device that automatically connects to the microphone:
pw-loopback -m '[FL FR]' --playback-props='media.class=Audio/Source'
- Create a dummy loopback device that doesn't automatically connect to anything:
pw-loopback -m '[FL FR]' --capture-props='media.class=Audio/Sink' --playback-props='media.class=Audio/Source'
- Create a loopback device that automatically connects to the speakers and swaps the left and right channels between the sink and source:
pw-loopback --capture-props='media.class=Audio/Sink audio.position=[FL FR]' --playback-props='audio.position=[FR FL]'
- Create a loopback device that automatically connects to the microphone and swaps the left and right channels between the sink and source:
pw-loopback --capture-props='audio.position=[FR FL]' --playback-props='media.class=Audio/Source audio.position=[FL FR]'
Synopsis
pw-loopback [options]
Description
The pw-loopback program is a PipeWire client that uses the PipeWire loopback module to create loopback nodes, with configuration given via the command-line options.
Options
- -h | --help
Show help.
- -r | --remote=NAME
The name of the remote instance to connect to. If left unspecified, a connection is made to the default PipeWire instance.
- -n | --name=NAME
Name of the loopback node
- -g | --group=NAME
Name of the loopback node group
- -c | --channels=NUMBER
Number of channels to provide
- -m | --channel-map=MAP
Channel map (default [ FL, FR ])
- -l | --latency=LATENCY
Desired latency in ms
- -d | --delay=DELAY
Added delay in seconds (floating point allowed)
- -C | --capture=TARGET
Target device to capture from
- -P | --playback=TARGET
Target device to play to
- --capture-props=PROPS
Wanted properties of capture node (in JSON)
- --playback-props=PROPS
Wanted properties of capture node (in JSON)
Authors
The PipeWire Developers <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from <https://pipewire.org>
See Also
pipewire(1), pw-cat(1), pactl(1)
Other ways to create loopback nodes are adding the loopback module in the configuration of a PipeWire daemon, or loading the loopback module using Pulseaudio commands (pactl load-module module-loopback ...).