com.google.android.exoplayer2.drm

Class DefaultDrmSessionManager<T extends ExoMediaCrypto>

java.lang.Object

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

All Implemented Interfaces:

com.google.android.exoplayer2.drm.DefaultDrmSession.ProvisioningManager<T>, DrmSessionManager<T>

public class DefaultDrmSessionManager<T extends ExoMediaCrypto>
extends java.lang.Object
implements DrmSessionManager<T>, com.google.android.exoplayer2.drm.DefaultDrmSession.ProvisioningManager<T>

A DrmSessionManager that supports playbacks using ExoMediaDrm.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultDrmSessionManager.EventListener Deprecated. Use DefaultDrmSessionEventListener.
static class	DefaultDrmSessionManager.MissingSchemeDataException Signals that the DrmInitData passed to acquireSession(android.os.Looper, com.google.android.exoplayer2.drm.DrmInitData) does not contain does not contain scheme data for the required UUID.
static interface	DefaultDrmSessionManager.Mode Determines the action to be done after a session acquired.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INITIAL_DRM_REQUEST_RETRY_COUNT Number of times to retry for initial provisioning and key request for reporting error.
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.

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)
DefaultDrmSessionManager(java.util.UUID uuid, ExoMediaDrm<T> mediaDrm, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, boolean multiSession)
DefaultDrmSessionManager(java.util.UUID uuid, ExoMediaDrm<T> mediaDrm, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, boolean multiSession, int initialDrmRequestRetryCount)
DefaultDrmSessionManager(java.util.UUID uuid, ExoMediaDrm<T> mediaDrm, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, DefaultDrmSessionEventListener eventListener) Deprecated. Use DefaultDrmSessionManager(UUID, ExoMediaDrm, MediaDrmCallback, HashMap) and addListener(Handler, DefaultDrmSessionEventListener).
DefaultDrmSessionManager(java.util.UUID uuid, ExoMediaDrm<T> mediaDrm, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, DefaultDrmSessionEventListener eventListener, boolean multiSession) Deprecated. Use DefaultDrmSessionManager(UUID, ExoMediaDrm, MediaDrmCallback, HashMap, boolean) and addListener(Handler, DefaultDrmSessionEventListener).
DefaultDrmSessionManager(java.util.UUID uuid, ExoMediaDrm<T> mediaDrm, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, DefaultDrmSessionEventListener eventListener, boolean multiSession, int initialDrmRequestRetryCount) Deprecated. Use DefaultDrmSessionManager(UUID, ExoMediaDrm, MediaDrmCallback, HashMap, boolean, int) and addListener(Handler, DefaultDrmSessionEventListener).

Method Summary

Modifier and Type	Method and Description
DrmSession<T>	acquireSession(android.os.Looper playbackLooper, DrmInitData drmInitData) Acquires a DrmSession for the specified DrmInitData.
void	addListener(android.os.Handler handler, DefaultDrmSessionEventListener eventListener) Adds a DefaultDrmSessionEventListener to listen to drm session events.
boolean	canAcquireSession(DrmInitData drmInitData) Returns whether the manager is capable of acquiring a session for the given DrmInitData.
byte[]	getPropertyByteArray(java.lang.String key) Provides access to ExoMediaDrm.getPropertyByteArray(String).
java.lang.String	getPropertyString(java.lang.String key) Provides access to ExoMediaDrm.getPropertyString(String).
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newFrameworkInstance(java.util.UUID uuid, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters) Instantiates a new instance.
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newFrameworkInstance(java.util.UUID uuid, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, DefaultDrmSessionEventListener eventListener) Deprecated. Use newFrameworkInstance(UUID, MediaDrmCallback, HashMap) and addListener(Handler, DefaultDrmSessionEventListener).
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newPlayReadyInstance(MediaDrmCallback callback, java.lang.String customData) Instantiates a new instance using the PlayReady scheme.
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newPlayReadyInstance(MediaDrmCallback callback, java.lang.String customData, android.os.Handler eventHandler, DefaultDrmSessionEventListener eventListener) Deprecated. Use newPlayReadyInstance(MediaDrmCallback, String) and addListener(Handler, DefaultDrmSessionEventListener).
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newWidevineInstance(MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters) Instantiates a new instance using the Widevine scheme.
static DefaultDrmSessionManager<FrameworkMediaCrypto>	newWidevineInstance(MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, DefaultDrmSessionEventListener eventListener) Deprecated. Use newWidevineInstance(MediaDrmCallback, HashMap) and addListener(Handler, DefaultDrmSessionEventListener).
void	onProvisionCompleted() Called by a session when it successfully completes a provisioning operation.
void	onProvisionError(java.lang.Exception error) Called by a session when it fails to perform a provisioning operation.
void	provisionRequired(com.google.android.exoplayer2.drm.DefaultDrmSession<T> session) Called when a session requires provisioning.
void	releaseSession(DrmSession<T> session) Releases a DrmSession.
void	removeListener(DefaultDrmSessionEventListener eventListener) Removes a DefaultDrmSessionEventListener from the list of drm session event listeners.
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 ExoMediaDrm.setPropertyByteArray(String, byte[]).
void	setPropertyString(java.lang.String key, java.lang.String value) Provides access to ExoMediaDrm.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.

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

