com.google.android.exoplayer2.drm

Interface DrmSession<T extends ExoMediaCrypto>

All Known Implementing Classes:

DefaultDrmSessionManager

public interface DrmSession<T extends ExoMediaCrypto>

A DRM session.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DrmSession.DrmSessionException Wraps the exception which is the cause of the error state.
static interface	DrmSession.State The state of the DRM session.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_CLOSED The session is closed.
static int	STATE_ERROR The session has encountered an error.
static int	STATE_OPENED The session is open, but does not yet have the keys required for decryption.
static int	STATE_OPENED_WITH_KEYS The session is open and has the keys required for decryption.
static int	STATE_OPENING The session is being opened.

Method Summary

Modifier and Type	Method and Description
DrmSession.DrmSessionException	getError() Returns the cause of the error state.
T	getMediaCrypto() Returns a ExoMediaCrypto for the open session.
byte[]	getOfflineLicenseKeySetId() Returns the key set id of the offline license loaded into this session, if there is one.
int	getState() Returns the current state of the session.
java.util.Map<java.lang.String,java.lang.String>	queryKeyStatus() Returns an informative description of the key status for the session.
boolean	requiresSecureDecoderComponent(java.lang.String mimeType) Whether the session requires a secure decoder for the specified mime type.

Field Detail

STATE_ERROR

static final int STATE_ERROR

The session has encountered an error. getError() can be used to retrieve the cause.

See Also:

Constant Field Values

STATE_CLOSED

static final int STATE_CLOSED

The session is closed.

See Also:

Constant Field Values

STATE_OPENING

static final int STATE_OPENING

The session is being opened.

See Also:

Constant Field Values

STATE_OPENED

static final int STATE_OPENED

The session is open, but does not yet have the keys required for decryption.

See Also:

Constant Field Values

STATE_OPENED_WITH_KEYS

static final int STATE_OPENED_WITH_KEYS

The session is open and has the keys required for decryption.

See Also:

Constant Field Values

Method Detail

getState

int getState()

Returns the current state of the session.

Returns:

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

getMediaCrypto

T getMediaCrypto()

Returns a ExoMediaCrypto for the open session.

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

Returns:

A ExoMediaCrypto for the open session.

Throws:

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

requiresSecureDecoderComponent

boolean requiresSecureDecoderComponent(java.lang.String mimeType)

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

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

DrmSession.DrmSessionException getError()

Returns the cause of the error state.

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

Returns:

An exception if the state is STATE_ERROR. Null otherwise.

queryKeyStatus

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

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.

Returns:

A map of key status.

Throws:

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

See Also:

MediaDrm.queryKeyStatus(byte[])

getOfflineLicenseKeySetId

byte[] getOfflineLicenseKeySetId()

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