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

# [NAME](#NAME)

libpipewire-module-vban-send - VBAN sender

# [DESCRIPTION](#DESCRIPTION)

The vban-send module creates a PipeWire sink that sends audio and midi VBAN packets.

# [MODULE NAME](#MODULE_NAME)

libpipewire-module-vban-send

# [MODULE OPTIONS](#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](#GENERAL_OPTIONS)

Options with well-known behavior:

- **remote.name**
- **audio.format**
- **audio.rate**
- **audio.channels**
- **audio.layout**
- **audio.position**
- **node.name**
- **node.description**
- **media.name**
- **node.group**
- **node.latency**
- **node.virtual**
- **media.class**

# [EXAMPLE CONFIGURATION](#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

1.6.11 PipeWire

---

Document: libpipewire-module-vban-send(7) from pipewire 1.6.11-r2 (Chainguard OS)
Source: https://gitlab.freedesktop.org/pipewire/pipewire