MediaDrm.SessionException
public
static
final
class
MediaDrm.SessionException
extends RuntimeException
implements
MediaDrmThrowable
java.lang.Object | ||||
↳ | java.lang.Throwable | |||
↳ | java.lang.Exception | |||
↳ | java.lang.RuntimeException | |||
↳ | android.media.MediaDrm.SessionException |
SessionException
is a misnomer because it may occur in methods
without a session context.
A SessionException
is most likely to be thrown when an operation
failed in a way that is likely to succeed on a subsequent attempt; call
isTransient()
to determine whether the app should retry the
failing operation.
Summary
Constants | |
---|---|
int |
ERROR_RESOURCE_CONTENTION
This constant was deprecated
in API level 31.
Please use |
int |
ERROR_UNKNOWN
This constant was deprecated in API level 31. Unused. |
Public constructors | |
---|---|
SessionException(int errorCode, String detailMessage)
|
Public methods | |
---|---|
int
|
getErrorCode()
This method was deprecated
in API level 31.
Please use |
int
|
getErrorContext()
Returns |
int
|
getOemError()
Returns OEM or SOC specific error code associated with this |
int
|
getVendorError()
Returns |
boolean
|
isTransient()
Returns true if the |
Inherited methods | |
---|---|
Constants
ERROR_RESOURCE_CONTENTION
public static final int ERROR_RESOURCE_CONTENTION
This constant was deprecated
in API level 31.
Please use isTransient()
instead of comparing
the return value of getErrorCode()
against
SessionException#ERROR_RESOURCE_CONTENTION
.
This indicates that apps using MediaDrm sessions are temporarily exceeding the capacity of available crypto resources. The app should retry the operation later.
Constant Value: 1 (0x00000001)
ERROR_UNKNOWN
public static final int ERROR_UNKNOWN
This constant was deprecated
in API level 31.
Unused.
The SessionException has an unknown error code.
Constant Value: 0 (0x00000000)
Public constructors
SessionException
public SessionException (int errorCode, String detailMessage)
Parameters | |
---|---|
errorCode |
int |
detailMessage |
String : This value may be null . |
Public methods
getErrorCode
public int getErrorCode ()
This method was deprecated
in API level 31.
Please use isTransient()
instead of comparing
the return value of getErrorCode()
against
SessionException#ERROR_RESOURCE_CONTENTION
.
Retrieve the error code associated with the SessionException
Returns | |
---|---|
int |
Value is ERROR_RESOURCE_CONTENTION |
getErrorContext
public int getErrorContext ()
Returns MediaDrm
plugin vendor defined error context associated with this MediaDrmThrowable
.
Please consult the MediaDrm
plugin vendor for details on the error context.
Returns | |
---|---|
int |
an opaque integer that would help the @MediaDrm vendor locate the
source of the error if available, otherwise 0. |
getOemError
public int getOemError ()
Returns OEM or SOC specific error code associated with this MediaDrmThrowable
.
Please consult the MediaDrm
plugin, chip, or device vendor for details on the
error code.
Returns | |
---|---|
int |
an OEM or SOC specific error code if available, otherwise 0. |
getVendorError
public int getVendorError ()
Returns MediaDrm
plugin vendor defined error code associated with this MediaDrmThrowable
.
Please consult the MediaDrm
plugin vendor for details on the error code.
Returns | |
---|---|
int |
an error code defined by the MediaDrm plugin vendor if available,
otherwise 0. |
isTransient
public boolean isTransient ()
Returns true if the SessionException
is a transient
issue, perhaps due to resource constraints, and that the operation
(e.g. provisioning, generating requests) may succeed on a subsequent
attempt.
Returns | |
---|---|
boolean |