Section 7 · Overviews and conventions

libpipewire-module-vban-recv.7

Package: pipewire-libs

On this page

libpipewire-module-vban-recv

NAME
DESCRIPTION
MODULE NAME
MODULE OPTIONS
GENERAL OPTIONS
EXAMPLE CONFIGURATION

NAME

libpipewire-module-vban-recv − VBAN receiver

DESCRIPTION

The vban-recv module creates a PipeWire source that receives audio and midi VBAN packets.

MODULE NAME

libpipewire-module-vban-recv

MODULE OPTIONS

Options specific to the behavior of this module

•local.ifname = <str>: interface name to use
•source.ip = <str>: the source ip address, default 127.0.0.1
•source.port = <int>: the source port
•node.always-process = <bool>: true to receive even when not running
•sess.latency.msec = <str>: target network latency in milliseconds, default 100
•sess.ignore-ssrc = <bool>: ignore SSRC, default false
•sess.media = <string>: the media type audio|midi|opus, default audio
•stream.props = {}: properties to be passed to the stream

GENERAL OPTIONS

Options with well-known behavior:

•remote.name
•audio.format
•audio.rate
•audio.channels
•audio.position
•media.name
•media.class
•node.name
•node.description
•node.group
•node.latency
•node.virtual

EXAMPLE CONFIGURATION

~/.config/pipewire/pipewire.conf.d/my−vban−recv.conf

context.modules = [
{ name = libpipewire−module−vban−recv
args = {
#local.ifname = eth0
#source.ip = 127.0.0.1
#source.port = 6980
sess.latency.msec = 100
#sess.ignore−ssrc = false
#node.always−process = false
#sess.media = “audio”
#audio.format = “S16LE”
#audio.rate = 44100
#audio.channels = 2
#audio.position = [ FL FR ]
stream.props = {
#media.class = “Audio/Source”
node.name = “vban−receiver”
}
}
}
]

Since

0.3.76