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 {
    isLive: boolean;
    manifest: undefined | Object;
    addEventListener<TType extends keyof HespApiEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<HespApiEventMap[TType]>,
    ): void;
    goLive(): void;
    removeEventListener<TType extends keyof HespApiEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<HespApiEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<HespApiEventMap>
- HespApi

Index

Properties

isLive manifest

Methods

addEventListener goLive removeEventListener

Properties

`Readonly`isLive

isLive: boolean

True if the HESP playback is in live mode.

`Readonly`manifest

manifest: undefined | Object

Returns the manifest for the current HESP source.

Remarks

- Undefined if no HESP source is configured.

Methods

addEventListener

addEventListener<TType extends keyof HespApiEventMap>(
type: TType | readonly TType[],
listener: EventListener<HespApiEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends keyof HespApiEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<HespApiEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

goLive

goLive(): void
Seeks the player to the live point.

Returns void
Remarks

- Only works during HESP playback.

removeEventListener

removeEventListener<TType extends keyof HespApiEventMap>(
type: TType | readonly TType[],
listener: EventListener<HespApiEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends keyof HespApiEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<HespApiEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener