ExoPlayer uses Android's MediaDrm
API to support DRM-protected playback.
The minimum Android versions required for different supported DRM schemes, along
with the streaming formats for which they're supported, are described in the
following table:
DRM scheme | Android version number | Android API level | Supported formats |
---|---|---|---|
Widevine "cenc" | 4.4 | 19 | DASH, HLS (FMP4 only) |
Widevine "cbcs" | 7.1 | 25 | DASH, HLS (FMP4 only) |
ClearKey "cenc" | 5.0 | 21 | DASH |
PlayReady SL2000 "cenc" | Android TV | Android TV | DASH, SmoothStreaming, HLS (FMP4 only) |
In order to play DRM-protected content with ExoPlayer, the UUID of the DRM
system must be specified
when building a media item, and other
properties can also be provided. The player will then use these properties to
build a default implementation of DrmSessionManager
, called
DefaultDrmSessionManager
, that's suitable for most use cases. For some use
cases, additional DRM properties may be necessary, as outlined in the following
sections.
Key rotation
To play streams with rotating keys, pass true
to
MediaItem.DrmConfiguration.Builder.setMultiSession
when building the media
item.
Multi-key content
Multi-key content consists of multiple streams, where some streams use different keys than others. Multi-key content can be played in one of two ways, depending on how the license server is configured.
Case 1: License server responds with all keys for the content
In this case, the license server is configured so that when it receives a request for one key, it responds with all keys for the content. This case is handled by ExoPlayer without the need for any special configuration. Adaptation between streams (e.g. SD and HD video) is seamless even if they use different keys.
Where possible, we recommend configuring your license server to behave in this way. It's the most efficient and robust way to support playback of multikey content, because it doesn't require the client to make multiple license requests to access the different streams.
Case 2: License server responds with requested key only
In this case, the license server is configured to respond with only the key
specified in the request. Multi-key content can be played with this license
server configuration by passing true
to
MediaItem.DrmConfiguration.Builder.setMultiSession
when building the media
item.
We do not recommend configuring your license server to behave in this way. It requires extra license requests to play multi-key content, which is less efficient and robust than the alternative described above.
Offline keys
An offline key set can be loaded by passing the key set ID to
MediaItem.DrmConfiguration.Builder.setKeySetId
when building the media item.
This allows playback using the keys stored in the offline key set with the
specified ID.
DRM sessions for clear content
Use of placeholder DrmSessions
allows ExoPlayer
to use the same decoders for
clear content as are used when playing encrypted content. When media contains
both clear and encrypted sections, you may want to use placeholder DrmSessions
to avoid re-creation of decoders when transitions between clear and encrypted
sections occur. Use of placeholder DrmSessions
for audio and video tracks can
be enabled by passing true
to
MediaItem.DrmConfiguration.Builder.forceSessionsForAudioAndVideoTracks
when
building the media item.
Using a custom DrmSessionManager
If an app wants to customise the DrmSessionManager
used for playback, they can
implement a DrmSessionManagerProvider
and pass this to the
MediaSource.Factory
which is used when building the player. The provider can
choose whether to instantiate a new manager instance each time or not. To always
use the same instance:
Kotlin
val customDrmSessionManager: DrmSessionManager = CustomDrmSessionManager() // Pass a drm session manager provider to the media source factory. val mediaSourceFactory = DefaultMediaSourceFactory(context).setDrmSessionManagerProvider { customDrmSessionManager }
Java
DrmSessionManager customDrmSessionManager = new CustomDrmSessionManager(/* ... */ ); // Pass a drm session manager provider to the media source factory. MediaSource.Factory mediaSourceFactory = new DefaultMediaSourceFactory(context) .setDrmSessionManagerProvider(mediaItem -> customDrmSessionManager);
Improving playback performance
If you're experiencing video stuttering when playing DRM-protected content on a device running any version of Android from Android 6.0 (API level 23) up to and including Android 11 (API level 30), you can try enabling asynchronous buffer queueing.