com.brightcove.player.drm

Class ExoPlayerDrmSessionManager<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

java.lang.Object

com.brightcove.player.drm.ExoPlayerDrmSessionManager<T>

All Implemented Interfaces:

BrightcoveDrmSession, DrmSession<T>, com.google.android.exoplayer.drm.DrmSessionManager<T>

Deprecated.

@Deprecated
public class ExoPlayerDrmSessionManager<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>
extends java.lang.Object
implements com.google.android.exoplayer.drm.DrmSessionManager<T>, DrmSession<T>

A DrmSessionManager that supports offline playback of DRM restricted content using MediaDrm.

This code was adapted from com.google.android.exoplayer2.drm.DefaultDrmSessionManager to provide similar functionality in ExoPlayer version 1.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface com.brightcove.player.drm.DrmSession

DrmSession.DrmSessionException

Field Summary

Fields

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

Fields inherited from interface com.google.android.exoplayer.drm.DrmSessionManager

STATE_CLOSED, STATE_ERROR, STATE_OPENED, STATE_OPENED_WITH_KEYS, STATE_OPENING

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DrmSession<T>	acquireSession(com.google.android.exoplayer.drm.DrmInitData drmInitData) Deprecated.
void	close() Deprecated. Closes the session.
DrmException	getDrmError() Deprecated.
DrmSession.DrmSessionException	getError() Deprecated. Returns the cause of the error state.
T	getMediaCrypto() Deprecated. Provides reference to the current DRM session.
byte[]	getOfflineLicenseKeySetId() Deprecated. Returns the key set id of the offline license loaded into this session, if there is one.
byte[]	getPropertyByteArray(java.lang.String key) Deprecated. Provides access to MediaDrm.getPropertyByteArray(String).
java.lang.String	getPropertyString(java.lang.String key) Deprecated. Provides access to MediaDrm.getPropertyString(String).
int	getState() Deprecated. Returns the current state of the session.
static ExoPlayerDrmSessionManager<com.google.android.exoplayer.drm.FrameworkMediaCrypto>	newFrameworkInstance(java.util.UUID uuid, com.google.android.exoplayer.drm.MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, ExoPlayerDrmSessionManager.EventListener eventListener) Deprecated. Instantiates a new instance.
static ExoPlayerDrmSessionManager<com.google.android.exoplayer.drm.FrameworkMediaCrypto>	newPlayReadyInstance(com.google.android.exoplayer.drm.MediaDrmCallback callback, java.lang.String customData, android.os.Handler eventHandler, ExoPlayerDrmSessionManager.EventListener eventListener) Deprecated. Instantiates a new instance using the PlayReady scheme.
static ExoPlayerDrmSessionManager<com.google.android.exoplayer.drm.FrameworkMediaCrypto>	newWidevineInstance(android.os.Looper playbackLooper, com.google.android.exoplayer.drm.MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, ExoPlayerDrmSessionManager.EventListener eventListener) Deprecated. Instantiates a new instance using the Widevine scheme.
void	open(com.google.android.exoplayer.drm.DrmInitData drmInitData) Deprecated. Opens the session, possibly asynchronously.
java.util.Map<java.lang.String,java.lang.String>	queryKeyStatus() Deprecated. Returns an informative description of the key status for the session.
void	releaseSession(DrmSession<T> session) Deprecated.
boolean	requiresSecureDecoderComponent(java.lang.String mimeType) Deprecated. Whether the session requires a secure decoder for the specified mime type.
void	setMode(int mode, byte[] offlineLicenseKeySetId) Deprecated. Sets the mode, which determines the role of sessions acquired from the instance.
void	setPlaybackLooper(android.os.Looper looper) Deprecated. Sets the playback looper that will be used.
void	setPropertyByteArray(java.lang.String key, byte[] value) Deprecated. Provides access to MediaDrm.setPropertyByteArray(String, byte[]).
void	setPropertyString(java.lang.String key, java.lang.String value) Deprecated. 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

PLAY_READY_CUSTOM_DATA_KEY

public static final java.lang.String PLAY_READY_CUSTOM_DATA_KEY