INITIAL_DRM_REQUEST_RETRY_COUNT

public static final int INITIAL_DRM_REQUEST_RETRY_COUNT

Number of times to retry for initial provisioning and key request for reporting error.

See Also:

Constant Field Values

Constructor Detail

DefaultDrmSessionManager

@Deprecated
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,
                                            DefaultDrmSessionEventListener eventListener)

Deprecated. Use DefaultDrmSessionManager(UUID, ExoMediaDrm, MediaDrmCallback, HashMap) and addListener(Handler, DefaultDrmSessionEventListener).

DefaultDrmSessionManager

public DefaultDrmSessionManager(java.util.UUID uuid,
                                ExoMediaDrm<T> mediaDrm,
                                MediaDrmCallback callback,
                                java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters)

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 ExoMediaDrm.getKeyRequest(byte[], List, int, HashMap). May be null.

DefaultDrmSessionManager

@Deprecated
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,
                                            DefaultDrmSessionEventListener eventListener,
                                            boolean multiSession)

Deprecated. Use DefaultDrmSessionManager(UUID, ExoMediaDrm, MediaDrmCallback, HashMap, boolean) and addListener(Handler, DefaultDrmSessionEventListener).

DefaultDrmSessionManager

public DefaultDrmSessionManager(java.util.UUID uuid,
                                ExoMediaDrm<T> mediaDrm,
                                MediaDrmCallback callback,
                                java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                boolean multiSession)

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 ExoMediaDrm.getKeyRequest(byte[], List, int, HashMap). May be null.

multiSession - A boolean that specify whether multiple key session support is enabled. Default is false.

DefaultDrmSessionManager

@Deprecated
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,
                                            DefaultDrmSessionEventListener eventListener,
                                            boolean multiSession,
                                            int initialDrmRequestRetryCount)

Deprecated. Use DefaultDrmSessionManager(UUID, ExoMediaDrm, MediaDrmCallback, HashMap, boolean, int) and addListener(Handler, DefaultDrmSessionEventListener).

DefaultDrmSessionManager

public DefaultDrmSessionManager(java.util.UUID uuid,
                                ExoMediaDrm<T> mediaDrm,
                                MediaDrmCallback callback,
                                java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                boolean multiSession,
                                int initialDrmRequestRetryCount)

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 ExoMediaDrm.getKeyRequest(byte[], List, int, HashMap). May be null.

multiSession - A boolean that specify whether multiple key session support is enabled. Default is false.

initialDrmRequestRetryCount - The number of times to retry for initial provisioning and key request before reporting error.

Method Detail

newWidevineInstance

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

Deprecated. Use newWidevineInstance(MediaDrmCallback, HashMap) and addListener(Handler, DefaultDrmSessionEventListener).

