.TH "libpipewire-module-roc-sink" 7 "1.1.82" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-roc-sink \- ROC sink 
.SH DESCRIPTION
.PP
The \fCroc-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
\fClibpipewire-module-roc-sink\fP
.PP
.SH "MODULE OPTIONS"
.PP
.PP
Options specific to the behavior of this module
.PP
.IP "\(bu" 2
\fCsink\&.props = {}\fP: properties to be passed to the sink stream
.IP "\(bu" 2
\fCsink\&.name = <str>\fP: node\&.name of the sink
.IP "\(bu" 2
\fCremote\&.ip = <str>\fP: remote receiver ip
.IP "\(bu" 2
\fCremote\&.source\&.port = <str>\fP: remote receiver TCP/UDP port for source packets
.IP "\(bu" 2
\fCremote\&.repair\&.port = <str>\fP: remote receiver TCP/UDP port for receiver packets
.IP "\(bu" 2
\fCremote\&.control\&.port = <str>\fP: remote receiver TCP/UDP port for control packets
.IP "\(bu" 2
\fCfec\&.code = <str>\fP: Possible values: \fCdisable\fP, \fCrs8m\fP, \fCldpc\fP
.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
\fBmedia.name\fP
.PP
.PP
.SH "EXAMPLE CONFIGURATION"
.PP
.PP
.PP
.nf
 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"
          }
      }
  }
]
.fi
.PP