CryptoException

Kotlin |Java

class CryptoException : RuntimeException, MediaDrmThrowable

kotlin.Any
↳	kotlin.Throwable
	↳	java.lang.Exception
		↳	java.lang.RuntimeException
			↳	android.media.MediaCodec.CryptoException

Thrown when a crypto error occurs while queueing a secure input buffer.

Summary

Constants
static Int	`ERROR_FRAME_TOO_LARGE` This indicates that the video frame being decrypted exceeds the size of the device's protected output buffers.
static Int	`ERROR_INSUFFICIENT_OUTPUT_PROTECTION` This indicates that the output protection levels supported by the device are not sufficient to meet the requirements set by the content owner in the license policy.
static Int	`ERROR_INSUFFICIENT_SECURITY` This indicates that the security level of the device is not sufficient to meet the requirements set by the content owner in the license policy.
static Int	`ERROR_KEY_EXPIRED` This indicates that the key used for decryption is no longer valid due to license term expiration.
static Int	`ERROR_LOST_STATE` This error indicates that session state has been invalidated.
static Int	`ERROR_NO_KEY` This indicates that the requested key was not found when trying to perform a decrypt operation.
static Int	`ERROR_RESOURCE_BUSY` This indicates that a required crypto resource was not able to be allocated while attempting the requested operation.
static Int	`ERROR_SESSION_NOT_OPENED` This indicates that decryption was attempted on a session that is not opened, which could be due to a failure to open the session, closing the session prematurely, or the session being reclaimed by the resource manager.
static Int	`ERROR_UNSUPPORTED_OPERATION` This indicates that an operation was attempted that could not be supported by the crypto system of the device in its current configuration.

Public constructors
`CryptoException(errorCode: Int, detailMessage: String?)`

Public methods
MediaCodec.CryptoInfo?	`getCryptoInfo()` Returns CryptoInfo associated with this `CryptoException` if any
Int	`getErrorCode()` Returns error code associated with this `CryptoException`.
Int	`getErrorContext()`
Int	`getOemError()`
Int	`getVendorError()`

Constants

ERROR_FRAME_TOO_LARGE

Added in API level 29
Deprecated in API level 31

static val ERROR_FRAME_TOO_LARGE: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_FRAME_TOO_LARGE

This indicates that the video frame being decrypted exceeds the size of the device's protected output buffers. When encountering this error the app should try playing content of a lower resolution.

Value: 8

ERROR_INSUFFICIENT_OUTPUT_PROTECTION

Added in API level 21
Deprecated in API level 31

static val ERROR_INSUFFICIENT_OUTPUT_PROTECTION: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_INSUFFICIENT_OUTPUT_PROTECTION

This indicates that the output protection levels supported by the device are not sufficient to meet the requirements set by the content owner in the license policy.

Value: 4

ERROR_INSUFFICIENT_SECURITY

Added in API level 29
Deprecated in API level 31

static val ERROR_INSUFFICIENT_SECURITY: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_INSUFFICIENT_SECURITY

This indicates that the security level of the device is not sufficient to meet the requirements set by the content owner in the license policy.

Value: 7

ERROR_KEY_EXPIRED

Added in API level 19
Deprecated in API level 31

static val ERROR_KEY_EXPIRED: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_KEY_EXPIRED.

This indicates that the key used for decryption is no longer valid due to license term expiration. The operation can be retried after updating the expired keys.

Value: 2

ERROR_LOST_STATE

Added in API level 29
Deprecated in API level 31

static val ERROR_LOST_STATE: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_LOST_STATE

This error indicates that session state has been invalidated. It can occur on devices that are not capable of retaining crypto session state across device suspend/resume. The session must be closed and a new session opened to resume operation.

Value: 9

ERROR_NO_KEY

Added in API level 19
Deprecated in API level 31

static val ERROR_NO_KEY: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_NO_KEY.

This indicates that the requested key was not found when trying to perform a decrypt operation. The operation can be retried after adding the correct decryption key.

Value: 1

ERROR_RESOURCE_BUSY

Added in API level 19
Deprecated in API level 31

static val ERROR_RESOURCE_BUSY: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_RESOURCE_BUSY

This indicates that a required crypto resource was not able to be allocated while attempting the requested operation. The operation can be retried if the app is able to release resources.

Value: 3

ERROR_SESSION_NOT_OPENED

Added in API level 23
Deprecated in API level 31

static val ERROR_SESSION_NOT_OPENED: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_SESSION_NOT_OPENED

This indicates that decryption was attempted on a session that is not opened, which could be due to a failure to open the session, closing the session prematurely, or the session being reclaimed by the resource manager.

