MediaCrypto
class MediaCrypto
| kotlin.Any | |
| ↳ | android.media.MediaCrypto |
MediaCrypto class can be used in conjunction with android.media.MediaCodec to decode encrypted media data. Crypto schemes are assigned 16 byte UUIDs, the method isCryptoSchemeSupported can be used to query if a given scheme is supported on the device.
Summary
| Public constructors | |
|---|---|
MediaCrypto(uuid: UUID, sessionId: ByteArray)Instantiate a MediaCrypto object and associate it with a MediaDrm session |
|
| Public methods | |
|---|---|
| static Boolean |
isCryptoSchemeSupported(uuid: UUID)Query if the given scheme identified by its UUID is supported on this device. |
| Unit |
release() |
| Boolean |
Query if the crypto scheme requires the use of a secure decoder to decode data of the given mime type. |
| Unit |
setMediaDrmSession(sessionId: ByteArray)Associate a new MediaDrm session with this MediaCrypto instance. |
| Protected methods | |
|---|---|
| Unit |
finalize()Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |
Public constructors
MediaCrypto
MediaCrypto(
uuid: UUID,
sessionId: ByteArray)
Instantiate a MediaCrypto object and associate it with a MediaDrm session
| Parameters | |
|---|---|
uuid |
UUID: The UUID of the crypto scheme. This value cannot be null. |
sessionId |
ByteArray: The MediaDrm sessionId to associate with this MediaCrypto session. The sessionId may be changed after the MediaCrypto is created using setMediaDrmSession This value cannot be null. |
Public methods
isCryptoSchemeSupported
static fun isCryptoSchemeSupported(uuid: UUID): Boolean
Query if the given scheme identified by its UUID is supported on this device.
| Parameters | |
|---|---|
uuid |
UUID: The UUID of the crypto scheme. This value cannot be null. |
requiresSecureDecoderComponent
fun requiresSecureDecoderComponent(mime: String): Boolean
Query if the crypto scheme requires the use of a secure decoder to decode data of the given mime type.
| Parameters | |
|---|---|
mime |
String: The mime type of the media data. This value cannot be null. |
setMediaDrmSession
fun setMediaDrmSession(sessionId: ByteArray): Unit
Associate a new MediaDrm session with this MediaCrypto instance.
The MediaDrm session is used to securely load decryption keys for a crypto scheme. The crypto keys loaded through the MediaDrm session may be selected for use during the decryption operation performed by android.media.MediaCodec#queueSecureInputBuffer by specifying their key IDs in the android.media.MediaCodec.CryptoInfo#key field.
| Parameters | |
|---|---|
sessionId |
ByteArray: The MediaDrm sessionId to associate with this MediaCrypto instance. The session's scheme must match the scheme UUID used when constructing this MediaCrypto instance. This value cannot be null. |
| Exceptions | |
|---|---|
android.media.MediaCryptoException |
on failure to set the sessionId |
Protected methods
finalize
protected fun finalize(): Unit
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
The finalize method is never invoked more than once by a Java virtual machine for any given object.
Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
| Exceptions | |
|---|---|
java.lang.Throwable |
the Exception raised by this method |