tv.danmaku.ijk.media.drm

Class FrameworkMediaDrm

java.lang.Object

tv.danmaku.ijk.media.drm.FrameworkMediaDrm

All Implemented Interfaces:

ExoMediaDrm

public final class FrameworkMediaDrm
extends java.lang.Object
implements ExoMediaDrm

An ExoMediaDrm implementation that wraps the framework MediaDrm.

Nested Class Summary

Nested classes/interfaces inherited from interface tv.danmaku.ijk.media.drm.ExoMediaDrm

ExoMediaDrm.AppManagedProvider, ExoMediaDrm.KeyRequest, ExoMediaDrm.KeyStatus, ExoMediaDrm.OnEventListener, ExoMediaDrm.OnExpirationUpdateListener, ExoMediaDrm.OnKeyStatusChangeListener, ExoMediaDrm.Provider, ExoMediaDrm.ProvisionRequest

Field Summary

Fields

Modifier and Type	Field and Description
static ExoMediaDrm.Provider	DEFAULT_PROVIDER ExoMediaDrm.Provider that returns a new FrameworkMediaDrm for the requested UUID.

Fields inherited from interface tv.danmaku.ijk.media.drm.ExoMediaDrm

EVENT_KEY_EXPIRED, EVENT_KEY_REQUIRED, EVENT_PROVISION_REQUIRED, KEY_TYPE_OFFLINE, KEY_TYPE_RELEASE, KEY_TYPE_STREAMING

Method Summary

Modifier and Type	Method and Description
void	acquire() Increments the reference count.
void	closeSession(byte[] sessionId) Closes a DRM session.
FrameworkMediaCrypto	createMediaCrypto(byte[] initData) Creates an ExoMediaCrypto for a given session.
java.lang.Class<FrameworkMediaCrypto>	getExoMediaCryptoType() Returns the ExoMediaCrypto type created by ExoMediaDrm.createMediaCrypto(byte[]).
ExoMediaDrm.KeyRequest	getKeyRequest(byte[] scope, java.util.List<DrmInitData.SchemeData> schemeDatas, int keyType, java.util.HashMap<java.lang.String,java.lang.String> optionalParameters) Generates a key request.
android.os.PersistableBundle	getMetrics() Returns metrics data for this ExoMediaDrm instance, or null if metrics are unavailable.
byte[]	getPropertyByteArray(java.lang.String propertyName) Returns the value of a byte array property.
java.lang.String	getPropertyString(java.lang.String propertyName) Returns the value of a string property.
ExoMediaDrm.ProvisionRequest	getProvisionRequest() Generates a provisioning request.
static boolean	isCryptoSchemeSupported(java.util.UUID uuid) Returns whether the DRM scheme with the given UUID is supported on this device.
static FrameworkMediaDrm	newInstance(java.util.UUID uuid) Creates an instance with an initial reference count of 1.
byte[]	openSession() Opens a new DRM session.
byte[]	provideKeyResponse(byte[] scope, byte[] response) Provides a key response for the last request to be generated using ExoMediaDrm.getKeyRequest(byte[], java.util.List<tv.danmaku.ijk.media.drm.DrmInitData.SchemeData>, int, java.util.HashMap<java.lang.String, java.lang.String>).
void	provideProvisionResponse(byte[] response) Provides a provisioning response for the last request to be generated using ExoMediaDrm.getProvisionRequest().
java.util.Map<java.lang.String,java.lang.String>	queryKeyStatus(byte[] sessionId) Returns the key status for a given session, as {name, value} pairs.
void	release() Decrements the reference count.
void	restoreKeys(byte[] sessionId, byte[] keySetId) Restores persisted offline keys into a session.
void	setOnEventListener(ExoMediaDrm.OnEventListener listener) Sets the listener for DRM events.
void	setOnExpirationUpdateListener(ExoMediaDrm.OnExpirationUpdateListener listener) Sets the listener for session expiration events.
void	setOnKeyStatusChangeListener(ExoMediaDrm.OnKeyStatusChangeListener listener) Sets the listener for key status change events.
void	setPropertyByteArray(java.lang.String propertyName, byte[] value) Sets the value of a byte array property.
void	setPropertyString(java.lang.String propertyName, java.lang.String value) Sets the value of a string property.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROVIDER

public static final ExoMediaDrm.Provider DEFAULT_PROVIDER

ExoMediaDrm.Provider that returns a new FrameworkMediaDrm for the requested UUID. Returns a DummyExoMediaDrm if the protection scheme identified by the given UUID is not supported by the device.

Method Detail

isCryptoSchemeSupported

public static boolean isCryptoSchemeSupported(java.util.UUID uuid)

Returns whether the DRM scheme with the given UUID is supported on this device.

See Also:

MediaDrm.isCryptoSchemeSupported(UUID)

newInstance

public static FrameworkMediaDrm newInstance(java.util.UUID uuid)
                                     throws UnsupportedDrmException

Creates an instance with an initial reference count of 1. release() must be called on the instance when it's no longer required.

