1libpipewire-module-rtp-sMeissscieolnl(a7n)eous InformatiloinbpMiapneuwailre-module-rtp-session(7)
2
3
4

NAME

6       libpipewire-module-rtp-session - RTP session
7

DESCRIPTION

9       The rtp-session module creates a media session that is announced with
10       avahi/mDNS/Bonjour.
11
12       Other machines on the network that run a compatible session will see
13       eachother and will be able to send audio/midi between eachother.
14
15       The session setup is based on apple-midi and is compatible with apple-
16       midi when the session is using midi.
17

MODULE NAME

19       libpipewire-module-rtp-session
20

MODULE OPTIONS

22       Options specific to the behavior of this module
23
24       • local.ifname = <str>: interface name to use
25
26       • control.ip =<str>: control IP address, default '0.0.0.0'
27
28       • control.port =<int>: control port, default '0'
29
30       • net.mtu = <int>: MTU to use, default 1280
31
32       • net.ttl = <int>: TTL to use, default 1
33
34       • net.loop = <bool>: loopback multicast, default false
35
36       • sess.min-ptime = <int>: minimum packet time in milliseconds, default
37         2
38
39       • sess.max-ptime = <int>: maximum packet time in milliseconds, default
40         20
41
42       • sess.latency.msec = <int>: receiver latency in milliseconds, default
43         100
44
45       • sess.name = <str>: a session name
46
47       • sess.ts-offset = <int>: an offset to apply to the timestamp, default
48         -1 = random offset
49
50       • sess.ts-refclk = <string>: the name of a reference clock
51
52       • sess.media = <string>: the media type audio|midi|opus, default midi
53
54       • stream.props = {}: properties to be passed to the stream
55

GENERAL OPTIONS

57       Options with well-known behavior:
58
59       • remote.name
60
61       • audio.format
62
63       • audio.rate
64
65       • audio.channels
66
67       • audio.position
68
69       • node.name
70
71       • node.description
72
73       • media.name
74
75       • node.group
76
77       • node.latency
78
79       • node.virtual
80
81       • media.class
82

EXAMPLE CONFIGURATION

84        context.modules = [
85        {   name = libpipewire-module-rtp-session
86            args = {
87                #local.ifname = "eth0"
88                #control.ip = "0.0.0.0"
89                #control.port = 0
90                #net.mtu = 1280
91                #net.ttl = 1
92                #net.loop = false
93                #sess.min-ptime = 2
94                #sess.max-ptime = 20
95                #sess.name = "PipeWire RTP stream"
96                #sess.media = "audio"
97                stream.props = {
98                    node.name = "rtp-sink"
99                    #audio.format = "S16BE"
100                    #audio.rate = 48000
101                    #audio.channels = 2
102                    #audio.position = [ FL FR ]
103                }
104            }
105       }
106       ]
107
108       Since
109           0.3.60
110
111PipeWire                             1.0.0   libpipewire-module-rtp-session(7)
Impressum