THEOplayer Web SDK
    Preparing search index...

    Interface TheoLiveConfiguration

    A configuration to configure THEOlive playback.

    interface TheoLiveConfiguration {
        discoveryHeader?: string;
        discoveryUrl?: string;
        discoveryUrls?: string[];
        externalSessionId?: string;
        fallbackEnabled?: boolean;
    }
    Index
    discoveryHeader? discoveryUrl? discoveryUrls? externalSessionId? fallbackEnabled?
    discoveryHeader?: string

    A value that is sent in the x-theolive-discovery HTTP header of every discovery request.


    - The header is only sent when this property is set.

    discoveryUrl?: string

    A discovery URL that is tried before the built-in THEOlive discovery URLs.


    - Use this to pin the player to a single discovery API version, and skip the failed requests that occur when a channel is not available on a built-in discovery URL that is tried earlier.
    - The API version is derived from the URL: https://<host>/ is V1, https://<host>/v2/ is V2 and https://<host>/v3/ is V3. A trailing channels/ or distributions/ segment is ignored.
    - Takes precedence over TheoLiveConfiguration.discoveryUrls.

    const player = new THEOplayer.Player(element, {
        libraryLocation: '/path/to/theoplayer/',
        license: 'your-license',
        theoLive: {
            discoveryUrl: 'https://discovery.theo.live/v2/'
        }
    });
    discoveryUrls?: string[]

    A list of discovery URLs that are tried, in order, before the built-in THEOlive discovery URLs.


    - Each URL follows the same rules as TheoLiveConfiguration.discoveryUrl.
    - Tried after TheoLiveConfiguration.discoveryUrl, if configured.

    externalSessionId?: string

    An id used to report usage analytics, if not explicitly given a random UUID is used.

    Use CmcdConfiguration.externalSessionId instead.

    fallbackEnabled?: boolean

    Whether this player should fall back or not when it has a fallback configured.

    Settings
    Member Visibility

    On This Page
    Properties