NAME

       libpipewire-module-roc-source - ROC source

DESCRIPTION

       The roc-source module creates a PipeWire source that receives samples from ROC sender and
       passes them to the sink it is connected to.

       One can then connect it to any audio device.

MODULE NAME

       libpipewire-module-roc-source

MODULE OPTIONS

       Options specific to the behavior of this module

       • source.props = {}: properties to be passed to the source stream

       • source.name = <str>: node.name of the source

       • local.ip = <str>: local sender ip

       • local.source.port = <str>: local receiver TCP/UDP port for source packets

       • local.repair.port = <str>: local receiver TCP/UDP port for receiver packets

       • local.control.port = <str>: local receiver TCP/UDP port for control packets

       • sess.latency.msec = <str>: target network latency in milliseconds

       • resampler.profile = <str>: Possible values: disable, high, medium, low.

       • fec.code = <str>: Possible values: disable, rs8m, ldpc

GENERAL OPTIONS

       Options with well-known behavior:

       • node.name

       • node.description

       • media.name

EXAMPLE CONFIGURATION

        context.modules = [
         {   name = libpipewire-module-roc-source
             args = {
                 local.ip = 0.0.0.0
                 resampler.profile = medium
                 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"
                 }
             }
         }
       ]