1libpipewire-module-rtp-sMiinskc(e7l)laneous InformationlMiabnpuiaplewire-module-rtp-sink(7)
2
3
4

NAME

6       libpipewire-module-rtp-sink - RTP sink
7

DESCRIPTION

9       The rtp-sink module creates a PipeWire sink that sends audio RTP
10       packets.
11

MODULE NAME

13       libpipewire-module-rtp-sink
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 '224.0.0.56'
21
22       • destination.port =<int>: destination port, default random beteen
23         46000 and 47024
24
25       • local.ifname = <str>: interface name to use
26
27       • net.mtu = <int>: MTU to use, default 1280
28
29       • net.ttl = <int>: TTL to use, default 1
30
31       • net.loop = <bool>: loopback multicast, default false
32
33       • sess.min-ptime = <int>: minimum packet time in milliseconds, default
34         2
35
36       • sess.max-ptime = <int>: maximum packet time in milliseconds, default
37         20
38
39       • sess.name = <str>: a session name
40
41       • sess.ts-offset = <int>: an offset to apply to the timestamp, default
42         -1 = random offset
43
44       • sess.ts-refclk = <string>: the name of a reference clock
45
46       • sess.media = <string>: the media type audio|midi|opus, default audio
47
48       • stream.props = {}: properties to be passed to the stream
49

GENERAL OPTIONS

51       Options with well-known behavior:
52
53       • remote.name
54
55       • audio.format
56
57       • audio.rate
58
59       • audio.channels
60
61       • audio.position
62
63       • node.name
64
65       • node.description
66
67       • media.name
68
69       • node.group
70
71       • node.latency
72
73       • node.virtual
74
75       • media.class
76

EXAMPLE CONFIGURATION

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