.TH "libpipewire-module-rtp-sink" 7 "1.1.82" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-rtp-sink \- RTP sink 
.SH DESCRIPTION
.PP
The \fCrtp-sink\fP module creates a PipeWire sink that sends audio RTP packets\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fClibpipewire-module-rtp-sink\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
Options specific to the behavior of this module
.PP
.IP "\(bu" 2
\fCsource\&.ip =<str>\fP: source IP address, default '0\&.0\&.0\&.0'
.IP "\(bu" 2
\fCdestination\&.ip =<str>\fP: destination IP address, default '224\&.0\&.0\&.56'
.IP "\(bu" 2
\fCdestination\&.port =<int>\fP: destination port, default random between 46000 and 47024
.IP "\(bu" 2
\fClocal\&.ifname = <str>\fP: interface name to use
.IP "\(bu" 2
\fCnet\&.mtu = <int>\fP: MTU to use, default 1280
.IP "\(bu" 2
\fCnet\&.ttl = <int>\fP: TTL to use, default 1
.IP "\(bu" 2
\fCnet\&.loop = <bool>\fP: loopback multicast, default false
.IP "\(bu" 2
\fCsess\&.min-ptime = <float>\fP: minimum packet time in milliseconds, default 2
.IP "\(bu" 2
\fCsess\&.max-ptime = <float>\fP: maximum packet time in milliseconds, default 20
.IP "\(bu" 2
\fCsess\&.name = <str>\fP: a session name
.IP "\(bu" 2
\fCrtp\&.ptime = <float>\fP: size of the packets in milliseconds, default up to MTU but between sess\&.min-ptime and sess\&.max-ptime
.IP "\(bu" 2
\fCrtp\&.framecount = <int>\fP: number of samples per packet, default up to MTU but between sess\&.min-ptime and sess\&.max-ptime
.IP "\(bu" 2
\fCsess\&.latency\&.msec = <float>\fP: target node latency in milliseconds, default as rtp\&.ptime
.IP "\(bu" 2
\fCsess\&.ts-offset = <int>\fP: an offset to apply to the timestamp, default -1 = random offset
.IP "\(bu" 2
\fCsess\&.ts-refclk = <string>\fP: the name of a reference clock
.IP "\(bu" 2
\fCsess\&.media = <string>\fP: the media type audio|midi|opus, default audio
.IP "\(bu" 2
\fCstream\&.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
\fBnode.name\fP
.IP "\(bu" 2
\fBnode.description\fP
.IP "\(bu" 2
\fBmedia.name\fP
.IP "\(bu" 2
\fBnode.group\fP
.IP "\(bu" 2
\fBnode.latency\fP
.IP "\(bu" 2
\fBnode.virtual\fP
.IP "\(bu" 2
\fBmedia.class\fP
.PP
.PP
.SH "EXAMPLE CONFIGURATION"
.PP
.PP
.PP
.nf
 context\&.modules = [
 {   name = libpipewire\-module\-rtp\-sink
     args = {
         #local\&.ifname = "eth0"
         #source\&.ip = "0\&.0\&.0\&.0"
         #destination\&.ip = "224\&.0\&.0\&.56"
         #destination\&.port = 46000
         #net\&.mtu = 1280
         #net\&.ttl = 1
         #net\&.loop = false
         #sess\&.min\-ptime = 2
         #sess\&.max\-ptime = 20
         #sess\&.name = "PipeWire RTP stream"
         #sess\&.media = "audio"
         #audio\&.format = "S16BE"
         #audio\&.rate = 48000
         #audio\&.channels = 2
         #audio\&.position = [ FL FR ]
         stream\&.props = {
             node\&.name = "rtp\-sink"
         }
     }
}
]
.fi
.PP
.PP
\fBSince\fP
.RS 4
0\&.3\&.60 
.RE
.PP