1libpipewire-module-rtp-sMaips(c7e)llaneous Information Mlainbupailpewire-module-rtp-sap(7)
2
3
4
6 libpipewire-module-rtp-sap - SAP Announce and create RTP streams
7
9 The rtp-sap module announces RTP streams that match the rules with the
10 announce-stream action.
11
12 It will create source RTP streams that are announced with SAP when they
13 match the rule with the create-stream action.
14
15 If no stream.rules are given, it will announce all streams with
16 sess.sap.announce = true and it will create a receiver for all
17 announced streams.
18
20 libpipewire-module-rtp-sap
21
23 Options specific to the behavior of this module
24
25 • local.ifname = <str>: interface name to use
26
27 • sap.ip = <str>: IP address of the SAP messages, default '224.0.0.56'
28
29 • sap.port = <int>: port of the SAP messages, default 9875
30
31 • sap.cleanup.sec = <int>: cleanup interval in seconds, default 90
32 seconds
33
34 • source.ip =<str>: source IP address, default '0.0.0.0'
35
36 • net.ttl = <int>: TTL to use, default 1
37
38 • net.loop = <bool>: loopback multicast, default false
39
40 • stream.rules = <rules>: match rules, use create-stream and announce-
41 stream actions
42
44 Options with well-known behavior:
45
46 • remote.name
47
49 context.modules = [
50 { name = libpipewire-module-rtp-sap
51 args = {
52 #local.ifname = "eth0"
53 #sap.ip = "224.0.0.56"
54 #sap.port = 9875
55 #sap.cleanup.sec = 5
56 #source.ip = "0.0.0.0"
57 #net.ttl = 1
58 #net.loop = false
59 stream.rules = [
60 { matches = [
61 # any of the items in matches needs to match, if one does,
62 # actions are emited.
63 { # all keys must match the value. ! negates. ~ starts regex.
64 #rtp.origin = "wim 3883629975 0 IN IP4 0.0.0.0"
65 #rtp.payload = "127"
66 #rtp.fmt = "L16/48000/2"
67 #rtp.session = "PipeWire RTP Stream on fedora"
68 #rtp.ts-offset = 0
69 #rtp.ts-refclk = "private"
70 sess.sap.announce = true
71 }
72 ]
73 actions = {
74 announce-stream = {
75 }
76 }
77 }
78 { matches = [
79 { # all keys must match the value. ! negates. ~ starts regex.
80 #rtp.origin = "wim 3883629975 0 IN IP4 0.0.0.0"
81 #rtp.payload = "127"
82 #rtp.fmt = "L16/48000/2"
83 #rtp.session = "PipeWire RTP Stream on fedora"
84 #rtp.ts-offset = 0
85 #rtp.ts-refclk = "private"
86 rtp.session = "~.*"
87 }
88 ]
89 actions = {
90 create-stream = {
91 #sess.latency.msec = 100
92 #sess.ts-direct = false
93 #target.object = ""
94 }
95 }
96 }
97 ]
98 }
99 }
100 ]
101
102 Since
103 0.3.67
104
105PipeWire 1.0.0 libpipewire-module-rtp-sap(7)