table of contents
libpipewire-module-rtp-source(7) | Miscellaneous Information Manual | libpipewire-module-rtp-source(7) |
NAME¶
libpipewire-module-rtp-source - RTP source The rtp-source module creates a PipeWire source that receives audio and midi RTP packets.
This module is usually loaded from the SAP Announce and create RTP streams so that the source.ip and source.port and format parameters matches that of the sender.
MODULE NAME¶
libpipewire-module-rtp-source
MODULE OPTIONS¶
Options specific to the behavior of this module
- local.ifname = <str>: interface name to use
- source.ip = <str>: the source ip address, default 224.0.0.56
- source.port = <int>: the source port
- node.always-process = <bool>: true to receive even when not running
- sess.latency.msec = <str>: target network latency in milliseconds, default 100
- sess.ignore-ssrc = <bool>: ignore SSRC, default false
- sess.media = <string>: the media type audio|midi|opus, default audio
- stream.props = {}: properties to be passed to the stream
GENERAL OPTIONS¶
Options with well-known behavior:
- remote.name
- audio.format
- audio.rate
- audio.channels
- audio.position
- media.name
- media.class
- node.name
- node.description
- node.group
- node.latency
- node.virtual
EXAMPLE CONFIGURATION¶
context.modules = [ { name = libpipewire-module-rtp-source
args = {
#local.ifname = eth0
#source.ip = 224.0.0.56
#source.port = 0
sess.latency.msec = 100
#sess.ignore-ssrc = false
#node.always-process = false
#sess.media = "audio"
#audio.format = "S16BE"
#audio.rate = 48000
#audio.channels = 2
#audio.position = [ FL FR ]
stream.props = {
#media.class = "Audio/Source"
node.name = "rtp-source"
}
} } ]
Since
0.3.60
1.0.1 | PipeWire |