Interface TheoLiveApi

The THEOlive api.

interface TheoLiveApi {
    authToken: undefined | string;
    badNetworkMode: boolean;
    addEventListener<TType extends keyof TheoLiveApiEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<TheoLiveApiEventMap[TType]>,
    ): void;
    preloadPublications(
        publicationIds: string[],
    ): Promise<TheoLivePublication[]>;
    removeEventListener<TType extends keyof TheoLiveApiEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<TheoLiveApiEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<TheoLiveApiEventMap>
- TheoLiveApi

Index

Properties

authToken badNetworkMode

Methods

addEventListener preloadPublications removeEventListener

Properties

authToken

authToken: undefined | string

Get or set the auth token that will be used when requesting a manifest or segment.

badNetworkMode

badNetworkMode: boolean

Methods

addEventListener

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

preloadPublications

preloadPublications(publicationIds: string[]): Promise<TheoLivePublication[]>
Parameters
- publicationIds: string[]
Returns Promise<TheoLivePublication[]>

removeEventListener

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