Throws:

UnsupportedDrmException

newWidevineInstance

public static DefaultDrmSessionManager<FrameworkMediaCrypto> newWidevineInstance(MediaDrmCallback callback,
                                                                                 java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters)
                                                                          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 ExoMediaDrm.getKeyRequest(byte[], List, int, HashMap). May be null.

Throws:

UnsupportedDrmException - If the specified DRM scheme is not supported.

newPlayReadyInstance

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

Deprecated. Use newPlayReadyInstance(MediaDrmCallback, String) and addListener(Handler, DefaultDrmSessionEventListener).

Throws:

UnsupportedDrmException

newPlayReadyInstance

public static DefaultDrmSessionManager<FrameworkMediaCrypto> newPlayReadyInstance(MediaDrmCallback callback,
                                                                                  java.lang.String customData)
                                                                           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.

Throws:

UnsupportedDrmException - If the specified DRM scheme is not supported.

newFrameworkInstance

@Deprecated
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,
                                                                                              DefaultDrmSessionEventListener eventListener)
                                                                                       throws UnsupportedDrmException

Deprecated. Use newFrameworkInstance(UUID, MediaDrmCallback, HashMap) and addListener(Handler, DefaultDrmSessionEventListener).

Throws:

UnsupportedDrmException

newFrameworkInstance

public static DefaultDrmSessionManager<FrameworkMediaCrypto> newFrameworkInstance(java.util.UUID uuid,
                                                                                  MediaDrmCallback callback,
                                                                                  java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters)
                                                                           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 ExoMediaDrm.getKeyRequest(byte[], List, int, HashMap). May be null.

Throws:

UnsupportedDrmException - If the specified DRM scheme is not supported.

addListener

public final void addListener(android.os.Handler handler,
                              DefaultDrmSessionEventListener eventListener)

Adds a DefaultDrmSessionEventListener to listen to drm session events.

Parameters:

handler - A handler to use when delivering events to eventListener.

eventListener - A listener of events.

removeListener

public final void removeListener(DefaultDrmSessionEventListener eventListener)

Removes a DefaultDrmSessionEventListener from the list of drm session event listeners.

Parameters:

eventListener - The listener to remove.

getPropertyString

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

Provides access to ExoMediaDrm.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 ExoMediaDrm.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 ExoMediaDrm.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 ExoMediaDrm.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(@DefaultDrmSessionManager.Mode
                    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. All contained DrmInitData.SchemeDatas must contain non-null DrmInitData.SchemeData.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>

provisionRequired

public void provisionRequired(com.google.android.exoplayer2.drm.DefaultDrmSession<T> session)

Description copied from interface: com.google.android.exoplayer2.drm.DefaultDrmSession.ProvisioningManager

Called when a session requires provisioning. The manager may call provision() to have this session perform the provisioning operation. The manager will call DefaultDrmSession.onProvisionCompleted() when provisioning has completed, or DefaultDrmSession.onProvisionError(java.lang.Exception) if provisioning fails.

Specified by:

provisionRequired in interface com.google.android.exoplayer2.drm.DefaultDrmSession.ProvisioningManager<T extends ExoMediaCrypto>

Parameters:

session - The session.

onProvisionCompleted

public void onProvisionCompleted()

Description copied from interface: com.google.android.exoplayer2.drm.DefaultDrmSession.ProvisioningManager

Called by a session when it successfully completes a provisioning operation.

Specified by:

onProvisionCompleted in interface com.google.android.exoplayer2.drm.DefaultDrmSession.ProvisioningManager<T extends ExoMediaCrypto>

onProvisionError

public void onProvisionError(java.lang.Exception error)

Description copied from interface: com.google.android.exoplayer2.drm.DefaultDrmSession.ProvisioningManager

Called by a session when it fails to perform a provisioning operation.

Specified by:

onProvisionError in interface com.google.android.exoplayer2.drm.DefaultDrmSession.ProvisioningManager<T extends ExoMediaCrypto>

Parameters:

error - The error that occurred.