FrameworkMediaDrm

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

class FrameworkMediaDrm : ExoMediaDrm

An ExoMediaDrm implementation that wraps the framework MediaDrm.

Summary

Constants
`const ExoMediaDrm.Provider!`	`@UnstableApi DEFAULT_PROVIDER` `ExoMediaDrm.Provider` that returns a new `FrameworkMediaDrm` for the requested UUID.

Public functions
`synchronized Unit`	`@UnstableApi acquire()` Increments the reference count.
`Unit`	`@UnstableApi closeSession(sessionId: ByteArray!)` Closes a DRM session.
`FrameworkCryptoConfig!`	`@UnstableApi createCryptoConfig(sessionId: ByteArray!)` Creates a `CryptoConfig` that can be passed to a compatible decoder to allow decryption of protected content using the specified session.
`Int`	`@UnstableApi @C.CryptoType getCryptoType()` Returns the `type` of `CryptoConfig` instances returned by `createCryptoConfig`.
`ExoMediaDrm.KeyRequest!`	`@UnstableApi getKeyRequest( scope: ByteArray!, schemeDatas: (Mutable)List<DrmInitData.SchemeData!>?, keyType: Int, optionalParameters: HashMap<String!, String!>? )` Generates a key request.
`PersistableBundle?`	`@UnstableApi getMetrics()` Returns metrics data for this ExoMediaDrm instance, or `null` if metrics are unavailable.
`(Mutable)List<ByteArray<Byte>!>!`	`@UnstableApi @RequiresApi(value = 29) getOfflineLicenseKeySetIds()` Returns a list of the `keySetIds` for all offline licenses.
`ByteArray<Byte>!`	`@UnstableApi getPropertyByteArray(propertyName: String!)` Returns the value of a byte array property.
`String!`	`@UnstableApi getPropertyString(propertyName: String!)` Returns the value of a string property.
`ExoMediaDrm.ProvisionRequest!`	`@UnstableApi getProvisionRequest()` Generates a provisioning request.
`java-static Boolean`	`isCryptoSchemeSupported(uuid: UUID!)` Returns whether the DRM scheme with the given UUID is supported on this device.
`java-static FrameworkMediaDrm!`	`@UnstableApi newInstance(uuid: UUID!)` Creates an instance with an initial reference count of 1.
`ByteArray<Byte>!`	`@UnstableApi openSession()` Opens a new DRM session.
`ByteArray<Byte>?`	`@UnstableApi provideKeyResponse(scope: ByteArray!, response: ByteArray!)` Provides a key response for the last request to be generated using `getKeyRequest`.
`Unit`	`@UnstableApi provideProvisionResponse(response: ByteArray!)` Provides a provisioning response for the last request to be generated using `getProvisionRequest`.
`(Mutable)Map<String!, String!>!`	`@UnstableApi queryKeyStatus(sessionId: ByteArray!)` Returns the key status for a given session, as {name, value} pairs.
`synchronized Unit`	`@UnstableApi release()` Decrements the reference count.
`Unit`	`@UnstableApi @RequiresApi(value = 29) removeOfflineLicense(keySetId: ByteArray!)` Removes an offline license.
`Boolean`	`@UnstableApi requiresSecureDecoder(sessionId: ByteArray!, mimeType: String!)` Returns whether the given session requires use of a secure decoder for the given MIME type.
`Unit`	`@UnstableApi restoreKeys(sessionId: ByteArray!, keySetId: ByteArray!)` Restores persisted offline keys into a session.
`Unit`	`@UnstableApi setOnEventListener(listener: ExoMediaDrm.OnEventListener?)` Sets the listener for DRM events.
`Unit`	`@UnstableApi setOnExpirationUpdateListener( listener: ExoMediaDrm.OnExpirationUpdateListener? )` Sets the listener for session expiration events.
`Unit`	`@UnstableApi setOnKeyStatusChangeListener( listener: ExoMediaDrm.OnKeyStatusChangeListener? )` Sets the listener for key status change events.
`Unit`	`@UnstableApi setPlayerIdForSession(sessionId: ByteArray!, playerId: PlayerId!)` Sets the `PlayerId` of the player using a session.
`Unit`	`@UnstableApi setPropertyByteArray(propertyName: String!, value: ByteArray!)` Sets the value of a byte array property.
`Unit`	`@UnstableApi setPropertyString(propertyName: String!, value: String!)` Sets the value of a string property.

