PipeWire Module: Pulse Tunnel

The pulse-tunnel module provides a source or sink that tunnels all audio to a remote PulseAudio connection.

It is usually used with the PulseAudio or module-protocol-pulse on the remote end to accept the connection.

This module is usually used together with module-zeroconf-discover that will automatically load the tunnel with the right parameters based on zeroconf information.

Module Options

• tunnel.mode: the desired tunnel to create, must be capture or playback. (Default playback)
• pulse.server.address: the address of the PulseAudio server to tunnel to.
• pulse.latency: the latency to end-to-end latency in milliseconds to maintain (Default 200ms).
• stream.props: Extra properties for the local stream.

General options

Options with well-known behavior.

• PW_KEY_REMOTE_NAME
• PW_KEY_AUDIO_RATE
• PW_KEY_AUDIO_CHANNELS
• SPA_KEY_AUDIO_POSITION
• PW_KEY_NODE_LATENCY
• PW_KEY_NODE_NAME
• PW_KEY_NODE_DESCRIPTION
• PW_KEY_NODE_GROUP
• PW_KEY_NODE_VIRTUAL
• PW_KEY_MEDIA_CLASS
• PW_KEY_NODE_TARGET to specify the remote name or id to link to

Example configuration of a virtual sink

context.modules = [
{   name = libpipewire-module-pulse-tunnel
    args = {
        tunnel.mode = playback
        # Set the remote address to tunnel to
        pulse.server.address = "tcp:192.168.1.126"
        #audio.rate=<sample rate>
        #audio.channels=<number of channels>
        #audio.position=<channel map>
        #node.target=<remote target node>
        stream.props = {
            # extra sink properties
        }
    }
}
]