1libpipewire-module-rtp-sMoiusrcceel(l7a)neous InformatiolnibMpainpueawlire-module-rtp-source(7)
2
3
4

NAME

6       libpipewire-module-rtp-source - RTP source
7

DESCRIPTION

9       The rtp-source module creates a PipeWire source that receives audio and
10       midi RTP packets.
11
12       This module is usually loaded from the SAP Announce and create RTP
13       streams so that the source.ip and source.port and format parameters
14       matches that of the sender.
15

MODULE NAME

17       libpipewire-module-rtp-source
18

MODULE OPTIONS

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

GENERAL OPTIONS

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

EXAMPLE CONFIGURATION

67       context.modules = [
68       {   name = libpipewire-module-rtp-source
69           args = {
70               #local.ifname = eth0
71               #source.ip = 224.0.0.56
72               #source.port = 0
73               sess.latency.msec = 100
74               #sess.ignore-ssrc = false
75               #node.always-process = false
76               #sess.media = "audio"
77               #audio.format = "S16BE"
78               #audio.rate = 48000
79               #audio.channels = 2
80               #audio.position = [ FL FR ]
81               stream.props = {
82                  #media.class = "Audio/Source"
83                  node.name = "rtp-source"
84               }
85           }
86       }
87       ]
88
89       Since
90           0.3.60
91
92PipeWire                             1.0.0    libpipewire-module-rtp-source(7)
Impressum