Inherited Constants

From androidx.media3.exoplayer.drm.ExoMediaDrm

`const Int`	`@UnstableApi EVENT_KEY_EXPIRED = 3` Event indicating that keys have expired, and are no longer usable.
`const Int`	`@UnstableApi EVENT_KEY_REQUIRED = 2` Event indicating that keys need to be requested from the license server.
`const Int`	`@UnstableApi EVENT_PROVISION_REQUIRED = 1` Event indicating that a certificate needs to be requested from the provisioning server.
`const Int`	`@UnstableApi KEY_TYPE_OFFLINE = 2` Key request type for keys that will be used for offline use.
`const Int`	`@UnstableApi KEY_TYPE_RELEASE = 3` Key request type indicating that saved offline keys should be released.
`const Int`	`@UnstableApi KEY_TYPE_STREAMING = 1` Key request type for keys that will be used for online use.

Constants

DEFAULT_PROVIDER

@UnstableApi
const val DEFAULT_PROVIDER: ExoMediaDrm.Provider!

ExoMediaDrm.Provider that returns a new FrameworkMediaDrm for the requested UUID. Returns a DummyExoMediaDrm if the protection scheme identified by the given UUID is not supported by the device.

Public functions

acquire

@UnstableApi
synchronized fun acquire(): Unit

Increments the reference count. When the caller no longer needs to use the instance, it must call release to decrement the reference count.

A new instance will have an initial reference count of 1, and therefore it is not normally necessary for application code to call this method.

closeSession

@UnstableApi
fun closeSession(sessionId: ByteArray!): Unit

Closes a DRM session.

Parameters
`sessionId: ByteArray!`	The ID of the session to close.

createCryptoConfig

@UnstableApi
fun createCryptoConfig(sessionId: ByteArray!): FrameworkCryptoConfig!

Creates a CryptoConfig that can be passed to a compatible decoder to allow decryption of protected content using the specified session.

Parameters
`sessionId: ByteArray!`	The ID of the session.

Returns
`FrameworkCryptoConfig!`	A `CryptoConfig` for the given session.

Throws
`android.media.MediaCryptoException`	If a `CryptoConfig` could not be created.

getCryptoType

@UnstableApi
@C.CryptoType
fun getCryptoType(): Int

Returns the type of CryptoConfig instances returned by createCryptoConfig.

getKeyRequest

@UnstableApi
fun getKeyRequest(
    scope: ByteArray!,
    schemeDatas: (Mutable)List<DrmInitData.SchemeData!>?,
    keyType: Int,
    optionalParameters: HashMap<String!, String!>?
): ExoMediaDrm.KeyRequest!

Generates a key request.

Parameters
`scope: ByteArray!`	If `keyType` is `KEY_TYPE_STREAMING` or `KEY_TYPE_OFFLINE`, the ID of the session that the keys will be provided to. If `keyType` is `KEY_TYPE_RELEASE`, the `keySetId` of the keys to release.
`schemeDatas: (Mutable)List<DrmInitData.SchemeData!>?`	If key type is `KEY_TYPE_STREAMING` or `KEY_TYPE_OFFLINE`, a list of `SchemeData` instances extracted from the media. Null otherwise.
`keyType: Int`	The type of the request. Either `KEY_TYPE_STREAMING` to acquire keys for streaming, `KEY_TYPE_OFFLINE` to acquire keys for offline usage, or `KEY_TYPE_RELEASE` to release acquired keys. Releasing keys invalidates them for all sessions.
`optionalParameters: HashMap<String!, String!>?`	Are included in the key request message to allow a client application to provide additional message parameters to the server. This may be `null` if no additional parameters are to be sent.

Returns
`ExoMediaDrm.KeyRequest!`	The generated key request.

Throws
`android.media.NotProvisionedException`

See also
`getKeyRequest`

getMetrics

@UnstableApi
fun getMetrics(): PersistableBundle?

Returns metrics data for this ExoMediaDrm instance, or null if metrics are unavailable.

getOfflineLicenseKeySetIds

