FrameworkMediaDrm

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

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

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

Closes a DRM session.

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

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

Returns the type of CryptoConfig instances returned by createCryptoConfig.

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

Generates a key request.

@UnstableApi
fun getMetrics(): PersistableBundle?

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

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

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

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

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

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

@UnstableApi
fun getProvisionRequest(): ExoMediaDrm.ProvisionRequest!

Generates a provisioning request.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Restores persisted offline keys into a session.

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

@UnstableApi
@RequiresApi(value = 23)
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.

@UnstableApi
@RequiresApi(value = 23)
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.

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

Sets the PlayerId of the player using a session.

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

Sets the value of a byte array property.

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

Sets the value of a string property.