.TH "libpipewire-module-netjack2-driver" 7 "1.0.6" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-netjack2-driver \- Netjack2 driver 
.SH DESCRIPTION
.PP
The netjack2-driver module provides a source or sink that is following a netjack2 manager\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fRlibpipewire-module-netjack2-driver\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
.IP "\(bu" 2
\fRdriver\&.mode\fP: the driver mode, sink|source|duplex, default duplex
.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\&.client-name\fP: the name of the NETJACK2 client\&.
.IP "\(bu" 2
\fRnetjack2\&.save\fP: if jack port connections should be save automatically\&. Can also be placed per stream\&.
.IP "\(bu" 2
\fRnetjack2\&.latency\fP: the latency in cycles, default 2
.IP "\(bu" 2
\fRaudio\&.channels\fP: the number of audio ports\&. Can also be added to the stream props\&.
.IP "\(bu" 2
\fRmidi\&.ports\fP: the number of midi ports\&. Can also be added to the stream props\&.
.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.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
context\&.modules = [
{   name = libpipewire\-module\-netjack2\-driver
    args = {
        #driver\&.mode          = duplex
        #netjack2\&.client\-name = PipeWire
        #netjack2\&.save        = false
        #netjack2\&.latency     = 2
        #midi\&.ports           = 0
        #audio\&.channels       = 2
        #audio\&.position       = [ FL FR ]
        source\&.props = {
            # extra sink properties
        }
        sink\&.props = {
            # extra sink properties
        }
    }
}
]
.fi
.PP