THEOplayer Web SDK
    Preparing search index...

    Interface TheoLiveApi

    The THEOlive api.

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

    Hierarchy (View Summary)

    Index

    Properties

    authToken badNetworkMode

    Methods

    addEventListener removeEventListener

    Properties

    authToken: string | undefined

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

    badNetworkMode: boolean

    When set to true, the player enters "bad network mode" and will immediately switch to the lowest quality. Once the network conditions improve, the player will automatically switch to a better quality and exit bad network mode.

    Bad network mode is no longer supported, and this API is now a no-op. It will be removed in the next major version.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods