Interface HespLatencyConfiguration

A latency configuration object for managing the live offset of the player. The buffer end is seen as the live point, so the live offset is defined as the difference between the buffer end and the current time.

Remarks


- Note: This API is in an experimental stage and may be subject to breaking changes.
- Only available with the feature 'hesp'.
- Only applies to HESP streams.

interface HespLatencyConfiguration {
    maxOffset: number;
    target: number;
    windowEnd: number;
    windowStart: number;
}

Properties

maxOffset target windowEnd windowStart

Properties

Readonly maxOffset

maxOffset: number

The live offset at which the player will automatically trigger a live seek.

Readonly target

target: number

The live offset that the player will aim for. When correcting the offset by tuning the playbackRate, the player will stop correcting when it reaches this value.

Readonly windowEnd

windowEnd: number

The end of the target live window. If the live offset becomes higher than this value, the player will speed up.

Readonly windowStart

windowStart: number

The start of the target live window. If the live offset becomes smaller than this value, the player will slow down.

Settings

Member Visibility

Theme

On This Page

maxOffsettargetwindowEndwindowStart