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

NAME
       libpipewire-module-rtp-sink - RTP sink

DESCRIPTION
       The rtp-sink module creates a PipeWire sink that sends audio RTP
       packets.


MODULE NAME
       libpipewire-module-rtp-sink


MODULE OPTIONS
       Options specific to the behavior of this module


       o source.ip =<str>: source IP address, default "0.0.0.0"

       o destination.ip =<str>: destination IP address, default "224.0.0.56"

       o destination.port =<int>: destination port, default random between
         46000 and 47024

       o local.ifname = <str>: interface name to use

       o net.mtu = <int>: MTU to use, default 1280

       o net.ttl = <int>: TTL to use, default 1

       o net.loop = <bool>: loopback multicast, default false

       o sess.min-ptime = <float>: minimum packet time in milliseconds,
         default 2

       o sess.max-ptime = <float>: maximum packet time in milliseconds,
         default 20

       o sess.name = <str>: a session name

       o rtp.ptime = <float>: size of the packets in milliseconds, default up
         to MTU but between sess.min-ptime and sess.max-ptime

       o rtp.framecount = <int>: number of samples per packet, default up to
         MTU but between sess.min-ptime and sess.max-ptime

       o sess.latency.msec = <float>: target node latency in milliseconds,
         default as rtp.ptime

       o sess.ts-offset = <int>: an offset to apply to the timestamp, default
         -1 = random offset

       o sess.ts-refclk = <string>: the name of a reference clock

       o sess.media = <string>: the media type audio|midi|opus, default audio

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

       o aes67.driver-group = <string>: for AES67 streams, can be specified in
         order to allow the sink to be driven by a different node than the PTP
         driver.

GENERAL OPTIONS
       Options with well-known behavior:


       o remote.name

       o audio.format

       o audio.rate

       o audio.channels

       o audio.layout

       o audio.position

       o node.name

       o node.description

       o media.name

       o node.group

       o node.latency

       o node.virtual

       o media.class

EXAMPLE CONFIGURATION
        # ~/.config/pipewire/pipewire.conf.d/my-rtp-sink.conf

        context.modules = [
        {   name = libpipewire-module-rtp-sink
            args = {
                #local.ifname = "eth0"
                #source.ip = "0.0.0.0"
                #destination.ip = "224.0.0.56"
                #destination.port = 46000
                #net.mtu = 1280
                #net.ttl = 1
                #net.loop = false
                #sess.min-ptime = 2
                #sess.max-ptime = 20
                #sess.name = "PipeWire RTP stream"
                #sess.media = "audio"
                #audio.format = "S16BE"
                #audio.rate = 48000
                #audio.channels = 2
                #audio.position = [ FL FR ]
                stream.props = {
                    node.name = "rtp-sink"
                }
            }
       }
       ]

       Since
           0.3.60



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