.TH "libpipewire-module-protocol-simple" 7 "1.0.6" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-protocol-simple \- Protocol Simple 
.SH DESCRIPTION
.PP
The simple protocol provides a bidirectional audio stream on a network socket\&.
.PP
It is meant to be used with the \fRsimple protocol player\fP app, available on Android to play and record a stream\&.
.PP
Each client that connects will create a capture and/or playback stream, depending on the configuration options\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fRlibpipewire-module-protocol-simple\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
.IP "\(bu" 2
\fRcapture\fP: boolean if capture is enabled\&. This will create a capture stream for each connected client\&.
.IP "\(bu" 2
\fRplayback\fP: boolean if playback is enabled\&. This will create a playback stream for each connected client\&.
.IP "\(bu" 2
\fRcapture\&.node\fP: an optional node serial or name to use for capture\&.
.IP "\(bu" 2
\fRplayback\&.node\fP: an optional node serial or name to use for playback\&.
.IP "\(bu" 2
\fRserver\&.address = []\fP: an array of server addresses to listen on as tcp:(<ip>:)<port>\&.
.PP
.PP
.SH "GENERAL OPTIONS"
.PP
.PP
Options with well-known behavior\&.
.PP
.IP "\(bu" 2
\fBremote.name\fP
.IP "\(bu" 2
\fBaudio.rate\fP
.IP "\(bu" 2
\fBaudio.format\fP
.IP "\(bu" 2
\fBaudio.channels\fP
.IP "\(bu" 2
\fBaudio.position\fP
.IP "\(bu" 2
\fBnode.latency\fP
.IP "\(bu" 2
\fBnode.rate\fP
.IP "\(bu" 2
\fBstream.capture.sink\fP
.IP "\(bu" 2
\fBnode.name\fP
.PP
.PP
By default the server will work with stereo 16 bits samples at 44\&.1KHz\&.
.PP
.SH "EXAMPLE CONFIGURATION"
.PP
.PP
.PP
.nf
context\&.modules = [
{   name = libpipewire\-module\-protocol\-simple
    args = {
        # Provide capture stream, clients can capture data from PipeWire
        capture = true
        #
        # Provide playback stream, client can send data to PipeWire for playback
        playback = true
        #
        # The node name or id to use for capture\&.
        #capture\&.node = null
        #
        # To make the capture stream capture the monitor ports
        #stream\&.capture\&.sink = false
        #
        # The node name or id to use for playback\&.
        #playback\&.node = null
        #
        #audio\&.rate = 44100
        #audio\&.format = S16
        #audio\&.channels = 2
        #audio\&.position = [ FL FR ]
        #
        # The addresses this server listens on for new
        # client connections
        server\&.address = [
            "tcp:4711"
        ]
    }
}
]
.fi
.PP