Parameters:

uuid - The scheme uuid.

Returns:

The created instance.

Throws:

UnsupportedDrmException - If the DRM scheme is unsupported or cannot be instantiated.

setOnEventListener

public void setOnEventListener(ExoMediaDrm.OnEventListener listener)

Description copied from interface: ExoMediaDrm

Sets the listener for DRM events.

This is an optional method, and some implementations may only support it on certain Android API levels.

Specified by:

setOnEventListener in interface ExoMediaDrm

Parameters:

listener - The listener to receive events, or null to stop receiving events.

See Also:

MediaDrm.setOnEventListener(MediaDrm.OnEventListener)

setOnKeyStatusChangeListener

public void setOnKeyStatusChangeListener(ExoMediaDrm.OnKeyStatusChangeListener listener)

Sets the listener for key status change events.

This is an optional method, and some implementations may only support it on certain Android API levels.

Specified by:

setOnKeyStatusChangeListener in interface ExoMediaDrm

Parameters:

listener - The listener to receive events, or null to stop receiving events.

Throws:

java.lang.UnsupportedOperationException - on API levels lower than 23.

See Also:

MediaDrm.setOnKeyStatusChangeListener(MediaDrm.OnKeyStatusChangeListener, Handler)

setOnExpirationUpdateListener

public void setOnExpirationUpdateListener(ExoMediaDrm.OnExpirationUpdateListener listener)

Sets the listener for session expiration events.

This is an optional method, and some implementations may only support it on certain Android API levels.

Specified by:

setOnExpirationUpdateListener in interface ExoMediaDrm

Parameters:

listener - The listener to receive events, or null to stop receiving events.

Throws:

java.lang.UnsupportedOperationException - on API levels lower than 23.

See Also:

MediaDrm.setOnExpirationUpdateListener(MediaDrm.OnExpirationUpdateListener, Handler)

openSession

public byte[] openSession()
                   throws android.media.MediaDrmException

Description copied from interface: ExoMediaDrm

Opens a new DRM session. A session ID is returned.

Specified by:

openSession in interface ExoMediaDrm

Returns:

The session ID.

Throws:

android.media.NotProvisionedException - If provisioning is needed.

android.media.ResourceBusyException - If required resources are in use.

android.media.MediaDrmException - If the session could not be opened.

closeSession

public void closeSession(byte[] sessionId)

Description copied from interface: ExoMediaDrm

Closes a DRM session.

Specified by:

closeSession in interface ExoMediaDrm

Parameters:

sessionId - The ID of the session to close.

getKeyRequest

public ExoMediaDrm.KeyRequest getKeyRequest(byte[] scope,
                                            java.util.List<DrmInitData.SchemeData> schemeDatas,
                                            int keyType,
                                            java.util.HashMap<java.lang.String,java.lang.String> optionalParameters)
                                     throws android.media.NotProvisionedException

Description copied from interface: ExoMediaDrm

Generates a key request.

Specified by:

getKeyRequest in interface ExoMediaDrm

Parameters:

scope - If keyType is ExoMediaDrm.KEY_TYPE_STREAMING or ExoMediaDrm.KEY_TYPE_OFFLINE, the ID of the session that the keys will be provided to. If keyType is ExoMediaDrm.KEY_TYPE_RELEASE, the keySetId of the keys to release.

schemeDatas - If key type is ExoMediaDrm.KEY_TYPE_STREAMING or ExoMediaDrm.KEY_TYPE_OFFLINE, a list of DrmInitData.SchemeData instances extracted from the media. Null otherwise.

keyType - The type of the request. Either ExoMediaDrm.KEY_TYPE_STREAMING to acquire keys for streaming, ExoMediaDrm.KEY_TYPE_OFFLINE to acquire keys for offline usage, or ExoMediaDrm.KEY_TYPE_RELEASE to release acquired keys. Releasing keys invalidates them for all sessions.

optionalParameters - Are included in the key request message to allow a client application to provide additional message parameters to the server. This may be null if no additional parameters are to be sent.

Returns:

The generated key request.

Throws:

android.media.NotProvisionedException

See Also:

MediaDrm.getKeyRequest(byte[], byte[], String, int, HashMap)

provideKeyResponse

public byte[] provideKeyResponse(byte[] scope,
                                 byte[] response)
                          throws android.media.NotProvisionedException,
                                 android.media.DeniedByServerException

Description copied from interface: ExoMediaDrm

Provides a key response for the last request to be generated using ExoMediaDrm.getKeyRequest(byte[], java.util.List<tv.danmaku.ijk.media.drm.DrmInitData.SchemeData>, int, java.util.HashMap<java.lang.String, java.lang.String>).

Specified by:

provideKeyResponse in interface ExoMediaDrm

Parameters:

scope - If the request had type ExoMediaDrm.KEY_TYPE_STREAMING or ExoMediaDrm.KEY_TYPE_OFFLINE, the ID of the session to provide the keys to. If keyType is ExoMediaDrm.KEY_TYPE_RELEASE, the keySetId of the keys being released.

