Creates a new connector for the given player, following the provided configuration. If no session ID is provided, the session ID will be set to a random UUIDv4.
The THEOplayer.Player instance for which common media client data is to be reported.
Optional configuration: ConfigurationThe Configuration detailing how the data is to be logged. When no configuration is provided, the TransmissionMode.QUERY_ARGUMENT transmission mode will be used in order to avoid CORS preflight requests in browsers.
Returns the current processor which will be called before transmitting any CMCD payload, or undefined if no processor is known.
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.
The processor which must be used for any subsequent payload about to be transmitted or undefined if
no processor is to be used.
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.
Optional configuration: ConfigurationThe Configuration detailing how the data is to be logged. When no configuration is provided, the TransmissionMode.QUERY_ARGUMENT transmission mode will be used in order to avoid CORS preflight requests in browsers.
Generated using TypeDoc
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: