libpipewire-module-vban-send(7)               Miscellaneous Information Manual

NAME
       libpipewire-module-vban-send - 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


       o source.ip =<str>: source IP address, default '0.0.0.0'

       o destination.ip =<str>: destination IP address, default '127.0.0.1'

       o destination.port =<int>: destination port, default 6980

       o local.ifname = <str>: interface name to use

       o net.mtu = <int>: MTU to use, default 1500

       o net.ttl = <int>: TTL to use, default 1

       o net.loop = <bool>: loopback multicast, default false

       o sess.min-ptime = <int>: minimum packet time in milliseconds, default
         2

       o sess.max-ptime = <int>: maximum packet time in milliseconds, default
         20

       o sess.name = <str>: a session name

       o sess.media = <string>: the media type audio|midi, default audio

       o stream.props = {}: properties to be passed to the stream

GENERAL OPTIONS
       Options with well-known behavior:


       o remote.name

       o audio.format

       o audio.rate

       o audio.channels

       o audio.position

       o node.name

       o node.description

       o media.name

       o node.group

       o node.latency

       o node.virtual

       o media.class

EXAMPLE CONFIGURATION
        # ~/.config/pipewire/pipewire.conf.d/my-vban-send.conf

        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



PipeWire                             1.2.6     libpipewire-module-vban-send(7)