THEOplayer Web SDK Connectors
    Preparing search index...

    Class CMCDConnector

    The connector between a THEOplayer Player instance and a Common Media Client Data (CMCD) server. This implementation supports CMCD data as defined in CTA-5004, published in September 2020.

    Note that when native playback is being used, either through THEOplayer's configuration, or due to absence of MSE/EME APIs (such as on iOS Safari), the TransmissionMode.JSON_OBJECT should be used.

    All standardized reserved keys are reported, except:

    • Object duration (d)
    • Next object request (nor)
    • Next range request (nrr)
    Index

    Constructors

    Accessors

    Methods

    Constructors

    Accessors

    • get processor(): undefined | CMCDPayloadProcessor

      Returns the current processor which will be called before transmitting any CMCD payload, or undefined if no processor is known.

      Returns undefined | CMCDPayloadProcessor

    • set processor(value: undefined | CMCDPayloadProcessor): void

      Modifies the current processor which will be called before transmitting any CMCD payload data. This value can be set to undefined to remove the current processor.

      Parameters

      • value: undefined | CMCDPayloadProcessor

        The processor which must be used for any subsequent payload about to be transmitted or undefined if no processor is to be used.

      Returns void

    Methods

    • Resets the configuration of the connector. The connector will halt all transmissions and new transmissions will be made as per the updated configuration. If no new session ID is provided, the previous session ID will be reused.

      Parameters

      Returns void