tv.danmaku.ijk.media.drm

Class DefaultDrmSessionManager.Builder

java.lang.Object

tv.danmaku.ijk.media.drm.DefaultDrmSessionManager.Builder

Enclosing class:

DefaultDrmSessionManager

public static final class DefaultDrmSessionManager.Builder
extends java.lang.Object

Builder for DefaultDrmSessionManager instances.

See Builder() for the list of default values.

Constructor Summary

Constructors

Constructor and Description
Builder() Creates a builder with default values.

Method Summary

Modifier and Type	Method and Description
DefaultDrmSessionManager	build(MediaDrmCallback mediaDrmCallback) Builds a DefaultDrmSessionManager instance.
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).
DefaultDrmSessionManager.Builder	setMultiSession(boolean multiSession) Sets whether this session manager is allowed to acquire multiple simultaneous sessions.
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.
DefaultDrmSessionManager.Builder	setSessionKeepaliveMs(long sessionKeepaliveMs) Sets the time to keep DrmSessions alive when they're not in use.
DefaultDrmSessionManager.Builder	setUseDrmSessionsForClearContent(int... useDrmSessionsForClearContentTrackTypes) Sets whether this session manager should attach DrmSessions to the clear sections of the media content.
DefaultDrmSessionManager.Builder	setUuidAndExoMediaDrmProvider(java.util.UUID uuid, ExoMediaDrm.Provider exoMediaDrmProvider) Sets the UUID of the DRM scheme and the ExoMediaDrm.Provider to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

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

• keyRequestParameters: An empty map.
• UUID: C.WIDEVINE_UUID.
• ExoMediaDrm.Provider: FrameworkMediaDrm.DEFAULT_PROVIDER.
• multiSession: false.
• useDrmSessionsForClearContent: No tracks.
• playClearSamplesWithoutKeys: false.

Method Detail

setKeyRequestParameters

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.

setUuidAndExoMediaDrmProvider

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.

setMultiSession

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.

setUseDrmSessionsForClearContent

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.

Throws:

java.lang.IllegalArgumentException - If useDrmSessionsForClearContentTrackTypes contains track types other than C.TRACK_TYPE_AUDIO and C.TRACK_TYPE_VIDEO.

setPlayClearSamplesWithoutKeys

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.

setSessionKeepaliveMs

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.

build

public DefaultDrmSessionManager build(MediaDrmCallback mediaDrmCallback)

Builds a DefaultDrmSessionManager instance.