Skip to content

Interface: Observation ​

What the controller reads each tick, in seconds, bytes and bits per second.

Properties ​

activeBitrate ​

activeBitrate: number

The bitrate of the rendition being received.


arrivalRate ​

arrivalRate: number

Video objects received within the last WINDOW over what the frame rate delivers in it: about 1 while the link keeps up, whatever the scene costs, and less once it falls behind.


evidence ​

evidence: number | null

The median of the last CONFIRMING estimates when all of them are still evidence: each ages only while the controller is free to act, and counts for UP_EVIDENCE seconds of that. Null otherwise.


forwardBuffer ​

forwardBuffer: number

Buffered ahead of the playhead.


groupInterval ​

groupInterval: number | null

Between group starts; null until two are seen.


ladder ​

ladder: readonly number[]

The selectable bitrates, ascending.


playbackRate ​

playbackRate: number

0 while stalled.


probeable ​

probeable: boolean

Whether a recent group is known well enough to plan a probe from.


probeAge ​

probeAge: number | null

Since the last probe ended with an estimate.


probeEstimate ​

probeEstimate: number | null

Link capacity recent probes saw, in bytes per second: the median of the last CONFIRMING, so one outlier can't swing it; null before a probe, or once contradicted.


probeFailures ​

probeFailures: number

Probes in a row that found no room for the next rendition.


probing ​

probing: boolean


receivedBytes ​

receivedBytes: number

Live video bytes received within the last WINDOW.


requested ​

requested: number

Index in ladder of the rendition last asked for.


settling ​

settling: boolean

A switch is taking effect: the old track still streams, or the new one hasn't arrived.


sinceProbe ​

sinceProbe: number | null

Since the last probe ended; null before one.


sinceSettled ​

sinceSettled: number

Since the last switch settled; windowed signals count from then on.


sinceSwitch ​

sinceSwitch: number


sinceTrouble ​

sinceTrouble: number

Since the last stall or the last time frames fell behind.


stalledTime ​

stalledTime: number

Time stalled within the last WINDOW.


throughput ​

throughput: number

Live video bytes per second: the slower of the last RECENT seconds and its second half, from the last settled switch on. Under trouble, live delivery saturates the link, so this is what it carries.