libpipewire-module-vban-send - Man Page
VBAN sender
Description
The vban-send module creates a PipeWire sink that sends audio and midi VBAN packets.
Module Name
libpipewire-module-vban-send
Module Options
Options specific to the behavior of this module
- source.ip =<str>: source IP address, default '0.0.0.0'
- destination.ip =<str>: destination IP address, default '127.0.0.1'
- destination.port =<int>: destination port, default 6980
- local.ifname = <str>: interface name to use
- net.mtu = <int>: MTU to use, default 1500
- net.ttl = <int>: TTL to use, default 1
- net.loop = <bool>: loopback multicast, default false
- sess.min-ptime = <int>: minimum packet time in milliseconds, default 2
- sess.max-ptime = <int>: maximum packet time in milliseconds, default 20
- sess.name = <str>: a session name
- sess.media = <string>: the media type audio|midi, 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
- node.name
- node.description
- media.name
- node.group
- node.latency
- node.virtual
- media.class
Example Configuration
context.modules = [ { name = libpipewire-module-vban-send args = { #local.ifname = "eth0" #source.ip = "0.0.0.0" #destination.ip = "127.0.0.1" #destination.port = 6980 #net.mtu = 1500 #net.ttl = 1 #net.loop = false #sess.min-ptime = 2 #sess.max-ptime = 20 #sess.name = "PipeWire VBAN stream" #sess.media = "audio" #audio.format = "S16LE" #audio.rate = 44100 #audio.channels = 2 #audio.position = [ FL FR ] stream.props = { node.name = "vban-sender" } } } ]
Since
0.3.76
Referenced By
1.2.5 PipeWire