com.google.android.exoplayer2.drm

Interface DrmSession<T extends ExoMediaCrypto>

All Known Implementing Classes:

ErrorStateDrmSession

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 throwable 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_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.
static int	STATE_RELEASED The session has been released.

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, or null if called before the session has been opened or after it's been released.
byte[]	getOfflineLicenseKeySetId() Returns the key set id of the offline license loaded into this session, or null if there isn't one.
int	getState() Returns the current state of the session, which is one of STATE_ERROR, STATE_RELEASED, STATE_OPENING, STATE_OPENED and STATE_OPENED_WITH_KEYS.
java.util.Map<java.lang.String,java.lang.String>	queryKeyStatus() Returns a map describing the key status for the session, or null if called before the session has been opened or after it's been released.

Field Detail

STATE_RELEASED

static final int STATE_RELEASED

The session has been released.

See Also:

Constant Field Values

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_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, which is one of STATE_ERROR, STATE_RELEASED, STATE_OPENING, STATE_OPENED and STATE_OPENED_WITH_KEYS.

getError

DrmSession.DrmSessionException getError()

Returns the cause of the error state.

getMediaCrypto

T getMediaCrypto()

Returns a ExoMediaCrypto for the open session, or null if called before the session has been opened or after it's been released.

queryKeyStatus

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

Returns a map describing the key status for the session, or null if called before the session has been opened or after it's been released.

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 describing the key status for the session, or null if called before the session has been opened or after it's been released.

See Also:

MediaDrm.queryKeyStatus(byte[])

getOfflineLicenseKeySetId

byte[] getOfflineLicenseKeySetId()

Returns the key set id of the offline license loaded into this session, or null if there isn't one.