libpipew...ban-send(7)

💖 libpipewire-module-vban-send 💖

okay bestie, listen up — this is the manual page for libpipewire-module-vban-send(7), which lives in the Miscellaneous Information Manual section. it's giving "networking but make it audio" and honestly? we're obsessed. 🎀

---

✨ NAME ✨

libpipewire-module-vban-send — the VBAN sender 🦋

---

🌸 DESCRIPTION 🌸

so the vban-send module literally creates a PipeWire sink that sends audio and midi as VBAN packets. that's it, that's the whole vibe. it's the main character that ships your sound out over the network. 💅

---

🎀 MODULE NAME 🎀

libpipewire-module-vban-send

like. that's what you put in your config. no cap. ✨

---

💜 MODULE OPTIONS 💜

these are the options that are specific to how this module behaves, bestie. read them all, don't skip, I will know. 🙈

• source.ip =<str> — the source IP address. default is "0.0.0.0" 🌈
• destination.ip =<str> — the destination IP address, aka where the packets are going. default is "127.0.0.1" ⭐
• destination.port =<int> — the destination port. default is 6980 👑
• local.ifname = <str> — the interface name to use 🔥
• net.mtu = <int> — the MTU to use. default is 1500 🦋
• net.ttl = <int> — the TTL to use. default is 1 🌸
• net.loop = <bool> — loopback multicast. default is false 💫
• sess.min-ptime = <int> — minimum packet time in milliseconds. default is 2 🍓
• sess.max-ptime = <int> — maximum packet time in milliseconds. default is 20 🧚
• sess.name = <str> — a session name 💖
• sess.media = <string> — the media type, audio|midi. default is audio 💀
• stream.props = {} — properties to be passed to the stream ✨

---

🌈 GENERAL OPTIONS 🌈

these ones have well-known behavior, so PipeWire already knows what to do with them — no extra lore needed. 💅

• 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 ⭐

here's a whole config you can literally copy, bestie. it lives at ~/.config/pipewire/pipewire.conf.d/my-vban-send.conf and it ate, fr fr. 🔥

 # ~/.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 — yes she's been iconic since then. periodt. 👑

---

okay that's the whole page, you're so welcome 🫶 this lil beauty is part of PipeWire, version 1.6.11, and this manual page for libpipew...ban-send(7) was served fresh on the day it got rendered. go forth and send those packets, bestie, ily 💖✨🎀