.TH "libpipewire-module-jack-tunnel" 7 "1.1.82" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-jack-tunnel \- JACK Tunnel 
.SH DESCRIPTION
.PP
The jack-tunnel module provides a source or sink that tunnels all audio to a JACK server\&.
.PP
This module is usually used together with \fBJACK DBus detect\fP that will automatically load the tunnel with the right parameters based on dbus information\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fClibpipewire-module-jack-tunnel\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
.IP "\(bu" 2
\fCjack\&.library\fP: the libjack to load, by default libjack\&.so\&.0 is searched in JACK_PATH directories and then some standard library paths\&. Can be an absolute path\&.
.IP "\(bu" 2
\fCjack\&.server\fP: the name of the JACK server to tunnel to\&.
.IP "\(bu" 2
\fCjack\&.client-name\fP: the name of the JACK client\&.
.IP "\(bu" 2
\fCjack\&.connect\fP: if jack ports should be connected automatically\&. Can also be placed per stream\&.
.IP "\(bu" 2
\fCtunnel\&.mode\fP: the tunnel mode, sink|source|duplex, default duplex
.IP "\(bu" 2
\fCmidi\&.ports\fP: the number of midi ports\&. Can also be added to the stream props\&.
.IP "\(bu" 2
\fCsource\&.props\fP: Extra properties for the source filter\&.
.IP "\(bu" 2
\fCsink\&.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\-jack\-tunnel
    args = {
        #jack\&.library     = libjack\&.so\&.0
        #jack\&.server      = null
        #jack\&.client\-name = PipeWire
        #jack\&.connect     = true
        #tunnel\&.mode      = duplex
        #midi\&.ports       = 0
        #audio\&.channels   = 2
        #audio\&.position   = [ FL FR ]
        source\&.props = {
            # extra sink properties
        }
        sink\&.props = {
            # extra sink properties
        }
    }
}
]
.fi
.PP