libpipewire-module-vban-recv - Man Page
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
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
Referenced By
1.2.5 PipeWire