@UnstableApi
@RequiresApi(value = 29)
fun getOfflineLicenseKeySetIds(): (Mutable)List<ByteArray<Byte>!>!

Returns a list of the keySetIds for all offline licenses.

This is an optional method, and some implementations may only support it on certain Android API levels.

See getOfflineLicenseKeySetIds for more details.

Returns
`(Mutable)List<ByteArray<Byte>!>!`	The list of `keySetIds` for all offline licenses.

Throws
`java.lang.UnsupportedOperationException`	if the implementation doesn't support this method.

getPropertyByteArray

@UnstableApi
fun getPropertyByteArray(propertyName: String!): ByteArray<Byte>!

Returns the value of a byte array property. For standard property names, see getPropertyByteArray.

Parameters
`propertyName: String!`	The property name.

Returns
`ByteArray<Byte>!`	The property value.

Throws
`java.lang.IllegalArgumentException`	If the underlying DRM plugin does not support the property.

getPropertyString

@UnstableApi
fun getPropertyString(propertyName: String!): String!

Returns the value of a string property. For standard property names, see getPropertyString.

Parameters
`propertyName: String!`	The property name.

Returns
`String!`	The property value.

Throws
`java.lang.IllegalArgumentException`	If the underlying DRM plugin does not support the property.

getProvisionRequest

@UnstableApi
fun getProvisionRequest(): ExoMediaDrm.ProvisionRequest!

Generates a provisioning request.

Returns
`ExoMediaDrm.ProvisionRequest!`	The generated provisioning request.

isCryptoSchemeSupported

java-static fun isCryptoSchemeSupported(uuid: UUID!): Boolean

Returns whether the DRM scheme with the given UUID is supported on this device.

See also
`isCryptoSchemeSupported`

newInstance

@UnstableApi
java-static fun newInstance(uuid: UUID!): FrameworkMediaDrm!

Creates an instance with an initial reference count of 1. release must be called on the instance when it's no longer required.

Parameters
`uuid: UUID!`	The scheme uuid.

Returns
`FrameworkMediaDrm!`	The created instance.

Throws
`androidx.media3.exoplayer.drm.UnsupportedDrmException`	If the DRM scheme is unsupported or cannot be instantiated.

openSession

@UnstableApi
fun openSession(): ByteArray<Byte>!

Opens a new DRM session. A session ID is returned.

Returns
`ByteArray<Byte>!`	The session ID.

Throws
`android.media.NotProvisionedException`	If provisioning is needed.
`android.media.ResourceBusyException`	If required resources are in use.
`android.media.MediaDrmException`	If the session could not be opened.

provideKeyResponse

@UnstableApi
fun provideKeyResponse(scope: ByteArray!, response: ByteArray!): ByteArray<Byte>?

Provides a key response for the last request to be generated using getKeyRequest.

Parameters
`scope: ByteArray!`	If the request had type `KEY_TYPE_STREAMING` or `KEY_TYPE_OFFLINE`, the ID of the session to provide the keys to. If `keyType` is `KEY_TYPE_RELEASE`, the `keySetId` of the keys being released.
`response: ByteArray!`	The response data from the server.

Returns
`ByteArray<Byte>?`	If the request had type `KEY_TYPE_OFFLINE`, the `keySetId` for the offline keys. An empty byte array or `null` may be returned for other cases.

Throws
`android.media.NotProvisionedException`	If the response indicates that provisioning is needed.
`android.media.DeniedByServerException`	If the response indicates that the server rejected the request.

provideProvisionResponse

@UnstableApi
fun provideProvisionResponse(response: ByteArray!): Unit

Provides a provisioning response for the last request to be generated using getProvisionRequest.

Parameters
`response: ByteArray!`	The response data from the server.

Throws
`android.media.DeniedByServerException`	If the response indicates that the server rejected the request.

queryKeyStatus

@UnstableApi
fun queryKeyStatus(sessionId: ByteArray!): (Mutable)Map<String!, String!>!

Returns the key status for a given session, as {name, value} pairs. Since DRM license policies vary by vendor, the returned entries depend on the DRM plugin being used. Refer to your DRM provider's documentation for more information.

Parameters
`sessionId: ByteArray!`	The ID of the session being queried.

