Scroll to navigation

RISTRECEIVER(1) User Commands RISTRECEIVER(1)

NAME

ristreceiver - receive a stream via RIST

SYNOPSIS

ristreceiver [OPTIONS]

DESCRIPTION

Reliable Internet Stream Transport (RIST) is a transport protocol designed for reliable transmission of video over lossy networks (including the Internet) with low latency and high quality.

ristreceiver receives a RIST stream and relays the contents to an UDP or RTP stream.

Where OPTIONS are:

rist://...
Mandatory Option: Comma separated list of input rist URLs
udp://... or rtp://...
Mandatory Option: Comma separated list of output udp or rtp URLs. Use tun://@ to write udp data to a tun device defined using the -t option.
Default buffer size for packet retransmissions
Default pre-shared encryption secret
Default Encryption type (0, 128 = AES-128, 256 = AES-256)
Rist profile (0 = simple, 1 = main, 2 = advanced)
Interval at which stats get printed, 0 to disable
YAML config file
To disable logging: -1, log levels match syslog levels
Send logs and stats to this IP:PORT using udp messages
When in listening mode, use this file to hold the list of usernames and passwords to validate against. Use the ristsrppasswd tool to create the line entries.
Create a tun device and use it for data communications
Data management on the tun interface: 0 = all tun data is accepted into or out of oob channel, 1 = only non udp data is accepted (default), 2 = no data goes into or out of oob channel.
Enable OpenMetrics/Prometheus compatible metrics
Additional tags to add to the metrics
Metrics return multiple timestamped data points
Metrics skip the created metric for Prometheus compat
Start HTTP Server to expose metrics on defaults to http://0.0.0.0:9100/metrics
Port for metrics HTTP server to listen on
IP for metrics HTTP server to listen on
Unix socket to expose metrics on
Exit on no flow after Timeout
Show this help
Show all the possible url options

Default values:

--verbose-level 6

SEE ALSO

ristsender(1), ristsrppasswd(1), https://code.videolan.org/rist/librist/-/wikis/LibRIST%20Documentation

AUTHOR

This manual page was written by Florian Ernst <florian@debian.org>, for the Debian project (and may be used by others).

April 2026 ristreceiver version: 30 libRIST library: 0.2.13 API version: 4.7.0