PipeWire  0.3.66
PipeWire Module: RTP sink

The rtp-sink module creates a PipeWire sink that sends 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 = <int>: port of the SAP messages, default 9875
  • source.ip =<str>: source IP address, default "0.0.0.0"
  • destination.ip =<str>: destination IP address, default "224.0.0.56"
  • destination.port =<int>: destination port, default random beteen 46000 and 47024
  • local.ifname = <str>: interface name to use
  • net.mtu = <int>: MTU to use, default 1280
  • net.ttl = <int>: TTL to use, default 1
  • net.loop = <bool>: loopback multicast, default false
  • sess.min-ptime = <int>: minimum packet time in milliseconds, default 2
  • sess.max-ptime = <int>: maximum packet time in milliseconds, default 20
  • sess.name = <str>: a session name
  • sess.ts-offset = <int>: an offset to apply to the timestamp, default -1 = random offset
  • sess.ts-refclk = <string>: the name of a reference clock
  • media.type = <string>: the media type audio|midi, default audio
  • stream.props = {}: properties to be passed to the stream

General options

Options with well-known behavior:

Example configuration

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