Interface HespApi

The HESP API.

Remarks


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

interface HespApi {
    currentLatency: undefined | number;
    currentServerLiveTime: undefined | number;
    isLive: boolean;
    latency: HespLatencyConfiguration;
    manifest: undefined | Object;
    addEventListener<TType>(type, listener): void;
    goLive(): void;
    removeEventListener<TType>(type, listener): void;
}

Hierarchy (view full)

Properties

currentLatency: undefined | number

The current latency measured between the currentServerLiveTime and client's currentTime. This can be undefined if no currentServerLiveTime is available. This value should be accurate up to the largest of a frame duration or a RTT.

currentServerLiveTime: undefined | number

The currentTime equivalent of the latest frame generated on the HESP server. This can be undefined if no suitable estimate is available. This value should be accurate up to the largest of a frame duration or a RTT.

isLive: boolean

True if the HESP playback is in live mode.

Can be set to change the latency of the player. A HespLatencyConfiguration object which gives latency configuration of the player.

Deprecated

use ChromelessPlayer.latency instead

manifest: undefined | Object

Returns the manifest for the current HESP source.

Remarks


- Undefined if no HESP source is configured.

Methods

  • Seeks the player to the live point.

    Returns void

    Remarks


    - Only works during HESP playback.