.TH "libpipewire-module-rtp-source" 7 "1.0.6" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-rtp-source \- RTP source 
.SH DESCRIPTION
.PP
The \fRrtp-source\fP module creates a PipeWire source that receives audio and midi RTP packets\&.
.PP
This module is usually loaded from the \fBSAP Announce and create RTP streams\fP so that the source\&.ip and source\&.port and format parameters matches that of the sender\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fRlibpipewire-module-rtp-source\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
Options specific to the behavior of this module
.PP
.IP "\(bu" 2
\fRlocal\&.ifname = <str>\fP: interface name to use
.IP "\(bu" 2
\fRsource\&.ip = <str>\fP: the source ip address, default 224\&.0\&.0\&.56
.IP "\(bu" 2
\fRsource\&.port = <int>\fP: the source port
.IP "\(bu" 2
\fRnode\&.always-process = <bool>\fP: true to receive even when not running
.IP "\(bu" 2
\fRsess\&.latency\&.msec = <str>\fP: target network latency in milliseconds, default 100
.IP "\(bu" 2
\fRsess\&.ignore-ssrc = <bool>\fP: ignore SSRC, default false
.IP "\(bu" 2
\fRsess\&.media = <string>\fP: the media type audio|midi|opus, default audio
.IP "\(bu" 2
\fRstream\&.props = {}\fP: properties to be passed to the stream
.PP
.PP
.SH "GENERAL OPTIONS"
.PP
.PP
Options with well-known behavior:
.PP
.IP "\(bu" 2
\fBremote.name\fP
.IP "\(bu" 2
\fBaudio.format\fP
.IP "\(bu" 2
\fBaudio.rate\fP
.IP "\(bu" 2
\fBaudio.channels\fP
.IP "\(bu" 2
\fBaudio.position\fP
.IP "\(bu" 2
\fBmedia.name\fP
.IP "\(bu" 2
\fBmedia.class\fP
.IP "\(bu" 2
\fBnode.name\fP
.IP "\(bu" 2
\fBnode.description\fP
.IP "\(bu" 2
\fBnode.group\fP
.IP "\(bu" 2
\fBnode.latency\fP
.IP "\(bu" 2
\fBnode.virtual\fP
.PP
.PP
.SH "EXAMPLE CONFIGURATION"
.PP
.PP
.PP
.nf
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"
        }
    }
}
]
.fi
.PP
.PP
\fBSince\fP
.RS 4
0\&.3\&.60 
.RE
.PP