DefaultDrmSessionManager.Builder

public final class DefaultDrmSessionManager.Builder


Builder for DefaultDrmSessionManager instances.

See Builder for the list of default values.

Summary

Public constructors

Creates a builder with default values.

Public methods

DefaultDrmSessionManager
build(MediaDrmCallback mediaDrmCallback)

Builds a DefaultDrmSessionManager instance.

DefaultDrmSessionManager.Builder

Sets the key request parameters to pass as the last argument to getKeyRequest.

DefaultDrmSessionManager.Builder

Sets the LoadErrorHandlingPolicy for key and provisioning requests.

DefaultDrmSessionManager.Builder
@CanIgnoreReturnValue
setMultiSession(boolean multiSession)

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

DefaultDrmSessionManager.Builder
@CanIgnoreReturnValue
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.

DefaultDrmSessionManager.Builder

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

DefaultDrmSessionManager.Builder
@CanIgnoreReturnValue
setUseDrmSessionsForClearContent(
    @C.TrackType int[] useDrmSessionsForClearContentTrackTypes
)

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

DefaultDrmSessionManager.Builder

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

Public constructors

Builder

public Builder()

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

Public methods

build

public DefaultDrmSessionManager build(MediaDrmCallback mediaDrmCallback)

Builds a DefaultDrmSessionManager instance.

setKeyRequestParameters

@CanIgnoreReturnValue
public DefaultDrmSessionManager.Builder setKeyRequestParameters(
    @Nullable Map<StringString> keyRequestParameters
)

Sets the key request parameters to pass as the last argument to getKeyRequest. May be null if not parameters need to be passed.

Custom data for PlayReady should be set under PLAYREADY_CUSTOM_DATA_KEY.

Parameters
@Nullable Map<StringString> keyRequestParameters

A map with parameters.

Returns
DefaultDrmSessionManager.Builder

This builder.

setLoadErrorHandlingPolicy

@CanIgnoreReturnValue
public DefaultDrmSessionManager.Builder setLoadErrorHandlingPolicy(
    LoadErrorHandlingPolicy loadErrorHandlingPolicy
)

Sets the LoadErrorHandlingPolicy for key and provisioning requests.

Parameters
LoadErrorHandlingPolicy loadErrorHandlingPolicy

A LoadErrorHandlingPolicy.

Returns
DefaultDrmSessionManager.Builder

This builder.

setMultiSession

@CanIgnoreReturnValue
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
boolean multiSession

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

Returns
DefaultDrmSessionManager.Builder

This builder.

setPlayClearSamplesWithoutKeys

@CanIgnoreReturnValue
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
boolean 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
DefaultDrmSessionManager.Builder

This builder.

setSessionKeepaliveMs

@CanIgnoreReturnValue
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 DEFAULT_SESSION_KEEPALIVE_MS. Pass TIME_UNSET to disable keep-alive.

Parameters
long sessionKeepaliveMs

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

Returns
DefaultDrmSessionManager.Builder

This builder.

setUseDrmSessionsForClearContent

@CanIgnoreReturnValue
public DefaultDrmSessionManager.Builder setUseDrmSessionsForClearContent(
    @C.TrackType 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
@C.TrackType int[] useDrmSessionsForClearContentTrackTypes

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

Returns
DefaultDrmSessionManager.Builder

This builder.

Throws
java.lang.IllegalArgumentException

If useDrmSessionsForClearContentTrackTypes contains track types other than TRACK_TYPE_AUDIO and TRACK_TYPE_VIDEO.

setUuidAndExoMediaDrmProvider

@CanIgnoreReturnValue
public DefaultDrmSessionManager.Builder setUuidAndExoMediaDrmProvider(
    UUID uuid,
    ExoMediaDrm.Provider exoMediaDrmProvider
)

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

Parameters
UUID uuid

The UUID of the DRM scheme.

ExoMediaDrm.Provider exoMediaDrmProvider

The ExoMediaDrm.Provider.

Returns
DefaultDrmSessionManager.Builder

This builder.