public final class

DefaultDrmSessionManager.Builder

extends java.lang.Object

 java.lang.Object

↳androidx.media3.exoplayer.drm.DefaultDrmSessionManager.Builder

Overview

Builder for DefaultDrmSessionManager instances.

See DefaultDrmSessionManager.Builder for the list of default values.

Summary

Constructors
publicBuilder()

Creates a builder with default values.

Methods
public DefaultDrmSessionManagerbuild(MediaDrmCallback mediaDrmCallback)

Builds a DefaultDrmSessionManager instance.

public DefaultDrmSessionManager.BuildersetKeyRequestParameters(java.util.Map<java.lang.String, java.lang.String> keyRequestParameters)

Sets the key request parameters to pass as the last argument to ExoMediaDrm.getKeyRequest(byte[], List, int, HashMap).

public DefaultDrmSessionManager.BuildersetLoadErrorHandlingPolicy(LoadErrorHandlingPolicy loadErrorHandlingPolicy)

Sets the LoadErrorHandlingPolicy for key and provisioning requests.

public DefaultDrmSessionManager.BuildersetMultiSession(boolean multiSession)

Sets whether this session manager is allowed to acquire multiple simultaneous sessions.

public DefaultDrmSessionManager.BuildersetPlayClearSamplesWithoutKeys(boolean playClearSamplesWithoutKeys)

Sets whether clear samples within protected content should be played when keys for the encrypted part of the content have yet to be loaded.

public DefaultDrmSessionManager.BuildersetSessionKeepaliveMs(long sessionKeepaliveMs)

Sets the time to keep DrmSessions alive when they're not in use.

public DefaultDrmSessionManager.BuildersetUseDrmSessionsForClearContent(int[] useDrmSessionsForClearContentTrackTypes[])

Sets whether this session manager should attach DrmSessions to the clear sections of the media content.

public DefaultDrmSessionManager.BuildersetUuidAndExoMediaDrmProvider(java.util.UUID uuid, ExoMediaDrm.Provider exoMediaDrmProvider)

Sets the UUID of the DRM scheme and the ExoMediaDrm.Provider to use.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Builder()

Creates a builder with default values. The default values are:

Methods

public DefaultDrmSessionManager.Builder setKeyRequestParameters(java.util.Map<java.lang.String, java.lang.String> keyRequestParameters)

Sets the key request parameters to pass as the last argument to ExoMediaDrm.getKeyRequest(byte[], List, int, HashMap). May be null if not parameters need to be passed.

Custom data for PlayReady should be set under DefaultDrmSessionManager.PLAYREADY_CUSTOM_DATA_KEY.

Parameters:

keyRequestParameters: A map with parameters.

Returns:

This builder.

public DefaultDrmSessionManager.Builder setUuidAndExoMediaDrmProvider(java.util.UUID uuid, ExoMediaDrm.Provider exoMediaDrmProvider)

Sets the UUID of the DRM scheme and the ExoMediaDrm.Provider to use.

Parameters:

uuid: The UUID of the DRM scheme.
exoMediaDrmProvider: The ExoMediaDrm.Provider.

Returns:

This builder.

public DefaultDrmSessionManager.Builder setMultiSession(boolean multiSession)

Sets whether this session manager is allowed to acquire multiple simultaneous sessions.

Users should pass false when a single key request will obtain all keys required to decrypt the associated content. multiSession is required when content uses key rotation.

Parameters:

multiSession: Whether this session manager is allowed to acquire multiple simultaneous sessions.

Returns:

This builder.

public DefaultDrmSessionManager.Builder setUseDrmSessionsForClearContent(int[] useDrmSessionsForClearContentTrackTypes[])

Sets whether this session manager should attach DrmSessions to the clear sections of the media content.

Using DrmSessions for clear content avoids the recreation of decoders when transitioning between clear and encrypted sections of content.

Parameters:

useDrmSessionsForClearContentTrackTypes: The track types (C.TRACK_TYPE_AUDIO and/or C.TRACK_TYPE_VIDEO) for which to use a DrmSession regardless of whether the content is clear or encrypted.

Returns:

This builder.

public DefaultDrmSessionManager.Builder setPlayClearSamplesWithoutKeys(boolean playClearSamplesWithoutKeys)

Sets whether clear samples within protected content should be played when keys for the encrypted part of the content have yet to be loaded.

Parameters:

playClearSamplesWithoutKeys: Whether clear samples within protected content should be played when keys for the encrypted part of the content have yet to be loaded.

Returns:

This builder.

public DefaultDrmSessionManager.Builder setLoadErrorHandlingPolicy(LoadErrorHandlingPolicy loadErrorHandlingPolicy)

Sets the LoadErrorHandlingPolicy for key and provisioning requests.

Parameters:

loadErrorHandlingPolicy: A LoadErrorHandlingPolicy.

Returns:

This builder.

public DefaultDrmSessionManager.Builder setSessionKeepaliveMs(long sessionKeepaliveMs)

Sets the time to keep DrmSessions alive when they're not in use.

It can be useful to keep sessions alive during playback of short clear sections of media (e.g. ad breaks) to avoid opening new DRM sessions (and re-requesting keys) at the transition back into secure content. This assumes the secure sections before and after the clear section are encrypted with the same keys.

Defaults to DefaultDrmSessionManager.DEFAULT_SESSION_KEEPALIVE_MS. Pass C.TIME_UNSET to disable keep-alive.

Parameters:

sessionKeepaliveMs: The time to keep DrmSessions alive before fully releasing, in milliseconds. Must be > 0 or C.TIME_UNSET to disable keep-alive.

Returns:

This builder.

public DefaultDrmSessionManager build(MediaDrmCallback mediaDrmCallback)

Builds a DefaultDrmSessionManager instance.