Interface LatencyManager

The latency manager, used to control low-latency live playback.

Remark

This is only used for live playback.

interface LatencyManager {
    currentConfiguration: undefined | LatencyConfiguration;
    currentLatency: undefined | number;
    enabled: boolean;
    monitoringLivePlayback: boolean;
}

Properties

currentConfiguration currentLatency enabled monitoringLivePlayback

Properties

Readonly currentConfiguration

currentConfiguration: undefined | LatencyConfiguration

The current latency configuration for the current source, if available.

Remarks


- The initial value will be based on BaseSource.latencyConfiguration
- If BaseSource.latencyConfiguration is not set, the player will determine the configuration for your live stream.
- The player might change the latency configuration based on playback events like stalls.

Readonly currentLatency

currentLatency: undefined | number

The current latency.

Remarks


- Only available during live playback.

enabled

enabled: boolean

Whether the latency manager is enabled.

Remarks


- Can only be enabled for live playback.

Readonly monitoringLivePlayback

monitoringLivePlayback: boolean

Whether the latency manager is monitoring to stay within the live playback configuration.

Settings

Member Visibility

Theme

On This Page

currentConfigurationcurrentLatencyenabledmonitoringLivePlayback