Player setup
Since which version each player supports CMCD v1 and v2, which transmission mode to choose and where the EINBLIQ.IO CMCD v2 endpoint goes.
Updated
For the reporting concepts, read CMCD explained. To inspect Request Mode and Event Mode reports, try the CMCD v2 live demo.
Support overview
| Player | CMCD v1 since | CMCD v2 since |
|---|---|---|
| dash.js | 3.2.0 | 5.2.0 |
| hls.js | 1.1.0 | 1.7.0 |
| Shaka Player | 3.3.0 | 4.16.0 |
| Bitmovin Player | Web with the CMCD integration, Android 3.153.0, iOS 3.104.0 | Not known |
| Media3 (ExoPlayer) | 1.1.0 | In development |
| Apple AVPlayer | iOS 18, tvOS 18, macOS 15 | Not known |
| Roku | In use since at least May 2023 | Not known |
| AAMP (RDK) | 5.3 | Not known |
Sending CMCD: query parameter or headers
CMCD can be sent in two ways: as the CMCD query parameter or in the HTTP headers CMCD-Request, CMCD-Object, CMCD-Status and CMCD-Session.
Some native players can only send headers: Apple AVPlayer, Roku and AAMP use CMCD headers exclusively, and Media3 uses headers unless configured otherwise. Each player guide lists the player’s default transmission mode, and the CDN guides explain how to log headers where the CDN supports it.
CMCD custom key repository
Since its first version, CMCD has allowed custom keys for information that the specification does not register. The CMCD custom key repository, hosted by the SVTA and maintained by EINBLIQ.IO, collects such keys in a shared registry, so that players and analytics services name and interpret them the same way.
Each key follows the pattern <reverseDNS>-<namespaceAbbr>-<fieldAbbr>, for example org.svta-p-n for the player name. The registry defines the value, its type and the CMCD header each key belongs to, with keys for areas such as the application, content, device and player. To propose a new key, open an issue with the Propose a custom key template in the repository.
CMCD v2 event targets
EINBLIQ.IO provides a CMCD v2 endpoint for event mode. Its address is shared during onboarding and replaces <CMCD_V2_ENDPOINT> in the player examples.
| Player | Where the endpoint goes |
|---|---|
| dash.js | streaming.cmcd.eventTargets[].url |
| hls.js | cmcd.eventTargets[].url |
| Shaka Player | cmcd.eventTargets[].url (experimental) |
| Bitmovin Player, Media3, AVPlayer, Roku, AAMP | No event mode yet |
Event reports reach the endpoint as HTTP POST requests with the content type application/cmcd.
Guides by player
- dash.jsCMCD v1 and both v2 modes, configured through
updateSettings. - hls.jsCMCD v1 and both v2 modes in the full build.
- Shaka PlayerCMCD v1 and partial, experimental CMCD v2.
- Bitmovin PlayerCMCD v1 on Web, Android and iOS.
- Media3 (ExoPlayer)CMCD v1 with query mode selected explicitly.
- Apple AVPlayerCMCD v1 for HLS, sent as headers only.
- RokuCMCD v1 on by default, nothing to configure.
- AAMP (RDK)CMCD v1 as headers, on by default.