Media3 (ExoPlayer)

Media3 supports CMCD v1 and sends headers by default. Select query mode explicitly.

Updated

Support

CMCD Media3 (ExoPlayer) 1.11.1
CMCD v1 since 1.1.0
CMCD v2 since In development
Default transmission Header
On by default No

Media3 supports CMCD v1 for DASH, HLS and SmoothStreaming. Up to 1.1.1 it sent headers only; query parameters are available since 1.2.0. CMCD v2 is in development (androidx/media#2732).

Configuration

The default transmission mode is headers, so select query mode explicitly:

Kotlin
val cmcdFactory = CmcdConfiguration.Factory { mediaItem ->
  CmcdConfiguration(
    UUID.randomUUID().toString(),
    mediaItem.mediaId,
    object : CmcdConfiguration.RequestConfig {
      override fun getCustomData(): ImmutableListMultimap<@CmcdConfiguration.HeaderKey String, String> =
        ImmutableListMultimap.of(
          CmcdConfiguration.KEY_CMCD_SESSION, "org.svta-p-n=\"Media3\"",
          CmcdConfiguration.KEY_CMCD_SESSION, "org.svta-p-v=\"${MediaLibraryInfo.VERSION}\"",
        )
    },
    CmcdConfiguration.MODE_QUERY_PARAMETER,
  )
}

val player = ExoPlayer.Builder(context)
  .setMediaSourceFactory(
    DefaultMediaSourceFactory(context).setCmcdConfigurationFactory(cmcdFactory),
  )
  .build()
  • The example generates a random session ID (java.util.UUID) and uses the media ID as content ID, as CmcdConfiguration.Factory.DEFAULT does. Both are limited to 64 characters.
  • getCustomData() adds org.svta-p-n and org.svta-p-v for the player name and version, as defined in the CMCD custom key repository. Each entry is a preformatted key=value pair; string values must be quoted. MediaLibraryInfo.VERSION is the Media3 version.

Media3 CMCD documentation