response - The response data from the server.

Returns:

If the request had type ExoMediaDrm.KEY_TYPE_OFFLINE, the keySetId for the offline keys. An empty byte array or null may be returned for other cases.

Throws:

android.media.NotProvisionedException - If the response indicates that provisioning is needed.

android.media.DeniedByServerException - If the response indicates that the server rejected the request.

getProvisionRequest

public ExoMediaDrm.ProvisionRequest getProvisionRequest()

Description copied from interface: ExoMediaDrm

Generates a provisioning request.

Specified by:

getProvisionRequest in interface ExoMediaDrm

Returns:

The generated provisioning request.

provideProvisionResponse

public void provideProvisionResponse(byte[] response)
                              throws android.media.DeniedByServerException

Description copied from interface: ExoMediaDrm

Provides a provisioning response for the last request to be generated using ExoMediaDrm.getProvisionRequest().

Specified by:

provideProvisionResponse in interface ExoMediaDrm

Parameters:

response - The response data from the server.

Throws:

android.media.DeniedByServerException - If the response indicates that the server rejected the request.

queryKeyStatus

public java.util.Map<java.lang.String,java.lang.String> queryKeyStatus(byte[] sessionId)

Description copied from interface: ExoMediaDrm

Returns the key status for a given session, as {name, value} pairs. Since DRM license policies vary by vendor, the returned entries depend on the DRM plugin being used. Refer to your DRM provider's documentation for more information.

Specified by:

queryKeyStatus in interface ExoMediaDrm

Parameters:

sessionId - The ID of the session being queried.

Returns:

The key status for the session.

acquire

public void acquire()

Description copied from interface: ExoMediaDrm

Increments the reference count. When the caller no longer needs to use the instance, it must call ExoMediaDrm.release() to decrement the reference count.

A new instance will have an initial reference count of 1, and therefore it is not normally necessary for application code to call this method.

Specified by:

acquire in interface ExoMediaDrm

release

public void release()

Description copied from interface: ExoMediaDrm

Decrements the reference count. If the reference count drops to 0 underlying resources are released, and the instance cannot be re-used.

Specified by:

release in interface ExoMediaDrm

restoreKeys

public void restoreKeys(byte[] sessionId,
                        byte[] keySetId)

Description copied from interface: ExoMediaDrm

Restores persisted offline keys into a session.

Specified by:

restoreKeys in interface ExoMediaDrm

Parameters:

sessionId - The ID of the session into which the keys will be restored.

keySetId - The keySetId of the keys to restore, as provided by the call to ExoMediaDrm.provideKeyResponse(byte[], byte[]) that persisted them.

getMetrics

public android.os.PersistableBundle getMetrics()

Description copied from interface: ExoMediaDrm

Returns metrics data for this ExoMediaDrm instance, or null if metrics are unavailable.

Specified by:

getMetrics in interface ExoMediaDrm

getPropertyString

public java.lang.String getPropertyString(java.lang.String propertyName)

Description copied from interface: ExoMediaDrm

Returns the value of a string property. For standard property names, see MediaDrm.getPropertyString(java.lang.String).

Specified by:

getPropertyString in interface ExoMediaDrm

Parameters:

propertyName - The property name.

Returns:

The property value.

getPropertyByteArray

public byte[] getPropertyByteArray(java.lang.String propertyName)

Description copied from interface: ExoMediaDrm

Returns the value of a byte array property. For standard property names, see MediaDrm.getPropertyByteArray(java.lang.String).

Specified by:

getPropertyByteArray in interface ExoMediaDrm

Parameters:

propertyName - The property name.

Returns:

The property value.

setPropertyString

public void setPropertyString(java.lang.String propertyName,
                              java.lang.String value)

Description copied from interface: ExoMediaDrm

Sets the value of a string property.

Specified by:

setPropertyString in interface ExoMediaDrm

Parameters:

propertyName - The property name.

value - The value.

setPropertyByteArray

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

Description copied from interface: ExoMediaDrm

Sets the value of a byte array property.

Specified by:

setPropertyByteArray in interface ExoMediaDrm

Parameters:

propertyName - The property name.

value - The value.

createMediaCrypto

public FrameworkMediaCrypto createMediaCrypto(byte[] initData)
                                       throws android.media.MediaCryptoException

Description copied from interface: ExoMediaDrm

Creates an ExoMediaCrypto for a given session.

Specified by:

createMediaCrypto in interface ExoMediaDrm

Parameters:

initData - The ID of the session.

Returns:

An ExoMediaCrypto for the given session.

Throws:

android.media.MediaCryptoException - If an ExoMediaCrypto could not be created.

getExoMediaCryptoType

public java.lang.Class<FrameworkMediaCrypto> getExoMediaCryptoType()

Description copied from interface: ExoMediaDrm

Returns the ExoMediaCrypto type created by ExoMediaDrm.createMediaCrypto(byte[]).

Specified by:

getExoMediaCryptoType in interface ExoMediaDrm