THEOplayer Web SDK
    Preparing search index...

    Interface CmcdSourceConfiguration

    Describes the CMCD (Common Media Client Data) configuration for event mode reporting at the source level.


    - Available since v11.4.0.
    - This configuration is only used for event mode reporting only, for now. For request mode, you should use the CMCD connector on GitHub (https://github.com/THEOplayer/web-connectors/tree/main/cmcd).
    - This extends the player-level CmcdConfiguration by additionally allowing a session ID to be specified per source. Source-level values take precedence over player-level values for overlapping fields, except for eventEndpoints which are merged (both player and source endpoints receive events).

    interface CmcdSourceConfiguration {
        eventEndpoints?: CmcdEndpointConfiguration[];
        externalSessionId?: string;
        sessionId?: string;
        userId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    eventEndpoints? externalSessionId? sessionId? userId?

    Properties

    eventEndpoints?: CmcdEndpointConfiguration[]

    A list of CMCD endpoints to which events should be sent.

    externalSessionId?: string

    An external session ID that can be used to identify the current playback session.

    sessionId?: string

    A GUID identifying the current playback session.

    A playback session typically consists of the playback of a single media asset along with accompanying content such as advertisements. This session may comprise the playback of primary content combined with interstitial content. This session is being played on a single device. The maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification (https://tools.ietf.org/html/rfc4122).

    userId?: string

    A user ID that can be used to identify the user.

    Settings

    Member Visibility

    On This Page

    Properties