Returns
`(Mutable)Map<String!, String!>!`	The key status for the session.

release

@UnstableApi
synchronized fun release(): Unit

Decrements the reference count. If the reference count drops to 0 underlying resources are released, and the instance cannot be re-used.

removeOfflineLicense

@UnstableApi
@RequiresApi(value = 29)
fun removeOfflineLicense(keySetId: ByteArray!): Unit

Removes an offline license.

This method is generally not needed, and should only be used if the preferred approach of generating a license release request by passing KEY_TYPE_RELEASE to getKeyRequest is not possible.

This is an optional method, and some implementations may only support it on certain Android API levels.

See removeOfflineLicense for more details.

Parameters
`keySetId: ByteArray!`	The `keySetId` of the license to remove.

Throws
`java.lang.UnsupportedOperationException`	if the implementation doesn't support this method.

requiresSecureDecoder

@UnstableApi
fun requiresSecureDecoder(sessionId: ByteArray!, mimeType: String!): Boolean

Returns whether the given session requires use of a secure decoder for the given MIME type. Assumes a license policy that requires the highest level of security supported by the session.

Parameters
`sessionId: ByteArray!`	The ID of the session.
`mimeType: String!`	The content MIME type to query.

restoreKeys

@UnstableApi
fun restoreKeys(sessionId: ByteArray!, keySetId: ByteArray!): Unit

Restores persisted offline keys into a session.

Parameters
`sessionId: ByteArray!`	The ID of the session into which the keys will be restored.
`keySetId: ByteArray!`	The `keySetId` of the keys to restore, as provided by the call to `provideKeyResponse` that persisted them.

setOnEventListener

@UnstableApi
fun setOnEventListener(listener: ExoMediaDrm.OnEventListener?): Unit

Sets the listener for DRM events.

This is an optional method, and some implementations may only support it on certain Android API levels.

Parameters
`listener: ExoMediaDrm.OnEventListener?`	The listener to receive events, or `null` to stop receiving events.

Throws
`java.lang.UnsupportedOperationException`	if the implementation doesn't support this method.

See also
`setOnEventListener`

setOnExpirationUpdateListener

@UnstableApi
fun setOnExpirationUpdateListener(
    listener: ExoMediaDrm.OnExpirationUpdateListener?
): Unit

Sets the listener for session expiration events.

This is an optional method, and some implementations may only support it on certain Android API levels.

Parameters
`listener: ExoMediaDrm.OnExpirationUpdateListener?`	The listener to receive events, or `null` to stop receiving events.

Throws
`java.lang.UnsupportedOperationException`	if the implementation doesn't support this method.

See also
`setOnExpirationUpdateListener`

setOnKeyStatusChangeListener

@UnstableApi
fun setOnKeyStatusChangeListener(
    listener: ExoMediaDrm.OnKeyStatusChangeListener?
): Unit

Sets the listener for key status change events.

This is an optional method, and some implementations may only support it on certain Android API levels.

Parameters
`listener: ExoMediaDrm.OnKeyStatusChangeListener?`	The listener to receive events, or `null` to stop receiving events.

Throws
`java.lang.UnsupportedOperationException`	if the implementation doesn't support this method.

See also
`setOnKeyStatusChangeListener`

setPlayerIdForSession

@UnstableApi
fun setPlayerIdForSession(sessionId: ByteArray!, playerId: PlayerId!): Unit

Sets the PlayerId of the player using a session.

Parameters
`sessionId: ByteArray!`	The ID of the session.
`playerId: PlayerId!`	The `PlayerId` of the player using the session.

setPropertyByteArray

@UnstableApi
fun setPropertyByteArray(propertyName: String!, value: ByteArray!): Unit

Sets the value of a byte array property.

Parameters
`propertyName: String!`	The property name.
`value: ByteArray!`	The value.

Throws
`java.lang.IllegalArgumentException`	If the underlying DRM plugin does not support the property.

setPropertyString

@UnstableApi
fun setPropertyString(propertyName: String!, value: String!): Unit

Sets the value of a string property.

Parameters
`propertyName: String!`	The property name.
`value: String!`	The value.

Throws
`java.lang.IllegalArgumentException`	If the underlying DRM plugin does not support the property.