com.google.android.exoplayer2.drm

Class DefaultDrmSessionManager<T extends ExoMediaCrypto>

java.lang.Object

com.google.android.exoplayer2.drm.DefaultDrmSessionManager<T>

All Implemented Interfaces:

DrmSession<T>, DrmSessionManager<T>

public class DefaultDrmSessionManager<T extends ExoMediaCrypto>
extends java.lang.Object
implements DrmSessionManager<T>, DrmSession<T>

A DrmSessionManager that supports playbacks using MediaDrm.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultDrmSessionManager.EventListener Listener of DefaultDrmSessionManager events.
static interface	DefaultDrmSessionManager.Mode Determines the action to be done after a session acquired.

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.drm.DrmSession

DrmSession.DrmSessionException, DrmSession.State

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_DOWNLOAD Downloads an offline license or renews an existing one.
static int	MODE_PLAYBACK Loads and refreshes (if necessary) a license for playback.
static int	MODE_QUERY Restores an offline license to allow its status to be queried.
static int	MODE_RELEASE Releases an existing offline license.
static java.lang.String	PLAYREADY_CUSTOM_DATA_KEY The key to use when passing CustomData to a PlayReady instance in an optional parameter map.

Fields inherited from interface com.google.android.exoplayer2.drm.DrmSession

STATE_ERROR, STATE_OPENED, STATE_OPENED_WITH_KEYS, STATE_OPENING, STATE_RELEASED

Constructor Summary

Constructors

Constructor and Description
DefaultDrmSessionManager(java.util.UUID uuid, ExoMediaDrm<T> mediaDrm, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, DefaultDrmSessionManager.EventListener eventListener)

Method Summary

Modifier and Type	Method and Description
DrmSession<T>	acquireSession(android.os.Looper playbackLooper, DrmInitData drmInitData) Acquires a DrmSession for the specified DrmInitData.
boolean	canAcquireSession(DrmInitData drmInitData) Returns whether the manager is capable of acquiring a session for the given DrmInitData.
DrmSession.DrmSessionException	getError() Returns the cause of the error state.
T	getMediaCrypto() Returns a ExoMediaCrypto for the open session, or null if called before the session has been opened or after it's been released.
byte[]	getOfflineLicenseKeySetId() Returns the key set id of the offline license loaded into this session, or null if there isn't one.
byte[]	getPropertyByteArray(java.lang.String key) Provides access to MediaDrm.getPropertyByteArray(String).
java.lang.String	getPropertyString(java.lang.String key) Provides access to MediaDrm.getPropertyString(String).
int	getState() Returns the current state of the session, which is one of DrmSession.STATE_ERROR, DrmSession.STATE_RELEASED, DrmSession.STATE_OPENING, DrmSession.STATE_OPENED and DrmSession.STATE_OPENED_WITH_KEYS.
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newFrameworkInstance(java.util.UUID uuid, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, DefaultDrmSessionManager.EventListener eventListener) Instantiates a new instance.
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newPlayReadyInstance(MediaDrmCallback callback, java.lang.String customData, android.os.Handler eventHandler, DefaultDrmSessionManager.EventListener eventListener) Instantiates a new instance using the PlayReady scheme.
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newWidevineInstance(MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, DefaultDrmSessionManager.EventListener eventListener) Instantiates a new instance using the Widevine scheme.
java.util.Map<java.lang.String,java.lang.String>	queryKeyStatus() Returns a map describing the key status for the session, or null if called before the session has been opened or after it's been released.
void	releaseSession(DrmSession<T> session) Releases a DrmSession.
void	setMode(int mode, byte[] offlineLicenseKeySetId) Sets the mode, which determines the role of sessions acquired from the instance.
void	setPropertyByteArray(java.lang.String key, byte[] value) Provides access to MediaDrm.setPropertyByteArray(String, byte[]).
void	setPropertyString(java.lang.String key, java.lang.String value) Provides access to MediaDrm.setPropertyString(String, String).

Methods inherited from class java.lang.Object

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

Field Detail

PLAYREADY_CUSTOM_DATA_KEY

public static final java.lang.String PLAYREADY_CUSTOM_DATA_KEY

The key to use when passing CustomData to a PlayReady instance in an optional parameter map.

See Also:

