.TH "libpipewire-module-roc-sink" 7 "1.6.6" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-roc-sink \- ROC sink 
.SH DESCRIPTION
.PP
The \fRroc-sink\fP module creates a PipeWire sink that sends samples to a preconfigured receiver address\&.

.PP
One can then connect an audio stream of any running application to that sink or make it the default sink\&.

.PP
.SH "MODULE NAME"
.PP

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

.PP
.SH "MODULE OPTIONS"
.PP

.PP
Options specific to the behavior of this module

.PP
.IP "\(bu" 2
\fRsink\&.props = {}\fP: properties to be passed to the sink stream
.IP "\(bu" 2
\fRsink\&.name = <str>\fP: node\&.name of the sink
.IP "\(bu" 2
\fRremote\&.ip = <str>\fP: remote receiver ip
.IP "\(bu" 2
\fRremote\&.source\&.port = <str>\fP: remote receiver TCP/UDP port for source packets
.IP "\(bu" 2
\fRremote\&.repair\&.port = <str>\fP: remote receiver TCP/UDP port for receiver packets
.IP "\(bu" 2
\fRremote\&.control\&.port = <str>\fP: remote receiver TCP/UDP port for control packets
.IP "\(bu" 2
\fRfec\&.code = <str>\fP: Possible values: \fRdisable\fP, \fRrs8m\fP, \fRldpc\fP
.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\-sink\&.conf

 context\&.modules = [
  {   name = libpipewire\-module\-roc\-sink
      args = {
          fec\&.code = disable
          remote\&.ip = 192\&.168\&.0\&.244
          remote\&.source\&.port = 10001
          remote\&.repair\&.port = 10002
          remote\&.control\&.port = 10003
          sink\&.name = "ROC Sink"
          sink\&.props = {
             node\&.name = "roc\-sink"
          }
          audio\&.position = [ FL FR ]
          log\&.level = DEFAULT
      }
  }
]
.fi
.PP
 

