HealthThresholdsSettings interface

Opt-in thresholds that make an input emit degraded / recovered on onConnectionStatusChange, evaluated engine-side from the health it already measures. Every field is optional; an unset threshold never trips. Behind / ahead are the smoothed delivery rate (only once settled), NOT the relative realtimeDelta. Pass "recommended" for sensible defaults in one line.

Signature:

export interface HealthThresholdsSettings

Properties

Property Type Description

clearAfterMs?

number

(Optional) hysteresis: condition must be clear this long before recovered (default 0)

droppedPerSecond?

number

(Optional) lossy (SRT) when the unrecovered dropped-packet rate exceeds this

latencyOverRttMin?

number

(Optional) latency_below_rtt (SRT) when latencyOverRtt falls below this (aim >= 3-4)

lossRatio?

number

(Optional) lossy (SRT) when received-lost/received over a sample exceeds this

maxDeliveryRate?

number

(Optional) ahead_of_realtime when settled deliveryRate exceeds this (e.g. 1.15)

minDeliveryRate?

number

(Optional) behind_realtime when settled deliveryRate falls below this (e.g. 0.85)

minDurationMs?

number

(Optional) hysteresis: hold a condition this long before degraded (default 0)

stalledMs?

number

(Optional) stalled when lastMediaAgeMs exceeds this (progressing:false also stalls)