.TH "libpipewire-module-raop-sink" 7 "1.0.6" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-raop-sink \- AirPlay Sink 
.SH DESCRIPTION
.PP
Creates a new Sink to stream to an Airplay device\&.
.PP
Normally this sink is automatically created with \fBRAOP Discover\fP with the right parameters but it is possible to manually create a RAOP sink as well\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fRlibpipewire-module-raop-sink\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
Options specific to the behavior of this module
.PP
.IP "\(bu" 2
\fRraop\&.ip\fP: The ip address of the remote end\&.
.IP "\(bu" 2
\fRraop\&.port\fP: The port of the remote end\&.
.IP "\(bu" 2
\fRraop\&.name\fP: The name of the remote end\&.
.IP "\(bu" 2
\fRraop\&.hostname\fP: The hostname of the remote end\&.
.IP "\(bu" 2
\fRraop\&.transport\fP: The data transport to use, one of 'udp' or 'tcp'\&. Defaults to 'udp'\&.
.IP "\(bu" 2
\fRraop\&.encryption\&.type\fP: The encryption type to use\&. One of 'none', 'RSA' or 'auth_setup'\&. Default is 'none'\&.
.IP "\(bu" 2
\fRraop\&.audio\&.codec\fP: The audio codec to use\&. Needs to be 'PCM'\&. Defaults to 'PCM'\&.
.IP "\(bu" 2
\fRraop\&.password\fP: The password to use\&.
.IP "\(bu" 2
\fRstream\&.props = {}\fP: properties to be passed to the sink stream
.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
\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\-raop\-sink
    args = {
        # Set the remote address to tunnel to
        raop\&.ip = "127\&.0\&.0\&.1"
        raop\&.port = 8190
        raop\&.name = "my\-raop\-device"
        raop\&.hostname = "My Service"
        #raop\&.transport = "udp"
        raop\&.encryption\&.type = "RSA"
        #raop\&.audio\&.codec = "PCM"
        #raop\&.password = "****"
        #audio\&.format = "S16"
        #audio\&.rate = 44100
        #audio\&.channels = 2
        #audio\&.position = [ FL FR ]
        stream\&.props = {
            # extra sink properties
        }
    }
}
]
.fi
.PP
.PP
.SH "SEE ALSO"
.PP
.PP
\fBRAOP Discover\fP