.TH "libpipewire-module-vban-send" 7 "1.0.1" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-vban-send \- VBAN sender 
The \fCvban-send\fP module creates a PipeWire sink that sends audio and midi \fCVBAN\fP packets\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fClibpipewire-module-vban-send\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
Options specific to the behavior of this module
.PP
.IP "\(bu" 2
\fCsource\&.ip =<str>\fP: source IP address, default '0\&.0\&.0\&.0'
.IP "\(bu" 2
\fCdestination\&.ip =<str>\fP: destination IP address, default '127\&.0\&.0\&.1'
.IP "\(bu" 2
\fCdestination\&.port =<int>\fP: destination port, default 6980
.IP "\(bu" 2
\fClocal\&.ifname = <str>\fP: interface name to use
.IP "\(bu" 2
\fCnet\&.mtu = <int>\fP: MTU to use, default 1500
.IP "\(bu" 2
\fCnet\&.ttl = <int>\fP: TTL to use, default 1
.IP "\(bu" 2
\fCnet\&.loop = <bool>\fP: loopback multicast, default false
.IP "\(bu" 2
\fCsess\&.min-ptime = <int>\fP: minimum packet time in milliseconds, default 2
.IP "\(bu" 2
\fCsess\&.max-ptime = <int>\fP: maximum packet time in milliseconds, default 20
.IP "\(bu" 2
\fCsess\&.name = <str>\fP: a session name
.IP "\(bu" 2
\fCsess\&.media = <string>\fP: the media type audio|midi, default audio
.IP "\(bu" 2
\fCstream\&.props = {}\fP: properties to be passed to the stream
.PP
.PP
.SH "GENERAL OPTIONS"
.PP
.PP
Options with well-known behavior:
.PP
.IP "\(bu" 2
\fBremote.name\fP
.IP "\(bu" 2
\fBaudio.format\fP
.IP "\(bu" 2
\fBaudio.rate\fP
.IP "\(bu" 2
\fBaudio.channels\fP
.IP "\(bu" 2
\fBaudio.position\fP
.IP "\(bu" 2
\fBnode.name\fP
.IP "\(bu" 2
\fBnode.description\fP
.IP "\(bu" 2
\fBmedia.name\fP
.IP "\(bu" 2
\fBnode.group\fP
.IP "\(bu" 2
\fBnode.latency\fP
.IP "\(bu" 2
\fBnode.virtual\fP
.IP "\(bu" 2
\fBmedia.class\fP
.PP
.PP
.SH "EXAMPLE CONFIGURATION"
.PP
.PP
.PP
.nf
 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"
         }
     }
}
]
.fi
.PP
.PP
\fBSince\fP
.RS 4
0\&.3\&.76 
.RE
.PP