Value: 5

ERROR_UNSUPPORTED_OPERATION

Added in API level 24
Deprecated in API level 31

static val ERROR_UNSUPPORTED_OPERATION: Int

Deprecated: Please use MediaDrm.ErrorCodes#ERROR_UNSUPPORTED_OPERATION

This indicates that an operation was attempted that could not be supported by the crypto system of the device in its current configuration. It may occur when the license policy requires device security features that aren't supported by the device, or due to an internal error in the crypto system that prevents the specified security policy from being met.

Value: 6

Public constructors

CryptoException

Added in API level 16

CryptoException(
    errorCode: Int, 
    detailMessage: String?)

Parameters
`detailMessage`	String?: This value may be `null`.

Public methods

getCryptoInfo

Added in API level 34

fun getCryptoInfo(): MediaCodec.CryptoInfo?

Returns CryptoInfo associated with this CryptoException if any

Return
`MediaCodec.CryptoInfo?`	CryptoInfo object if any. `MediaCodec.CryptoException` This value may be `null`.

getErrorCode

Added in API level 16

fun getErrorCode(): Int

Returns error code associated with this CryptoException.

Please refer to MediaDrm.ErrorCodes for the general error handling strategy and details about each possible return value.

Return

Int an error code defined in MediaDrm.ErrorCodes. Value is android.media.MediaDrm.ErrorCodes#ERROR_NO_KEY, android.media.MediaDrm.ErrorCodes#ERROR_KEY_EXPIRED, android.media.MediaDrm.ErrorCodes#ERROR_RESOURCE_BUSY, android.media.MediaDrm.ErrorCodes#ERROR_INSUFFICIENT_OUTPUT_PROTECTION, android.media.MediaDrm.ErrorCodes#ERROR_SESSION_NOT_OPENED, android.media.MediaDrm.ErrorCodes#ERROR_UNSUPPORTED_OPERATION, android.media.MediaDrm.ErrorCodes#ERROR_INSUFFICIENT_SECURITY, android.media.MediaDrm.ErrorCodes#ERROR_FRAME_TOO_LARGE, android.media.MediaDrm.ErrorCodes#ERROR_LOST_STATE, android.media.MediaDrm.ErrorCodes#ERROR_GENERIC_OEM, android.media.MediaDrm.ErrorCodes#ERROR_GENERIC_PLUGIN, android.media.MediaDrm.ErrorCodes#ERROR_LICENSE_PARSE, android.media.MediaDrm.ErrorCodes#ERROR_MEDIA_FRAMEWORK, or android.media.MediaDrm.ErrorCodes#ERROR_ZERO_SUBSAMPLES

Return
`Int`	an error code defined in `MediaDrm.ErrorCodes`. Value is `android.media.MediaDrm.ErrorCodes#ERROR_NO_KEY`, `android.media.MediaDrm.ErrorCodes#ERROR_KEY_EXPIRED`, `android.media.MediaDrm.ErrorCodes#ERROR_RESOURCE_BUSY`, `android.media.MediaDrm.ErrorCodes#ERROR_INSUFFICIENT_OUTPUT_PROTECTION`, `android.media.MediaDrm.ErrorCodes#ERROR_SESSION_NOT_OPENED`, `android.media.MediaDrm.ErrorCodes#ERROR_UNSUPPORTED_OPERATION`, `android.media.MediaDrm.ErrorCodes#ERROR_INSUFFICIENT_SECURITY`, `android.media.MediaDrm.ErrorCodes#ERROR_FRAME_TOO_LARGE`, `android.media.MediaDrm.ErrorCodes#ERROR_LOST_STATE`, `android.media.MediaDrm.ErrorCodes#ERROR_GENERIC_OEM`, `android.media.MediaDrm.ErrorCodes#ERROR_GENERIC_PLUGIN`, `android.media.MediaDrm.ErrorCodes#ERROR_LICENSE_PARSE`, `android.media.MediaDrm.ErrorCodes#ERROR_MEDIA_FRAMEWORK`, or `android.media.MediaDrm.ErrorCodes#ERROR_ZERO_SUBSAMPLES`

getErrorContext

Added in API level 34

fun getErrorContext(): Int

Return
`Int`	an opaque integer that would help the @`MediaDrm` vendor locate the source of the error if available, otherwise 0.

getOemError

Added in API level 34

fun getOemError(): Int

Return
`Int`	an OEM or SOC specific error code if available, otherwise 0.

getVendorError

Added in API level 34

fun getVendorError(): Int

Return
`Int`	an error code defined by the `MediaDrm` plugin vendor if available, otherwise 0.