RistInputSettings interface

Settings for a RIST input (VSF TR-06-1 / TR-06-2).

RIST carries MPEG-TS, so this decodes through the same path as NorskInput.udpTs() and produces the same streams and events; what RIST adds is retransmission, and in main profile encryption, SRP authentication and virtual ports.

The host/port and the tuning below describe the primary peer; RistInputSettings.redundantPeers adds more.

see: NorskInput.rist()

Signature:

export interface RistInputSettings extends RemoteInputSettings<RistInputNode>, TsCommonInputSettings, StreamStatisticsMixin, RistPeerTuning

Extends: RemoteInputSettings<RistInputNode>, TsCommonInputSettings, StreamStatisticsMixin, RistPeerTuning

Properties

Property Type Description

Property	Type	Description
chaosDropPackets?	DropRandom	(Optional) Drop raw input packets ala NorskTransform.streamChaosMonkey(). Leaving this undefined means don’t drop any packets For testing, you really don’t want this in a live system.
debugDumpSource?	string	(Optional) When specified dump the raw source input for debug purposes to the given directory
healthSampling?	HealthSamplingSettings	(Optional) Per-input health sampling. Emits periodic TsConnectionHealth events via TsCommonInputSettings.onConnectionHealth. On by default.
profile?	RistProfileSetting	(Optional) Unset = `"main"`.
redundantPeers?	RistPeerSettings[]	(Optional) Extra peers carrying an identical copy of the stream. With every peer at the default weight of 0, librist merges them and losing any one path is invisible downstream — RIST’s own answer to ST 2022-7, and the equivalent of UdpTsInputSettings.seamlessProtection. The merge happens before anything reaches the workflow, so the duplicate traffic is not paid for downstream only to be discarded.
srpUsers?	{ username: string; password: string; }[]	(Optional) Main-profile SRP authentication for the LISTENING peers: the senders allowed in, each proving its password without sending it (a sender uses the same username and password, e.g. ffmpeg’s `-username`/`-password`). Unset or empty = no SRP. For a peer that dials out, see RistPeerTuning.srpUsername.
startupThreshold?	InputThresholdSettings	(Optional) when specified, drop data until the input is ticking at realtime
statsIntervalMs?	number	(Optional) How often librist reports flow statistics (retransmissions, loss, rtt), which is what feeds TsCommonInputSettings.onConnectionHealth. Unset = 1000ms.

chaosDropPackets?

DropRandom

(Optional) Drop raw input packets ala NorskTransform.streamChaosMonkey(). Leaving this undefined means don’t drop any packets For testing, you really don’t want this in a live system.

debugDumpSource?

string

(Optional) When specified dump the raw source input for debug purposes to the given directory

healthSampling?

HealthSamplingSettings

(Optional) Per-input health sampling. Emits periodic TsConnectionHealth events via TsCommonInputSettings.onConnectionHealth. On by default.

profile?

RistProfileSetting

(Optional) Unset = "main".

redundantPeers?

RistPeerSettings[]

(Optional) Extra peers carrying an identical copy of the stream. With every peer at the default weight of 0, librist merges them and losing any one path is invisible downstream — RIST’s own answer to ST 2022-7, and the equivalent of UdpTsInputSettings.seamlessProtection. The merge happens before anything reaches the workflow, so the duplicate traffic is not paid for downstream only to be discarded.

srpUsers?

{ username: string; password: string; }[]

(Optional) Main-profile SRP authentication for the LISTENING peers: the senders allowed in, each proving its password without sending it (a sender uses the same username and password, e.g. ffmpeg’s -username/-password). Unset or empty = no SRP. For a peer that dials out, see RistPeerTuning.srpUsername.

startupThreshold?

InputThresholdSettings

(Optional) when specified, drop data until the input is ticking at realtime

statsIntervalMs?

number

(Optional) How often librist reports flow statistics (retransmissions, loss, rtt), which is what feeds TsCommonInputSettings.onConnectionHealth. Unset = 1000ms.