RIST ingest

id

A unique identifier for the component instance

displayName

The name shown in the Studio UI of this component

port

The receiving port (default: 1968)

<COMPONENT_ID>_PORT

host

The IP address/hostname to bind, or to dial when not listening (default: "0.0.0.0")

<COMPONENT_ID>_HOST

listener

Bind and wait for a sender (the default), rather than dialling the far end out (default: true)

profile

simple = VSF TR-06-1 (RTP over UDP with retransmission). main = VSF TR-06-2, which adds encryption, SRP authentication and virtual ports, and is what most equipment means by RIST. (default: "main")

localInterface

Optional interface to bind, or to join a multicast group on

bufferMs

The retransmission buffer, in milliseconds. This is the latency budget, and also the cap on how far back a lost packet can still be recovered — it has to exceed the round-trip time by enough for a retry. Blank = the RIST default.

secret

Main-profile AES passphrase. Blank = unencrypted. Simple profile has no encryption, so this is ignored there.

<COMPONENT_ID>_SECRET

keySize

AES key size. Blank = the RIST default when a passphrase is set.

srpUsername

Main-profile SRP authentication username. Blank = no SRP.

<COMPONENT_ID>_SRPUSERNAME

srpPassword

Main-profile SRP authentication password

<COMPONENT_ID>_SRPPASSWORD

redundantPeers

Extra receive paths carrying an identical copy of this stream. Every path carries a full copy and RIST merges them as they arrive, so losing any one is invisible downstream — RIST's equivalent of ST 2022-7, and unlike ST 2022-7 the paths need not come from a single splitter, because RIST carries its own sequence numbers. (default: [])

burstProtection

Drop data until input is completely stable (default: true)

captureSchedule

Also capture the future EIT schedule (not just now/next). The full schedule can be large, so this defaults to off. (default: false)

streamMappings

Configure which streams to accept from this input

timeDomain

Optional: time domain for frame-accurate alignment with other inputs (Global Configuration → Time Domains)

healthPolicy

Connection health: override the document-wide Input health policy, thresholds or sampling for this input. There is no publisher to refuse, so Enforce behaves as Alert here.

notes

Additional notes about this component

name

A label for logs and alerts

host

The IP or hostname of this path

port

The port of this path

localInterface

Optional interface to bind for this path — typically a different NIC from the primary, since two paths down one wire protect against very little

mode

Override the document-wide Input health policy for this input (default: "inherit")

thresholds

Alert thresholds the engine judges connections against; blank fields use the recommended values

sampling

How often the engine samples connection health

id

Domain ID. Inputs (and documents on the same engine) that use this ID share a coordinator. Letters, digits, dash and underscore.

mode

How members of this domain are aligned. (default: "time_aligned_pts")

seiTimeoutMs

Time-aligned (SEI timecode) only. How long (ms) a member waits for its first SEI-bearing frame before taking the action below. Blank = wait indefinitely.

onSeiTimeout

Time-aligned (SEI timecode) only. Action when the SEI timeout elapses: fail the input, or demote it to default (uncoordinated) timing. (default: "fail")

walltimeThresholdMs

GOP-aligned only. Walltime threshold (ms) for accepting a member's IDR against the rolling reference. Default 400 — keep under half the GOP duration. (default: 400)