Man page - libpipewire-module-rtp-sink(7)
Packages contas this manual
- pipewire-pulse-module-alsa-source(7)
- pipewire-pulse-module-roc-sink-input(7)
- libpipewire-module-profiler(7)
- pipewire-pulse-module-ladspa-source(7)
- libpipewire-module-rtp-session(7)
- libpipewire-module-vban-send(7)
- pipewire-pulse-module-alsa-sink(7)
- libpipewire-module-adapter(7)
- libpipewire-module-portal(7)
- libpipewire-module-example-sink(7)
- pipewire-pulse-module-pipe-source(7)
- libpipewire-module-rtp-source(7)
- libpipewire-module-spa-node(7)
- pipewire-pulse-module-jackdbus-detect(7)
- libpipewire-module-snapcast-discover(7)
- pipewire-pulse-module-zeroconf-publish(7)
- libpipewire-module-jackdbus-detect(7)
- libpipewire-module-protocol-native(7)
- libpipewire-module-jack-tunnel(7)
- pipewire-pulse-module-always-sink(7)
- libpipewire-module-spa-node-factory(7)
- libpipewire-module-metadata(7)
- libpipewire-module-fallback-sink(7)
- libpipewire-module-ffado-driver(7)
- libpipewire-module-access(7)
- pipewire-pulse-module-native-protocol-tcp(7)
- libpipewire-module-parametric-equalizer(7)
- libpipewire-module-raop-discover(7)
- libpipewire-module-protocol-pulse(7)
- libpipewire-module-session-manager(7)
- pipewire-pulse-module-tunnel-source(7)
- pipewire-pulse-module-rtp-recv(7)
- libpipewire-module-loopback(7)
- pipewire-pulse-module-raop-discover(7)
- pipewire-pulse-module-gsettings(7)
- pipewire-pulse-module-ladspa-sink(7)
- pipewire-pulse-module-remap-source(7)
- libpipewire-module-netjack2-driver(7)
- libpipewire-module-client-node(7)
- libpipewire-module-example-source(7)
- libpipewire-module-rtp-sap(7)
- libpipewire-module-echo-cancel(7)
- libpipewire-module-spa-device-factory(7)
- pipewire-pulse-module-loopback(7)
- pipewire-pulse-module-tunnel-sink(7)
- libpipewire-module-combine-stream(7)
- libpipewire-module-netjack2-manager(7)
- pipewire-pulse-module-virtual-sink(7)
- pipewire-pulse-module-switch-on-connect(7)
- libpipewire-module-roc-source(7)
- pipewire-pulse-module-device-manager(7)
- libpipewire-module-avb(7)
- pipewire-pulse-module-null-sink(7)
- libpipewire-module-example-filter(7)
- pipewire-pulse-module-virtual-source(7)
- libpipewire-module-spa-device(7)
- pipewire-pulse-module-rtp-send(7)
- libpipewire-modules(7)
- pipewire-pulse-module-pipe-sink(7)
- libpipewire-module-roc-sink(7)
- libpipewire-module-pulse-tunnel(7)
- libpipewire-module-x11-bell(7)
- libpipewire-module-raop-sink(7)
- libpipewire-module-link-factory(7)
- pipewire-pulse-module-zeroconf-discover(7)
- libpipewire-module-protocol-simple(7)
- pipewire-pulse-module-roc-sink(7)
- libpipewire-module-zeroconf-discover(7)
- pipewire-pulse-module-x11-bell(7)
- pipewire-pulse-modules(7)
- pipewire-pulse-module-combine-sink(7)
- pipewire-pulse-module-device-restore(7)
- libpipewire-module-rtp-sink(7)
- pipewire-pulse-module-stream-restore(7)
- pipewire-pulse-module-simple-protocol-tcp(7)
- pipewire-pulse-module-echo-cancel(7)
- pipewire-pulse-module-remap-sink(7)
- libpipewire-module-rt(7)
- libpipewire-module-pipe-tunnel(7)
- libpipewire-module-client-device(7)
- pipewire-pulse-module-roc-source(7)
- libpipewire-module-filter-chain(7)
- libpipewire-module-vban-recv(7)
- pipewire-pulse-module-alsa-source(7)
- pipewire-pulse-module-roc-sink-input(7)
- libpipewire-module-profiler(7)
- pipewire-pulse-module-ladspa-source(7)
- libpipewire-module-rtp-session(7)
- libpipewire-module-vban-send(7)
- pipewire-pulse-module-alsa-sink(7)
- libpipewire-module-adapter(7)
- libpipewire-module-portal(7)
- libpipewire-module-example-sink(7)
- pipewire-pulse-module-pipe-source(7)
- libpipewire-module-rtp-source(7)
- libpipewire-module-spa-node(7)
- pipewire-pulse-module-jackdbus-detect(7)
- libpipewire-module-snapcast-discover(7)
- pipewire-pulse-module-zeroconf-publish(7)
- libpipewire-module-jackdbus-detect(7)
- libpipewire-module-protocol-native(7)
- libpipewire-module-jack-tunnel(7)
- pipewire-pulse-module-always-sink(7)
- libpipewire-module-spa-node-factory(7)
- libpipewire-module-metadata(7)
- libpipewire-module-fallback-sink(7)
- libpipewire-module-ffado-driver(7)
- libpipewire-module-access(7)
- pipewire-pulse-module-native-protocol-tcp(7)
- libpipewire-module-parametric-equalizer(7)
- libpipewire-module-raop-discover(7)
- libpipewire-module-protocol-pulse(7)
- libpipewire-module-session-manager(7)
- pipewire-pulse-module-tunnel-source(7)
- pipewire-pulse-module-rtp-recv(7)
- libpipewire-module-loopback(7)
- pipewire-pulse-module-raop-discover(7)
- pipewire-pulse-module-gsettings(7)
- pipewire-pulse-module-ladspa-sink(7)
- pipewire-pulse-module-remap-source(7)
- libpipewire-module-netjack2-driver(7)
- libpipewire-module-client-node(7)
- libpipewire-module-example-source(7)
- libpipewire-module-rtp-sap(7)
- libpipewire-module-echo-cancel(7)
- libpipewire-module-spa-device-factory(7)
- pipewire-pulse-module-loopback(7)
- pipewire-pulse-module-tunnel-sink(7)
- libpipewire-module-combine-stream(7)
- libpipewire-module-netjack2-manager(7)
- pipewire-pulse-module-virtual-sink(7)
- pipewire-pulse-module-switch-on-connect(7)
- libpipewire-module-roc-source(7)
- pipewire-pulse-module-device-manager(7)
- libpipewire-module-avb(7)
- pipewire-pulse-module-null-sink(7)
- libpipewire-module-example-filter(7)
- pipewire-pulse-module-virtual-source(7)
- libpipewire-module-spa-device(7)
- pipewire-pulse-module-rtp-send(7)
- libpipewire-modules(7)
- pipewire-pulse-module-pipe-sink(7)
- libpipewire-module-roc-sink(7)
- libpipewire-module-pulse-tunnel(7)
- libpipewire-module-x11-bell(7)
- libpipewire-module-raop-sink(7)
- libpipewire-module-link-factory(7)
- pipewire-pulse-module-zeroconf-discover(7)
- libpipewire-module-protocol-simple(7)
- pipewire-pulse-module-roc-sink(7)
- libpipewire-module-zeroconf-discover(7)
- pipewire-pulse-module-x11-bell(7)
- pipewire-pulse-modules(7)
- pipewire-pulse-module-combine-sink(7)
- pipewire-pulse-module-device-restore(7)
- libpipewire-module-rtp-sink(7)
- pipewire-pulse-module-stream-restore(7)
- pipewire-pulse-module-simple-protocol-tcp(7)
- pipewire-pulse-module-echo-cancel(7)
- pipewire-pulse-module-remap-sink(7)
- libpipewire-module-rt(7)
- libpipewire-module-pipe-tunnel(7)
- libpipewire-module-client-device(7)
- pipewire-pulse-module-roc-source(7)
- libpipewire-module-filter-chain(7)
- libpipewire-module-vban-recv(7)
Package: libpipewire-0.3-modules
apt-get install libpipewire-0.3-modules
apt-get install libpipewire-0.3-modules
Manuals in package:
Documentations in package:
Package: libpipewire-0.3-modules
apt-get install libpipewire-0.3-modules
apt-get install libpipewire-0.3-modules
Manuals in package:
Documentations in package:
Manual
| libpipewire-module-rtp-sink(7) | Miscellaneous Information Manual | libpipewire-module-rtp-sink(7) |
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
- 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 between 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 = <float>: minimum packet time in milliseconds, default 2
- sess.max-ptime = <float>: maximum packet time in milliseconds, default 20
- sess.name = <str>: a session name
- rtp.ptime = <float>: size of the packets in milliseconds, default up to MTU but between sess.min-ptime and sess.max-ptime
- rtp.framecount = <int>: number of samples per packet, default up to MTU but between sess.min-ptime and sess.max-ptime
- sess.latency.msec = <float>: target node latency in milliseconds, default as rtp.ptime
- 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
- sess.media = <string>: the media type audio|midi|opus, default audio
- stream.props = {}: properties to be passed to the stream
- 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:
- remote.name
- audio.format
- audio.rate
- audio.channels
- audio.position
- node.name
- node.description
- media.name
- node.group
- node.latency
- node.virtual
- 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
| 1.4.2 | PipeWire |