PipeWire Module: RTP source

The rtp-source module creates a PipeWire source that receives audio RTP packets.

Module Options

Options specific to the behavior of this module

• sap.ip = <str>: IP address of the SAP messages, default "224.0.0.56"
• sap.port = <str>: port of the SAP messages, default 9875
• local.ifname = <str>: interface name to use
• sess.latency.msec = <str>: target network latency in milliseconds, default 100
• stream.props = {}: properties to be passed to the stream

General options

Options with well-known behavior:

• PW_KEY_NODE_NAME
• PW_KEY_NODE_DESCRIPTION
• PW_KEY_MEDIA_NAME
• PW_KEY_MEDIA_CLASS

Example configuration

context.modules = [
{   name = libpipewire-module-rtp-source
    args = {
        #sap.ip = 224.0.0.56
        #sap.port = 9875
        #local.ifname = eth0
        sess.latency.msec = 100
        #node.always-process = false # true to receive even when not running
        stream.props = {
           #media.class = "Audio/Source"
           #node.name = "rtp-source"
        }
        stream.rules = [
            {   matches = [
                    # any of the items in matches needs to match, if one does,
                    # actions are emited.
                    {   # all keys must match the value. ~ in value starts regex.
                        #rtp.origin = "wim 3883629975 0 IN IP4 0.0.0.0"
                        #rtp.payload = "127"
                        #rtp.fmt = "L16/48000/2"
                        #rtp.session = "PipeWire RTP Stream on fedora"
                        #rtp.ts-offset = 0
                        #rtp.ts-refclk = "private"
                    }
                ]
                actions = {
                    create-stream = {
                        #sess.latency.msec = 100
                        #sess.ts-direct = false
                        #target.object = ""
                    }
                }
            }
        ]
    }
}
]

Since

0.3.60