Android APIs
public final class

MediaCrypto

extends Object
java.lang.Object
   ↳ android.media.MediaCrypto

Class Overview

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[] initData)
Instantiate a MediaCrypto object using opaque, crypto scheme specific data.
Public Methods
final static boolean isCryptoSchemeSupported(UUID uuid)
Query if the given scheme identified by its UUID is supported on this device.
final void release()
final boolean requiresSecureDecoderComponent(String mime)
Query if the crypto scheme requires the use of a secure decoder to decode data of the given mime type.
final void setMediaDrmSession(byte[] sessionId)
Associate a MediaDrm session with this MediaCrypto instance.
Protected Methods
void finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MediaCrypto (UUID uuid, byte[] initData)

Added in API level 16

Instantiate a MediaCrypto object using opaque, crypto scheme specific data.

Parameters
uuid The UUID of the crypto scheme.
initData Opaque initialization data specific to the crypto scheme.
Throws
MediaCryptoException

Public Methods

public static final boolean isCryptoSchemeSupported (UUID uuid)

Added in API level 16

Query if the given scheme identified by its UUID is supported on this device.

Parameters
uuid The UUID of the crypto scheme.
Returns
boolean

public final void release ()

Added in API level 16

public final boolean requiresSecureDecoderComponent (String mime)

Added in API level 16

Query if the crypto scheme requires the use of a secure decoder to decode data of the given mime type.

Parameters
mime The mime type of the media data
Returns
boolean

public final void setMediaDrmSession (byte[] sessionId)

Added in API level 23

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

Parameters
sessionId the MediaDrm sessionId to associate with this MediaCrypto instance
Throws
MediaCryptoException on failure to set the sessionId

Protected Methods

protected void finalize ()

Added in API level 16

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.