Shaka Player

Shaka Player supports CMCD v1 as stable. CMCD v2 and its event targets are labelled experimental.

Updated

Support

CMCD Shaka Player 5.3.5
CMCD v1 since 3.3.0
CMCD v2 since 4.16.0
Default transmission Query parameter
On by default No

CMCD v2 support grew over several releases: 4.13.0 added the version setting and the first two CMCD v2 keys (ltc, msd), and 4.16.0 added event mode and response mode, so CMCD v2 is usable from 4.16.0. Current versions define all CMCD v2 event types, from bc (bitrate change) to ce (custom event). Shaka labels CMCD v2 and its event targets as experimental, so the field names may still change.

Configuration

JavaScript
player.configure({
  cmcd: {
    enabled: true,
    version: 2,
    contentId: '<CONTENT_ID>',
    eventTargets: [
      {
        url: '<CMCD_V2_ENDPOINT>',
        events: ['ps', 'e', 't'],
      },
    ],
  },
});
  • Shaka sends query parameters by default; set useHeaders: true to send headers instead.
  • Without includeKeys, Shaka sends all keys of the configured version, in requests and in event reports.
  • Without sessionId, Shaka generates a new UUID for each load(). Set contentId only if you know the content ID.
  • An event target needs at least one entry in events; t sends a status report every 30 seconds by default.
  • Shaka Player has no option for custom keys, so player name and version cannot be sent as custom keys.
  • <CMCD_V2_ENDPOINT> is the address of the EINBLIQ.IO CMCD v2 endpoint, provided during onboarding.

Shaka Player CMCD configuration