.TH "libpipewire-module-ffado-driver" 7 "1.1.82" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-ffado-driver \- FFADO firewire audio driver 
.SH DESCRIPTION
.PP
The ffado-driver module provides a source or sink using the libffado library for reading and writing to firewire audio devices\&.
.PP
.SH "MODULE NAME"
.PP
.PP
\fClibpipewire-module-ffado-driver\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
.IP "\(bu" 2
\fCdriver\&.mode\fP: the driver mode, sink|source|duplex, default duplex
.IP "\(bu" 2
\fCffado\&.devices\fP: array of devices to open, default 'hw:0'
.IP "\(bu" 2
\fCffado\&.period-size\fP: period size,default 1024
.IP "\(bu" 2
\fCffado\&.period-num\fP: period number,default 3
.IP "\(bu" 2
\fCffado\&.sample-rate\fP: sample-rate, default 48000
.IP "\(bu" 2
\fCffado\&.slave-mode\fP: slave mode
.IP "\(bu" 2
\fCffado\&.snoop-mode\fP: snoop mode
.IP "\(bu" 2
\fCffado\&.verbose\fP: ffado verbose level
.IP "\(bu" 2
\fCffado\&.rtprio\fP: ffado realtime priority, this is by default the PipeWire server priority + 5
.IP "\(bu" 2
\fCffado\&.realtime\fP: ffado realtime mode\&. this requires correctly configured rlimits to acquire FIFO scheduling at the ffado\&.rtprio priority
.IP "\(bu" 2
\fClatency\&.internal\&.input\fP: extra input latency in frames
.IP "\(bu" 2
\fClatency\&.internal\&.output\fP: extra output latency in frames
.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.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\-ffado\-driver
    args = {
        #driver\&.mode       = duplex
        #ffado\&.devices     = [ "hw:0" ]
        #ffado\&.period\-size = 1024
        #ffado\&.period\-num  = 3
        #ffado\&.sample\-rate = 48000
        #ffado\&.slave\-mode  = false
        #ffado\&.snoop\-mode  = false
        #ffado\&.verbose     = 0
        #ffado\&.rtprio      = 65
        #ffado\&.realtime    = true
        #latency\&.internal\&.input  = 0
        #latency\&.internal\&.output = 0
        #audio\&.position    = [ FL FR ]
        source\&.props = {
            # extra sink properties
        }
        sink\&.props = {
            # extra sink properties
        }
    }
}
]
.fi
.PP