Constant Field Values

MODE_PLAYBACK

public static final int MODE_PLAYBACK

Loads and refreshes (if necessary) a license for playback. Supports streaming and offline licenses.

See Also:

Constant Field Values

MODE_QUERY

public static final int MODE_QUERY

Restores an offline license to allow its status to be queried. If the offline license is expired sets state to DrmSession.STATE_ERROR.

See Also:

Constant Field Values

MODE_DOWNLOAD

public static final int MODE_DOWNLOAD

Downloads an offline license or renews an existing one.

See Also:

Constant Field Values

MODE_RELEASE

public static final int MODE_RELEASE

Releases an existing offline license.

See Also:

Constant Field Values

Constructor Detail

DefaultDrmSessionManager

public DefaultDrmSessionManager(java.util.UUID uuid,
                                ExoMediaDrm<T> mediaDrm,
                                MediaDrmCallback callback,
                                java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                android.os.Handler eventHandler,
                                DefaultDrmSessionManager.EventListener eventListener)

Parameters:

uuid - The UUID of the drm scheme.

mediaDrm - An underlying ExoMediaDrm for use by the manager.

callback - Performs key and provisioning requests.

optionalKeyRequestParameters - An optional map of parameters to pass as the last argument to MediaDrm.getKeyRequest(byte[], byte[], String, int, HashMap). May be null.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

Method Detail

newWidevineInstance

public static DefaultDrmSessionManager<FrameworkMediaCrypto> newWidevineInstance(MediaDrmCallback callback,
                                                                                 java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                                                                 android.os.Handler eventHandler,
                                                                                 DefaultDrmSessionManager.EventListener eventListener)
                                                                          throws UnsupportedDrmException

Instantiates a new instance using the Widevine scheme.

Parameters:

callback - Performs key and provisioning requests.

optionalKeyRequestParameters - An optional map of parameters to pass as the last argument to MediaDrm.getKeyRequest(byte[], byte[], String, int, HashMap). May be null.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

Throws:

UnsupportedDrmException - If the specified DRM scheme is not supported.

newPlayReadyInstance

public static DefaultDrmSessionManager<FrameworkMediaCrypto> newPlayReadyInstance(MediaDrmCallback callback,
                                                                                  java.lang.String customData,
                                                                                  android.os.Handler eventHandler,
                                                                                  DefaultDrmSessionManager.EventListener eventListener)
                                                                           throws UnsupportedDrmException

Instantiates a new instance using the PlayReady scheme.

Note that PlayReady is unsupported by most Android devices, with the exception of Android TV devices, which do provide support.

Parameters:

callback - Performs key and provisioning requests.

customData - Optional custom data to include in requests generated by the instance.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

Throws:

UnsupportedDrmException - If the specified DRM scheme is not supported.

newFrameworkInstance

public static DefaultDrmSessionManager<FrameworkMediaCrypto> newFrameworkInstance(java.util.UUID uuid,
                                                                                  MediaDrmCallback callback,
                                                                                  java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                                                                  android.os.Handler eventHandler,
                                                                                  DefaultDrmSessionManager.EventListener eventListener)
                                                                           throws UnsupportedDrmException

Instantiates a new instance.

Parameters:

uuid - The UUID of the drm scheme.

callback - Performs key and provisioning requests.

optionalKeyRequestParameters - An optional map of parameters to pass as the last argument to MediaDrm.getKeyRequest(byte[], byte[], String, int, HashMap). May be null.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

Throws:

UnsupportedDrmException - If the specified DRM scheme is not supported.

getPropertyString

public final java.lang.String getPropertyString(java.lang.String key)

Provides access to MediaDrm.getPropertyString(String).

This method may be called when the manager is in any state.

Parameters:

key - The key to request.

Returns:

The retrieved property.

setPropertyString

public final void setPropertyString(java.lang.String key,
                                    java.lang.String value)

Provides access to MediaDrm.setPropertyString(String, String).

This method may be called when the manager is in any state.

Parameters:

key - The property to write.

value - The value to write.

getPropertyByteArray

public final byte[] getPropertyByteArray(java.lang.String key)

Provides access to MediaDrm.getPropertyByteArray(String).

This method may be called when the manager is in any state.

Parameters:

key - The key to request.

