1libpipewire-module-vban-Mriesccve(l7l)aneous InformationliMbapniupaelwire-module-vban-recv(7)
2
3
4

NAME

6       libpipewire-module-vban-recv - VBAN receiver
7

DESCRIPTION

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

MODULE NAME

13       libpipewire-module-vban-recv
14

MODULE OPTIONS

16       Options specific to the behavior of this module
17
18       • local.ifname = <str>: interface name to use
19
20       • source.ip = <str>: the source ip address, default 127.0.0.1
21
22       • source.port = <int>: the source port
23
24       • node.always-process = <bool>: true to receive even when not running
25
26       • sess.latency.msec = <str>: target network latency in milliseconds,
27         default 100
28
29       • sess.ignore-ssrc = <bool>: ignore SSRC, default false
30
31       • sess.media = <string>: the media type audio|midi|opus, default audio
32
33       • stream.props = {}: properties to be passed to the stream
34

GENERAL OPTIONS

36       Options with well-known behavior:
37
38       • remote.name
39
40       • audio.format
41
42       • audio.rate
43
44       • audio.channels
45
46       • audio.position
47
48       • media.name
49
50       • media.class
51
52       • node.name
53
54       • node.description
55
56       • node.group
57
58       • node.latency
59
60       • node.virtual
61

EXAMPLE CONFIGURATION

63       context.modules = [
64       {   name = libpipewire-module-vban-recv
65           args = {
66               #local.ifname = eth0
67               #source.ip = 127.0.0.1
68               #source.port = 6980
69               sess.latency.msec = 100
70               #sess.ignore-ssrc = false
71               #node.always-process = false
72               #sess.media = "audio"
73               #audio.format = "S16LE"
74               #audio.rate = 44100
75               #audio.channels = 2
76               #audio.position = [ FL FR ]
77               stream.props = {
78                  #media.class = "Audio/Source"
79                  node.name = "vban-receiver"
80               }
81           }
82       }
83       ]
84
85       Since
86           0.3.76
87
88PipeWire                             1.0.0     libpipewire-module-vban-recv(7)
Impressum