.TH "libpipewire-module-netjack2-manager" 7 "1.6.8" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-netjack2-manager \- Netjack2 manager 
.SH DESCRIPTION
.PP
The netjack2 manager module listens for new netjack2 driver messages and will start a communication channel with them\&.

.PP
Messages are received on a (typically) multicast address\&.

.PP
Normally, the driver will specify the number of send and receive channels it wants to set up with the manager\&. If the driver however specifies a don't-care value of -1, the audio\&.ports and midi\&.ports configuration values of the manager are used\&.

.PP
The manager will create the corresponding streams to send and receive data to/from the drivers\&. These are usually sink and sources but with the netjack2\&.connect property, these will be streams that will be autoconnected to the default source and sink by the session manager\&.

.PP
.SH "MODULE NAME"
.PP

.PP
\fRlibpipewire-module-netjack2-manager\fP

.PP
.SH "MODULE OPTIONS"
.PP

.PP
.IP "\(bu" 2
\fRlocal\&.ifname = <str>\fP: interface name to use
.IP "\(bu" 2
\fRnet\&.ip =<str>\fP: multicast IP address, default "225\&.3\&.19\&.154"
.IP "\(bu" 2
\fRnet\&.port =<int>\fP: control port, default "19000"
.IP "\(bu" 2
\fRnet\&.mtu = <int>\fP: MTU to use, default 1500
.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
\fRnetjack2\&.connect\fP: if jack ports should be connected automatically\&. Can also be placed per stream, default false\&.
.IP "\(bu" 2
\fRnetjack2\&.sample-rate\fP: the sample rate to use, default 48000
.IP "\(bu" 2
\fRnetjack2\&.period-size\fP: the buffer size to use, default 1024
.IP "\(bu" 2
\fRnetjack2\&.encoding\fP: the encoding, float|opus|int, default float
.IP "\(bu" 2
\fRnetjack2\&.kbps\fP: the number of kilobits per second when encoding, default 64
.IP "\(bu" 2
\fRaudio\&.ports\fP: the number of audio ports\&. Can also be added to the stream props\&. This is the default suggestion for drivers that don't specify any number of audio channels\&.
.IP "\(bu" 2
\fRmidi\&.ports\fP: the number of midi ports\&. Can also be added to the stream props\&. This is the default suggestion for drivers that don't specify any number of midi channels\&.
.IP "\(bu" 2
\fRaudio\&.position\fP: default channel position for the number of audio\&.ports\&.
.IP "\(bu" 2
\fRsource\&.props\fP: Extra properties for the source filter\&.
.IP "\(bu" 2
\fRsink\&.props\fP: Extra properties for the sink filter\&.
.PP

.PP
.SH "GENERAL OPTIONS"
.PP

.PP
Options with well-known behavior\&.

.PP
.IP "\(bu" 2
\fBremote.name\fP
.IP "\(bu" 2
\fBaudio.channels\fP
.IP "\(bu" 2
\fBaudio.layout\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.virtual\fP
.IP "\(bu" 2
\fBmedia.class\fP
.IP "\(bu" 2
\fBtarget.object\fP to specify the remote node\&.name or serial\&.id to link to
.PP

.PP
.SH "EXAMPLE CONFIGURATION OF A DUPLEX SINK/SOURCE"
.PP

.PP
.PP
.nf
# ~/\&.config/pipewire/pipewire\&.conf\&.d/my\-netjack2\-manager\&.conf

context\&.modules = [
{   name = libpipewire\-module\-netjack2\-manager
    args = {
        #netjack2\&.connect     = true
        #netjack2\&.sample\-rate = 48000
        #netjack2\&.period\-size = 1024
        #netjack2\&.encoding    = float # float|opus
        #netjack2\&.kbps        = 64
        #audio\&.ports          = 0
        #midi\&.ports           = 0
        #audio\&.channels       = 2
        #audio\&.position       = [ FL FR ]
        source\&.props = {
            # extra source properties
        }
        sink\&.props = {
            # extra sink properties
        }
    }
}
]
.fi
.PP