Returns:

The retrieved property.

setPropertyByteArray

public final void setPropertyByteArray(java.lang.String key,
                                       byte[] value)

Provides access to MediaDrm.setPropertyByteArray(String, byte[]).

This method may be called when the manager is in any state.

Parameters:

key - The property to write.

value - The value to write.

setMode

public void setMode(int mode,
                    byte[] offlineLicenseKeySetId)

Sets the mode, which determines the role of sessions acquired from the instance. This must be called before acquireSession(Looper, DrmInitData) is called.

By default, the mode is MODE_PLAYBACK and a streaming license is requested when required.

mode must be one of these:

• MODE_PLAYBACK: If offlineLicenseKeySetId is null, a streaming license is requested otherwise the offline license is restored.
• MODE_QUERY: offlineLicenseKeySetId can not be null. The offline license is restored.
• MODE_DOWNLOAD: If offlineLicenseKeySetId is null, an offline license is requested otherwise the offline license is renewed.
• MODE_RELEASE: offlineLicenseKeySetId can not be null. The offline license is released.

Parameters:

mode - The mode to be set.

offlineLicenseKeySetId - The key set id of the license to be used with the given mode.

canAcquireSession

public boolean canAcquireSession(@NonNull
                                 DrmInitData drmInitData)

Description copied from interface: DrmSessionManager

Returns whether the manager is capable of acquiring a session for the given DrmInitData.

Specified by:

canAcquireSession in interface DrmSessionManager<T extends ExoMediaCrypto>

Parameters:

drmInitData - DRM initialization data.

Returns:

Whether the manager is capable of acquiring a session for the given DrmInitData.

acquireSession

public DrmSession<T> acquireSession(android.os.Looper playbackLooper,
                                    DrmInitData drmInitData)

Description copied from interface: DrmSessionManager

Acquires a DrmSession for the specified DrmInitData. The DrmSession must be returned to DrmSessionManager.releaseSession(DrmSession) when it is no longer required.

Specified by:

acquireSession in interface DrmSessionManager<T extends ExoMediaCrypto>

Parameters:

playbackLooper - The looper associated with the media playback thread.

drmInitData - DRM initialization data.

Returns:

The DRM session.

releaseSession

public void releaseSession(DrmSession<T> session)

Description copied from interface: DrmSessionManager

Releases a DrmSession.

Specified by:

releaseSession in interface DrmSessionManager<T extends ExoMediaCrypto>

getState

public final int getState()

Description copied from interface: DrmSession

Returns the current state of the session, which is one of DrmSession.STATE_ERROR, DrmSession.STATE_RELEASED, DrmSession.STATE_OPENING, DrmSession.STATE_OPENED and DrmSession.STATE_OPENED_WITH_KEYS.

Specified by:

getState in interface DrmSession<T extends ExoMediaCrypto>

getError

public final DrmSession.DrmSessionException getError()

Description copied from interface: DrmSession

Returns the cause of the error state.

Specified by:

getError in interface DrmSession<T extends ExoMediaCrypto>

getMediaCrypto

public final T getMediaCrypto()

Description copied from interface: DrmSession

Returns a ExoMediaCrypto for the open session, or null if called before the session has been opened or after it's been released.

Specified by:

getMediaCrypto in interface DrmSession<T extends ExoMediaCrypto>

queryKeyStatus

public java.util.Map<java.lang.String,java.lang.String> queryKeyStatus()

Description copied from interface: DrmSession

Returns a map describing the key status for the session, or null if called before the session has been opened or after it's been released.

Since DRM license policies vary by vendor, the specific status field names are determined by each DRM vendor. Refer to your DRM provider documentation for definitions of the field names for a particular DRM engine plugin.

Specified by:

queryKeyStatus in interface DrmSession<T extends ExoMediaCrypto>

Returns:

A map describing the key status for the session, or null if called before the session has been opened or after it's been released.

See Also:

MediaDrm.queryKeyStatus(byte[])

getOfflineLicenseKeySetId

public byte[] getOfflineLicenseKeySetId()

Description copied from interface: DrmSession

Returns the key set id of the offline license loaded into this session, or null if there isn't one.

Specified by:

getOfflineLicenseKeySetId in interface DrmSession<T extends ExoMediaCrypto>