Skip to main content

Interface: BroadcastHealth

Represents the health of the broadcast at a given moment, with details and reasons.

Properties

detail

detail: object

Per-dimension breakdown: encoder and connection health.

connection

connection: ConnectionDetail

encoder

encoder: EncoderDetail


limitingDimension?

optional limitingDimension: HealthDimension

Dimension behind score; set whenever score is defined.


reasons

reasons: HealthReason[]

Active reasons for degraded health; empty when healthy.


score?

optional score: number

Limiting dimension's 0–10 score; undefined when state is "unknown".


state

state: HealthState

Overall health rating this tick.