Deprecated.

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

Deprecated.

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

Deprecated.

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

See Also:

Constant Field Values

MODE_DOWNLOAD

public static final int MODE_DOWNLOAD

Deprecated.

Downloads an offline license or renews an existing one.

See Also:

Constant Field Values

MODE_RELEASE

public static final int MODE_RELEASE

Deprecated.

Releases an existing offline license.

See Also:

Constant Field Values

Constructor Detail

ExoPlayerDrmSessionManager

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

Deprecated.

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 ExoPlayerDrmSessionManager<com.google.android.exoplayer.drm.FrameworkMediaCrypto> newWidevineInstance(android.os.Looper playbackLooper,
                                                                                                                    com.google.android.exoplayer.drm.MediaDrmCallback callback,
                                                                                                                    java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                                                                                                    android.os.Handler eventHandler,
                                                                                                                    ExoPlayerDrmSessionManager.EventListener eventListener)
                                                                                                             throws com.google.android.exoplayer.drm.UnsupportedDrmException,
                                                                                                                    android.media.UnsupportedSchemeException

Deprecated.

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:

com.google.android.exoplayer.drm.UnsupportedDrmException - If the specified DRM scheme is not supported.

android.media.UnsupportedSchemeException

newPlayReadyInstance

public static ExoPlayerDrmSessionManager<com.google.android.exoplayer.drm.FrameworkMediaCrypto> newPlayReadyInstance(com.google.android.exoplayer.drm.MediaDrmCallback callback,
                                                                                                                     java.lang.String customData,
                                                                                                                     android.os.Handler eventHandler,
                                                                                                                     ExoPlayerDrmSessionManager.EventListener eventListener)
                                                                                                              throws com.google.android.exoplayer.drm.UnsupportedDrmException,
                                                                                                                     android.media.UnsupportedSchemeException

Deprecated.

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:

com.google.android.exoplayer.drm.UnsupportedDrmException - If the specified DRM scheme is not supported.

android.media.UnsupportedSchemeException

newFrameworkInstance

public static ExoPlayerDrmSessionManager<com.google.android.exoplayer.drm.FrameworkMediaCrypto> newFrameworkInstance(java.util.UUID uuid,
                                                                                                                     com.google.android.exoplayer.drm.MediaDrmCallback callback,
                                                                                                                     java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                                                                                                     android.os.Handler eventHandler,
                                                                                                                     ExoPlayerDrmSessionManager.EventListener eventListener)
                                                                                                              throws com.google.android.exoplayer.drm.UnsupportedDrmException,
                                                                                                                     android.media.UnsupportedSchemeException

Deprecated.

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:

com.google.android.exoplayer.drm.UnsupportedDrmException - If the specified DRM scheme is not supported.

android.media.UnsupportedSchemeException

getPropertyString

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

Deprecated.

Provides access to MediaDrm.getPropertyString(String).

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

Specified by:

getPropertyString in interface BrightcoveDrmSession

Parameters:

key - The key to request.

Returns:

The retrieved property.

See Also:

MediaDrm.getPropertyString(String)

setPropertyString

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

Deprecated.

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

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

Specified by:

setPropertyString in interface BrightcoveDrmSession

Parameters:

key - The property to write.

value - The value to write.

See Also:

MediaDrm.setPropertyString(String, String)

getPropertyByteArray

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

Deprecated.

Provides access to MediaDrm.getPropertyByteArray(String).

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

Specified by:

getPropertyByteArray in interface BrightcoveDrmSession

Parameters:

key - The key to request.

Returns:

The retrieved property.

See Also:

MediaDrm.getPropertyByteArray(String)

setPropertyByteArray

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

Deprecated.

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

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

Specified by:

setPropertyByteArray in interface BrightcoveDrmSession

Parameters:

key - The property to write.

value - The value to write.

See Also:

MediaDrm.setPropertyByteArray(String, byte[])

setMode

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

Deprecated.

