.TH "libpipewire-module-roc-source" 7 "1.6.8" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-roc-source \- ROC source 
.SH DESCRIPTION
.PP
The \fRroc-source\fP module creates a PipeWire source that receives samples from ROC sender and passes them to the sink it is connected to\&.

.PP
One can then connect it to any audio device\&.

.PP
.SH "MODULE NAME"
.PP

.PP
\fRlibpipewire-module-roc-source\fP

.PP
.SH "MODULE OPTIONS"
.PP

.PP
Options specific to the behavior of this module

.PP
.IP "\(bu" 2
\fRsource\&.props = {}\fP: properties to be passed to the source stream
.IP "\(bu" 2
\fRsource\&.name = <str>\fP: node\&.name of the source
.IP "\(bu" 2
\fRlocal\&.ip = <str>\fP: local sender ip
.IP "\(bu" 2
\fRlocal\&.source\&.port = <str>\fP: local receiver TCP/UDP port for source packets
.IP "\(bu" 2
\fRlocal\&.repair\&.port = <str>\fP: local receiver TCP/UDP port for receiver packets
.IP "\(bu" 2
\fRlocal\&.control\&.port = <str>\fP: local receiver TCP/UDP port for control packets
.IP "\(bu" 2
\fRsess\&.latency\&.msec = <str>\fP: target network latency in milliseconds
.IP "\(bu" 2
\fRroc\&.resampler\&.backend = <str>\fP: Possible values: \fRdefault\fP, \fRbuiltin\fP, \fRspeex\fP, \fRspeexdec\fP\&.
.IP "\(bu" 2
\fRroc\&.resampler\&.profile = <str>\fP: Possible values: \fRdefault\fP, \fRhigh\fP, \fRmedium\fP, \fRlow\fP\&.
.IP "\(bu" 2
\fRroc\&.latency-tuner\&.backend = <str>\fP: Possible values: \fRdefault\fP, \fRniq\fP
.IP "\(bu" 2
\fRroc\&.latency-tuner\&.profile = <str>\fP: Possible values: \fRdefault\fP, \fRintact\fP, \fRresponsive\fP, \fRgradual\fP
.IP "\(bu" 2
\fRfec\&.code = <str>\fP: Possible values: \fRdefault\fP, \fRdisable\fP, \fRrs8m\fP, \fRldpc\fP
.IP "\(bu" 2
\fRresampler\&.profile = <str>\fP: Deprecated, use roc\&.resampler\&.profile
.IP "\(bu" 2
\fRlog\&.level = <str>\fP: log level for roc-toolkit\&. Possible values: \fRDEFAULT\fP, \fRNONE\fP, \fRERROR\fP, \fRINFO\fP, \fRDEBUG\fP, \fRTRACE\fP; \fRDEFAULT\fP follows the log level of the PipeWire context\&.
.PP

.PP
.SH "GENERAL OPTIONS"
.PP

.PP
Options with well-known behavior:

.PP
.IP "\(bu" 2
\fBnode.name\fP
.IP "\(bu" 2
\fBnode.description\fP
.IP "\(bu" 2
\fBnode.virtual\fP
.IP "\(bu" 2
\fBmedia.class\fP
.IP "\(bu" 2
\fBaudio.position\fP
.PP

.PP
.SH "EXAMPLE CONFIGURATION"
.PP

.PP
.PP
.nf
 # ~/\&.config/pipewire/pipewire\&.conf\&.d/my\-roc\-source\&.conf

 context\&.modules = [
  {   name = libpipewire\-module\-roc\-source
      args = {
          local\&.ip = 0\&.0\&.0\&.0
          #roc\&.resampler\&.backend = default
          roc\&.resampler\&.profile = medium
          #roc\&.latency\-tuner\&.backend = default
          #roc\&.latency\-tuner\&.profile = default
          fec\&.code = disable
          sess\&.latency\&.msec = 5000
          local\&.source\&.port = 10001
          local\&.repair\&.port = 10002
          local\&.control\&.port = 10003
          source\&.name = "ROC Source"
          source\&.props = {
             node\&.name = "roc\-source"
          }
          audio\&.position = [ FL FR ]
          log\&.level = DEFAULT
      }
  }
]
.fi
.PP