com.google.android.exoplayer2.drm

Class StreamingDrmSessionManager<T extends ExoMediaCrypto>

java.lang.Object

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

All Implemented Interfaces:

DrmSession<T>, DrmSessionManager<T>

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

A DrmSessionManager that supports streaming playbacks using MediaDrm.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StreamingDrmSessionManager.EventListener Listener of StreamingDrmSessionManager events.

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

DrmSession.State

Field Summary

Fields

Modifier and Type	Field and Description
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_CLOSED, STATE_ERROR, STATE_OPENED, STATE_OPENED_WITH_KEYS, STATE_OPENING

Constructor Summary

Constructors

Constructor and Description
StreamingDrmSessionManager(java.util.UUID uuid, ExoMediaDrm<T> mediaDrm, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, StreamingDrmSessionManager.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.
java.lang.Exception	getError() Returns the cause of the error state.
T	getMediaCrypto() Returns a ExoMediaCrypto for the open session.
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.
static StreamingDrmSessionManager<FrameworkMediaCrypto>	newFrameworkInstance(java.util.UUID uuid, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, StreamingDrmSessionManager.EventListener eventListener) Instantiates a new instance.
static StreamingDrmSessionManager<FrameworkMediaCrypto>	newPlayReadyInstance(MediaDrmCallback callback, java.lang.String customData, android.os.Handler eventHandler, StreamingDrmSessionManager.EventListener eventListener) Instantiates a new instance using the PlayReady scheme.
static StreamingDrmSessionManager<FrameworkMediaCrypto>	newWidevineInstance(MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters, android.os.Handler eventHandler, StreamingDrmSessionManager.EventListener eventListener) Instantiates a new instance using the Widevine scheme.
void	releaseSession(DrmSession<T> session) Releases a DrmSession.
boolean	requiresSecureDecoderComponent(java.lang.String mimeType) Whether the session requires a secure decoder for the specified mime type.
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

Constructor Detail

StreamingDrmSessionManager

public StreamingDrmSessionManager(java.util.UUID uuid,
                                  ExoMediaDrm<T> mediaDrm,
                                  MediaDrmCallback callback,
                                  java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                  android.os.Handler eventHandler,
                                  StreamingDrmSessionManager.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 StreamingDrmSessionManager<FrameworkMediaCrypto> newWidevineInstance(MediaDrmCallback callback,
                                                                                   java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                                                                   android.os.Handler eventHandler,
                                                                                   StreamingDrmSessionManager.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 StreamingDrmSessionManager<FrameworkMediaCrypto> newPlayReadyInstance(MediaDrmCallback callback,
                                                                                    java.lang.String customData,
                                                                                    android.os.Handler eventHandler,
                                                                                    StreamingDrmSessionManager.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 StreamingDrmSessionManager<FrameworkMediaCrypto> newFrameworkInstance(java.util.UUID uuid,
                                                                                    MediaDrmCallback callback,
                                                                                    java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters,
                                                                                    android.os.Handler eventHandler,
                                                                                    StreamingDrmSessionManager.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.

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.

Specified by:

getState in interface DrmSession<T extends ExoMediaCrypto>

Returns:

One of DrmSession.STATE_ERROR, DrmSession.STATE_CLOSED, DrmSession.STATE_OPENING, DrmSession.STATE_OPENED and DrmSession.STATE_OPENED_WITH_KEYS.

getMediaCrypto

public final T getMediaCrypto()

Description copied from interface: DrmSession

Returns a ExoMediaCrypto for the open session.

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

Specified by:

getMediaCrypto in interface DrmSession<T extends ExoMediaCrypto>

Returns:

A ExoMediaCrypto for the open session.

requiresSecureDecoderComponent

public boolean requiresSecureDecoderComponent(java.lang.String mimeType)

Description copied from interface: DrmSession

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: DrmSession.STATE_OPENED, DrmSession.STATE_OPENED_WITH_KEYS

Specified by:

requiresSecureDecoderComponent in interface DrmSession<T extends ExoMediaCrypto>

Returns:

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

getError

public final java.lang.Exception getError()

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 ExoMediaCrypto>

Returns:

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