Sets the mode, which determines the role of sessions acquired from the instance. This must be called before acquireSession(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.

acquireSession

public DrmSession<T> acquireSession(com.google.android.exoplayer.drm.DrmInitData drmInitData)

Deprecated.

setPlaybackLooper

public void setPlaybackLooper(android.os.Looper looper)

Deprecated.

Sets the playback looper that will be used.

Parameters:

looper - reference to the playback looper

Throws:

java.lang.IllegalStateException - if the playback looper has been already to different instance.

releaseSession

public void releaseSession(DrmSession<T> session)

Deprecated.

getState

public final int getState()

Deprecated.

Returns the current state of the session.

Specified by:

getState in interface DrmSession<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Specified by:

getState in interface com.google.android.exoplayer.drm.DrmSessionManager<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Returns:

One of DrmSessionManager.STATE_ERROR, DrmSessionManager.STATE_CLOSED, DrmSessionManager.STATE_OPENING, DrmSessionManager.STATE_OPENED or DrmSessionManager.STATE_OPENED_WITH_KEYS.

getMediaCrypto

public final T getMediaCrypto()

Deprecated.

Provides reference to the current DRM session.

This method may be called when the session is in the following states: DrmSessionManager.STATE_OPENED, DrmSessionManager.STATE_OPENED_WITH_KEYS

Specified by:

getMediaCrypto in interface DrmSession<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Specified by:

getMediaCrypto in interface com.google.android.exoplayer.drm.DrmSessionManager<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Returns:

A ExoMediaCrypto for the open session.

Throws:

java.lang.IllegalStateException - If called when a session isn't opened.

requiresSecureDecoderComponent

public boolean requiresSecureDecoderComponent(java.lang.String mimeType)

Deprecated.

Whether the session requires a secure decoder for the specified mime type.

Normally this method should return ExoMediaCrypto.requiresSecureDecoderComponent(String), however in some cases implementations may wish to modify the return value (i.e. to force a secure decoder even when one is not required).

This method may be called when the session is in the following states: DrmSessionManager.STATE_OPENED, DrmSessionManager.STATE_OPENED_WITH_KEYS

Specified by:

requiresSecureDecoderComponent in interface DrmSession<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Specified by:

requiresSecureDecoderComponent in interface com.google.android.exoplayer.drm.DrmSessionManager<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Returns:

Whether the open session requires a secure decoder for the specified mime type.

Throws:

java.lang.IllegalStateException - If called when a session isn't opened.

getError

public DrmSession.DrmSessionException getError()

Deprecated.

Description copied from interface: DrmSession

Returns the cause of the error state.

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

Specified by:

getError in interface DrmSession<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Specified by:

getError in interface com.google.android.exoplayer.drm.DrmSessionManager<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Returns:

An exception if the state is DrmSessionManager.STATE_ERROR. Null otherwise.

getDrmError

public final DrmException getDrmError()

Deprecated.

Specified by:

getDrmError in interface BrightcoveDrmSession

queryKeyStatus

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

Deprecated.

Description copied from interface: DrmSession

Returns an informative description of the key status for the session. The status is in the form of {name, value} pairs.

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 BrightcoveDrmSession

Specified by:

queryKeyStatus in interface DrmSession<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Returns:

A map of key status.

See Also:

MediaDrm#queryKeyStatus(byte[])

getOfflineLicenseKeySetId

public byte[] getOfflineLicenseKeySetId()

Deprecated.

Description copied from interface: DrmSession

Returns the key set id of the offline license loaded into this session, if there is one. Null otherwise.

Specified by:

getOfflineLicenseKeySetId in interface BrightcoveDrmSession

Specified by:

getOfflineLicenseKeySetId in interface DrmSession<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

open

public void open(com.google.android.exoplayer.drm.DrmInitData drmInitData)

Deprecated.

Opens the session, possibly asynchronously.

Specified by:

open in interface com.google.android.exoplayer.drm.DrmSessionManager<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>

Parameters:

drmInitData - DRM initialization data.

close

public void close()

Deprecated.

Closes the session.

Specified by:

close in interface com.google.android.exoplayer.drm.DrmSessionManager<T extends com.google.android.exoplayer.drm.ExoMediaCrypto>