libpipewire-module-rtp-source - RTP source
Contents
Description
The rtp-source module creates a PipeWire source that receives audio and midi RTP packets.
This module is usually loaded from the SAPAnnounceandcreateRTPstreams so that the source.ip and
source.port and format parameters matches that of the sender.
Example Configuration
# ~/.config/pipewire/pipewire.conf.d/my-rtp-source.conf
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
PipeWire 1.4.5 libpipewire-module-rtp-source(7)
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
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. Set this to the IP address you want to
receive packets from or 0.0.0.0 to receive from any source address.
• source.port = <int>: the source port
• node.always-process = <bool>: true to receive even when not running
• sess.latency.msec = <float>: 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.may-pause = <bool>: pause the stream when no data is reveived, default false
• stream.props = {}: properties to be passed to the stream
Name
libpipewire-module-rtp-source - RTP source
PNG Icons