Interface LatencyManager

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

interface LatencyManager {
    configuration: LatencyConfiguration;
    currentLatency: undefined | number;
    enabled: boolean;
    streamConfiguration: undefined | Partial<Readonly<LatencyConfiguration>>;
}

Properties

configuration currentLatency enabled streamConfiguration

Properties

Readonly configuration

configuration: LatencyConfiguration

Can be used to set a custom values for chasing live playback.

Remarks


- The player might change the set values based on the streamConfiguration.
- This configuration is reset every time the player source changes.

Readonly currentLatency

currentLatency: undefined | number

The current latency.

Remarks


- Only available during live playback.

enabled

enabled: boolean

Whether the latency manager is enabled and is chasing live playback.

Remarks


- Can only be enabled during live playback.
- Only available for HESP sources.

Readonly streamConfiguration

streamConfiguration: undefined | Partial<Readonly<LatencyConfiguration>>

The LatencyConfiguration of the current source, if available.

Remarks


- Only available during live playback.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc