PipeWire 1.2.6

Loading...
Searching...
No Matches
VBAN receiver

The `vban-recv` module creates a PipeWire source that receives audio and midi VBAN packets.

# Module Name

`libpipewire-module-vban-recv`

# Module Options

Options specific to the behavior of this module

- `local.ifname = <str>`: interface name to use
- `source.ip = <str>`: the source ip address, default 127.0.0.1
- `source.port = <int>`: the source port
- `node.always-process = <bool>`: true to receive even when not running
- `sess.latency.msec = <str>`: target network latency in milliseconds, default 100
- `sess.ignore-ssrc = <bool>`: ignore SSRC, default false
- `sess.media = <string>`: the media type audio|midi|opus, default audio
- `stream.props = {}`: properties to be passed to the stream

# General options

Options with well-known behavior:

- PW_KEY_REMOTE_NAME
- PW_KEY_AUDIO_FORMAT
- PW_KEY_AUDIO_RATE
- PW_KEY_AUDIO_CHANNELS
- SPA_KEY_AUDIO_POSITION
- PW_KEY_MEDIA_NAME
- PW_KEY_MEDIA_CLASS
- PW_KEY_NODE_NAME
- PW_KEY_NODE_DESCRIPTION
- PW_KEY_NODE_GROUP
- PW_KEY_NODE_LATENCY
- PW_KEY_NODE_VIRTUAL

# Example configuration

# ~/.config/pipewire/pipewire.conf.d/my-vban-recv.conf
context.modules = [
{ name = libpipewire-module-vban-recv
args = {
#local.ifname = eth0
#source.ip = 127.0.0.1
#source.port = 6980
sess.latency.msec = 100
#sess.ignore-ssrc = false
#node.always-process = false
#sess.media = "audio"
#audio.format = "S16LE"
#audio.rate = 44100
#audio.channels = 2
#audio.position = [ FL FR ]
stream.props = {
#media.class = "Audio/Source"
node.name = "vban-receiver"
}
}
}
]

Since
  0.3.76