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

NAME
       libpipewire-module-roc-sink - ROC sink

DESCRIPTION
       The roc-sink module creates a PipeWire sink that sends samples to a
       preconfigured receiver address.


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


MODULE NAME
       libpipewire-module-roc-sink


MODULE OPTIONS
       Options specific to the behavior of this module


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

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

       o remote.ip = <str>: remote receiver ip

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

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

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

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

       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-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
             }
         }
       ]



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