Interface HespApi

The HESP API.


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

interface HespApi {
    isLive: boolean;
    manifest: undefined | Object;
    addEventListener<TType>(type: TType | readonly TType[], listener: EventListener<HespApiEventMap[TType]>): void;
    goLive(): void;
    removeEventListener<TType>(type: TType | readonly TType[], listener: EventListener<HespApiEventMap[TType]>): void;
}

Hierarchy (view full)

Properties

isLive: boolean

True if the HESP playback is in live mode.

manifest: undefined | Object

Returns the manifest for the current HESP source.


- Undefined if no HESP source is configured.

Methods

  • Seeks the player to the live point.

    Returns void


    - Only works during HESP playback.