libpipewire-module-roc-source(7)              Miscellaneous Information Manual

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


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

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

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

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

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

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

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

       o roc.resampler.backend = <str>: Possible values: default, builtin,
         speex, speexdec.

       o roc.resampler.profile = <str>: Possible values: default, high,
         medium, low.

       o roc.latency-tuner.backend = <str>: Possible values: default, niq

       o roc.latency-tuner.profile = <str>: Possible values: default, intact,
         responsive, gradual

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

       o resampler.profile = <str>: Deprecated, use roc.resampler.profile

       o log.level = <str>: log level for roc-toolkit. Possible values:
         DEFAULT, NONE, ERROR, INFO, DEBUG, TRACE; DEFAULT follows the log
         level of the PipeWire context.

GENERAL OPTIONS
       Options with well-known behavior:


       o node.name

       o node.description

       o node.virtual

       o media.class

       o audio.position

EXAMPLE CONFIGURATION
        # ~/.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
             }
         }
       ]



PipeWire                             1.6.8    libpipewire-module-roc-source(7)