com.google.android.exoplayer2.drm

Interface ExoMediaDrm<T extends ExoMediaCrypto>

All Known Implementing Classes:

FrameworkMediaDrm

public interface ExoMediaDrm<T extends ExoMediaCrypto>

Used to obtain keys for decrypting protected media streams. See MediaDrm.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExoMediaDrm.KeyRequest
static class	ExoMediaDrm.KeyStatus
static interface	ExoMediaDrm.OnEventListener<T extends ExoMediaCrypto>
static interface	ExoMediaDrm.OnKeyStatusChangeListener<T extends ExoMediaCrypto>
static class	ExoMediaDrm.ProvisionRequest

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_KEY_EXPIRED
static int	EVENT_KEY_REQUIRED
static int	EVENT_PROVISION_REQUIRED
static int	KEY_TYPE_OFFLINE
static int	KEY_TYPE_RELEASE
static int	KEY_TYPE_STREAMING

Method Summary

Modifier and Type	Method and Description
void	closeSession(byte[] sessionId)
T	createMediaCrypto(byte[] initData)
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.
byte[]	getPropertyByteArray(java.lang.String propertyName)
java.lang.String	getPropertyString(java.lang.String propertyName)
ExoMediaDrm.ProvisionRequest	getProvisionRequest()
byte[]	openSession()
byte[]	provideKeyResponse(byte[] scope, byte[] response)
void	provideProvisionResponse(byte[] response)
java.util.Map<java.lang.String,java.lang.String>	queryKeyStatus(byte[] sessionId)
void	release()
void	restoreKeys(byte[] sessionId, byte[] keySetId)
void	setOnEventListener(ExoMediaDrm.OnEventListener<? super T> listener)
void	setOnKeyStatusChangeListener(ExoMediaDrm.OnKeyStatusChangeListener<? super T> listener)
void	setPropertyByteArray(java.lang.String propertyName, byte[] value)
void	setPropertyString(java.lang.String propertyName, java.lang.String value)

Field Detail

EVENT_KEY_REQUIRED

static final int EVENT_KEY_REQUIRED

See Also:

MediaDrm.EVENT_KEY_REQUIRED, Constant Field Values

EVENT_KEY_EXPIRED

static final int EVENT_KEY_EXPIRED

See Also:

MediaDrm.EVENT_KEY_EXPIRED, Constant Field Values

EVENT_PROVISION_REQUIRED

static final int EVENT_PROVISION_REQUIRED

See Also:

MediaDrm.EVENT_PROVISION_REQUIRED, Constant Field Values

KEY_TYPE_STREAMING

static final int KEY_TYPE_STREAMING

See Also:

MediaDrm.KEY_TYPE_STREAMING, Constant Field Values

KEY_TYPE_OFFLINE

static final int KEY_TYPE_OFFLINE

See Also:

MediaDrm.KEY_TYPE_OFFLINE, Constant Field Values

KEY_TYPE_RELEASE

static final int KEY_TYPE_RELEASE

See Also:

MediaDrm.KEY_TYPE_RELEASE, Constant Field Values

Method Detail

setOnEventListener

void setOnEventListener(ExoMediaDrm.OnEventListener<? super T> listener)

See Also:

MediaDrm.setOnEventListener(MediaDrm.OnEventListener)

setOnKeyStatusChangeListener

void setOnKeyStatusChangeListener(ExoMediaDrm.OnKeyStatusChangeListener<? super T> listener)

See Also:

MediaDrm.setOnKeyStatusChangeListener(MediaDrm.OnKeyStatusChangeListener, Handler)

openSession

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

Throws:

android.media.MediaDrmException

See Also:

MediaDrm.openSession()

closeSession

void closeSession(byte[] sessionId)

See Also:

MediaDrm.closeSession(byte[])

getKeyRequest

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

Generates a key request.

Parameters:

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

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

keyType - The type of the request. Either KEY_TYPE_STREAMING to acquire keys for streaming, KEY_TYPE_OFFLINE to acquire keys for offline usage, or 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

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

Throws:

android.media.NotProvisionedException

android.media.DeniedByServerException

See Also:

MediaDrm.provideKeyResponse(byte[], byte[])

getProvisionRequest

ExoMediaDrm.ProvisionRequest getProvisionRequest()

See Also:

MediaDrm.getProvisionRequest()

provideProvisionResponse

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

Throws:

android.media.DeniedByServerException

See Also:

MediaDrm.provideProvisionResponse(byte[])

queryKeyStatus

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

See Also:

MediaDrm.queryKeyStatus(byte[])

release

void release()

See Also:

MediaDrm.release()

restoreKeys

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

See Also:

MediaDrm.restoreKeys(byte[], byte[])

getPropertyString

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

See Also:

MediaDrm.getPropertyString(String)

getPropertyByteArray

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

See Also:

MediaDrm.getPropertyByteArray(String)

setPropertyString

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

See Also:

MediaDrm.setPropertyString(String, String)

setPropertyByteArray

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

See Also:

MediaDrm.setPropertyByteArray(String, byte[])

createMediaCrypto

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

Parameters:

initData - Opaque initialization data specific to the crypto scheme.

Returns:

An object extends ExoMediaCrypto, using opaque crypto scheme specific data.

Throws:

android.media.MediaCryptoException - If the instance can't be created.

See Also:

MediaCrypto.MediaCrypto(UUID, byte[])