.TH "libpipewire-module-example-sink" 7 "1.0.6" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-example-sink \- Example Sink 
.SH DESCRIPTION
.PP
The example sink is a good starting point for writing a custom sink\&. We refer to the source code for more information\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fRlibpipewire-module-example-sink\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
.IP "\(bu" 2
\fRnode\&.name\fP: a unique name for the stream
.IP "\(bu" 2
\fRnode\&.description\fP: a human readable name for the stream
.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
\fBnode.latency\fP
.IP "\(bu" 2
\fBnode.name\fP
.IP "\(bu" 2
\fBnode.description\fP
.IP "\(bu" 2
\fBnode.group\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\-example\-sink
    args = {
        node\&.name = "example_sink"
        node\&.description = "My Example Sink"
        stream\&.props = {
            audio\&.position = [ FL FR ]
        }
    }
}
]
.fi
.PP