MediaCrypto

Kotlin |Java

public final class MediaCrypto
extends Object

java.lang.Object
↳	android.media.MediaCrypto

MediaCrypto class can be used in conjunction with MediaCodec to decode encrypted media data. Crypto schemes are assigned 16 byte UUIDs, the method isCryptoSchemeSupported(UUID) can be used to query if a given scheme is supported on the device.

Summary

Public constructors
`MediaCrypto(UUID uuid, byte[] sessionId)` 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.
`void`	`release()`
`boolean`	`requiresSecureDecoderComponent(String mime)` Query if the crypto scheme requires the use of a secure decoder to decode data of the given mime type.
`void`	`setMediaDrmSession(byte[] sessionId)` Associate a new MediaDrm session with this MediaCrypto instance.

Protected methods
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

MediaCrypto

Added in API level 16

public MediaCrypto (UUID uuid, 
                byte[] sessionId)

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`	`byte`: The MediaDrm sessionId to associate with this MediaCrypto session. The sessionId may be changed after the MediaCrypto is created using `setMediaDrmSession(byte)` This value cannot be `null`.

Throws
`MediaCryptoException`

Public methods

isCryptoSchemeSupported

Added in API level 16

public static boolean isCryptoSchemeSupported (UUID uuid)

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`.

Returns
`boolean`

release

Added in API level 16

public void release ()

requiresSecureDecoderComponent

Added in API level 16

public boolean requiresSecureDecoderComponent (String mime)

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`.

Returns
`boolean`

setMediaDrmSession

Added in API level 23

public void setMediaDrmSession (byte[] sessionId)

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 MediaCodec.queueSecureInputBuffer(int, int, CryptoInfo, long, int) by specifying their key IDs in the MediaCodec.CryptoInfo.key field.

Parameters
`sessionId`	`byte`: 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`.

Throws
`MediaCryptoException`	on failure to set the sessionId

Protected methods

finalize

Added in API level 16

protected void finalize ()

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.