1libpipewire-module-vban-Msiesncde(l7l)aneous InformationliMbapniupaelwire-module-vban-send(7)
2
3
4

NAME

6       libpipewire-module-vban-send - VBAN sender
7

DESCRIPTION

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

MODULE NAME

13       libpipewire-module-vban-send
14

MODULE OPTIONS

16       Options specific to the behavior of this module
17
18       • source.ip =<str>: source IP address, default '0.0.0.0'
19
20       • destination.ip =<str>: destination IP address, default '127.0.0.1'
21
22       • destination.port =<int>: destination port, default 6980
23
24       • local.ifname = <str>: interface name to use
25
26       • net.mtu = <int>: MTU to use, default 1500
27
28       • net.ttl = <int>: TTL to use, default 1
29
30       • net.loop = <bool>: loopback multicast, default false
31
32       • sess.min-ptime = <int>: minimum packet time in milliseconds, default
33         2
34
35       • sess.max-ptime = <int>: maximum packet time in milliseconds, default
36         20
37
38       • sess.name = <str>: a session name
39
40       • sess.media = <string>: the media type audio|midi, default audio
41
42       • stream.props = {}: properties to be passed to the stream
43

GENERAL OPTIONS

45       Options with well-known behavior:
46
47       • remote.name
48
49       • audio.format
50
51       • audio.rate
52
53       • audio.channels
54
55       • audio.position
56
57       • node.name
58
59       • node.description
60
61       • media.name
62
63       • node.group
64
65       • node.latency
66
67       • node.virtual
68
69       • media.class
70

EXAMPLE CONFIGURATION

72        context.modules = [
73        {   name = libpipewire-module-vban-send
74            args = {
75                #local.ifname = "eth0"
76                #source.ip = "0.0.0.0"
77                #destination.ip = "127.0.0.1"
78                #destination.port = 6980
79                #net.mtu = 1500
80                #net.ttl = 1
81                #net.loop = false
82                #sess.min-ptime = 2
83                #sess.max-ptime = 20
84                #sess.name = "PipeWire VBAN stream"
85                #sess.media = "audio"
86                #audio.format = "S16LE"
87                #audio.rate = 44100
88                #audio.channels = 2
89                #audio.position = [ FL FR ]
90                stream.props = {
91                    node.name = "vban-sender"
92                }
93            }
94       }
95       ]
96
97       Since
98           0.3.76
99
100PipeWire                             1.0.0     libpipewire-module-vban-send(7)
Impressum