THEOplayer Web SDK
    Preparing search index...

    Interface CmcdConfiguration

    Describes the CMCD (Common Media Client Data) configuration for event mode reporting at the player 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 configuration is set at the player level. For source-level configuration, see CmcdSourceConfiguration.
    - When casting to a THEOplayer Chromecast CAF receiver, this configuration is forwarded to the receiver, which then reports its own CMCD session for the cast media in event mode (with platform theoplayer-caf). Available since v11.13.0.

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

    Hierarchy (View Summary)

    Index
    eventEndpoints? externalSessionId? userId?
    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.

    userId?: string

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

    Settings
    Member Visibility

    On This Page
    Properties