.TH "libpipewire-module-rtp-session" 7 "1.0.6" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-rtp-session \- RTP session 
.SH DESCRIPTION
.PP
The \fRrtp-session\fP module creates a media session that is announced with avahi/mDNS/Bonjour\&.
.PP
Other machines on the network that run a compatible session will see eachother and will be able to send audio/midi between eachother\&.
.PP
The session setup is based on apple-midi and is compatible with apple-midi when the session is using midi\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fRlibpipewire-module-rtp-session\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
\fRcontrol\&.ip =<str>\fP: control IP address, default '0\&.0\&.0\&.0'
.IP "\(bu" 2
\fRcontrol\&.port =<int>\fP: control port, default '0'
.IP "\(bu" 2
\fRnet\&.mtu = <int>\fP: MTU to use, default 1280
.IP "\(bu" 2
\fRnet\&.ttl = <int>\fP: TTL to use, default 1
.IP "\(bu" 2
\fRnet\&.loop = <bool>\fP: loopback multicast, default false
.IP "\(bu" 2
\fRsess\&.min-ptime = <int>\fP: minimum packet time in milliseconds, default 2
.IP "\(bu" 2
\fRsess\&.max-ptime = <int>\fP: maximum packet time in milliseconds, default 20
.IP "\(bu" 2
\fRsess\&.latency\&.msec = <int>\fP: receiver latency in milliseconds, default 100
.IP "\(bu" 2
\fRsess\&.name = <str>\fP: a session name
.IP "\(bu" 2
\fRsess\&.ts-offset = <int>\fP: an offset to apply to the timestamp, default -1 = random offset
.IP "\(bu" 2
\fRsess\&.ts-refclk = <string>\fP: the name of a reference clock
.IP "\(bu" 2
\fRsess\&.media = <string>\fP: the media type audio|midi|opus, default midi
.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
\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\-session
     args = {
         #local\&.ifname = "eth0"
         #control\&.ip = "0\&.0\&.0\&.0"
         #control\&.port = 0
         #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"
         stream\&.props = {
             node\&.name = "rtp\-sink"
             #audio\&.format = "S16BE"
             #audio\&.rate = 48000
             #audio\&.channels = 2
             #audio\&.position = [ FL FR ]
         }
     }
}
]
.fi
.PP
.PP
\fBSince\fP
.RS 4
0\&.3\&.60 
.RE
.PP