Added in API level 11
Deprecated in API level 30

DrmManagerClient

Kotlin |Java

open class DrmManagerClient : AutoCloseable

kotlin.Any
↳	android.drm.DrmManagerClient

The main programming interface for the DRM framework. An application must instantiate this class to access DRM agents through the DRM framework.

Summary

Nested classes
abstract	`OnErrorListener` Interface definition for a callback that receives information about DRM framework errors.
abstract	`OnEventListener` Interface definition for a callback that receives information about DRM processing events.
abstract	`OnInfoListener` Interface definition for a callback that receives status messages and warnings during registration and rights acquisition.

Constants
static Int	`ERROR_NONE` Indicates that a request was successful or that no error occurred.
static Int	`ERROR_UNKNOWN` Indicates that an error occurred and the reason is not known.

Public constructors
`DrmManagerClient(context: Context!)` Creates a `DrmManagerClient`.

Public methods
open DrmInfo!	`acquireDrmInfo(drmInfoRequest: DrmInfoRequest!)` Retrieves information for registering, unregistering, or acquiring rights.
open Int	`acquireRights(drmInfoRequest: DrmInfoRequest!)` Processes a given `DrmInfoRequest` and returns the rights information asynchronously.
open Boolean	`canHandle(uri: Uri!, mimeType: String!)` Checks whether the given MIME type or URI can be handled.
open Boolean	`canHandle(path: String!, mimeType: String!)` Checks whether the given MIME type or path can be handled.
open Int	`checkRightsStatus(uri: Uri!)` Check whether the given content has valid rights.
open Int	`checkRightsStatus(uri: Uri!, action: Int)` Checks whether the given rights-protected content has valid rights for the specified `DrmStore.Action`.
open Int	`checkRightsStatus(path: String!)` Checks whether the given content has valid rights.
open Int	`checkRightsStatus(path: String!, action: Int)` Checks whether the given rights-protected content has valid rights for the specified `DrmStore.Action`.
open Unit	`close()` Releases resources associated with the current session of DrmManagerClient.
open DrmConvertedStatus!	`closeConvertSession(convertId: Int)` Informs the DRM plug-in (agent) that there is no more data to convert or that an error has occurred.
open DrmConvertedStatus!	`convertData(convertId: Int, inputData: ByteArray!)` Converts the input data (content) that is part of a rights-protected file.
open Array<String!>!	`getAvailableDrmEngines()` Retrieves information about all the DRM plug-ins (agents) that are registered with the DRM framework.
open MutableCollection<DrmSupportInfo!>	`getAvailableDrmSupportInfo()` Retrieves information about all the DRM plug-ins (agents) that are registered with the DRM framework.
open ContentValues!	`getConstraints(uri: Uri!, action: Int)` Retrieves constraint information for rights-protected content.
open ContentValues!	`getConstraints(path: String!, action: Int)` Retrieves constraint information for rights-protected content.
open Int	`getDrmObjectType(uri: Uri!, mimeType: String!)` Retrieves the type of rights-protected object (for example, content object, rights object, and so on) using the specified URI or MIME type.
open Int	`getDrmObjectType(path: String!, mimeType: String!)` Retrieves the type of rights-protected object (for example, content object, rights object, and so on) using the specified path or MIME type.
open ContentValues!	`getMetadata(uri: Uri!)` Retrieves metadata information for rights-protected content.
open ContentValues!	`getMetadata(path: String!)` Retrieves metadata information for rights-protected content.
open String!	`getOriginalMimeType(uri: Uri!)` Retrieves the MIME type embedded in the original content.
open String!	`getOriginalMimeType(path: String!)` Retrieves the MIME type embedded in the original content.
open Int	`openConvertSession(mimeType: String!)` Initiates a new conversion session.
open Int	`processDrmInfo(drmInfo: DrmInfo!)` Processes the given DRM information based on the information type.
open Unit	`release()`
open Int	`removeAllRights()` Removes all the rights information of every DRM plug-in (agent) associated with the DRM framework.
open Int	`removeRights(uri: Uri!)` Removes the rights associated with the given rights-protected content.
open Int	`removeRights(path: String!)` Removes the rights associated with the given rights-protected content.
open Int	`saveRights(drmRights: DrmRights!, rightsPath: String!, contentPath: String!)` Saves rights to a specified path and associates that path with the content path.
open Unit	`setOnErrorListener(errorListener: DrmManagerClient.OnErrorListener!)` Registers an `DrmManagerClient.OnErrorListener` callback, which is invoked when the DRM framework sends error information.
open Unit	`setOnEventListener(eventListener: DrmManagerClient.OnEventListener!)` Registers an `DrmManagerClient.OnEventListener` callback, which is invoked when the DRM framework sends information about DRM processing.
open Unit	`setOnInfoListener(infoListener: DrmManagerClient.OnInfoListener!)` Registers an `DrmManagerClient.OnInfoListener` callback, which is invoked when the DRM framework sends status or warning information during registration or rights acquisition.

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

Constants

ERROR_NONE

Added in API level 11

static val ERROR_NONE: Int

Deprecated: Deprecated in Java.

Indicates that a request was successful or that no error occurred.

Value: 0

ERROR_UNKNOWN

Added in API level 11

static val ERROR_UNKNOWN: Int

Deprecated: Deprecated in Java.

Indicates that an error occurred and the reason is not known.

Value: -2000

Public constructors

DrmManagerClient

Added in API level 11

DrmManagerClient(context: Context!)

Creates a DrmManagerClient.

Parameters
`context`	Context!: Context of the caller.

Public methods

acquireDrmInfo

Added in API level 11

open fun acquireDrmInfo(drmInfoRequest: DrmInfoRequest!): DrmInfo!

Deprecated: Deprecated in Java.

Retrieves information for registering, unregistering, or acquiring rights.

Parameters
`drmInfoRequest`	DrmInfoRequest!: The `DrmInfoRequest` that specifies the type of DRM information being retrieved.

Return
`DrmInfo!`	A `DrmInfo` instance.

acquireRights

Added in API level 11

open fun acquireRights(drmInfoRequest: DrmInfoRequest!): Int

Deprecated: Deprecated in Java.

Processes a given DrmInfoRequest and returns the rights information asynchronously.

This is a utility method that consists of an acquireDrmInfo() and a processDrmInfo() method call. This utility method can be used only if the selected DRM plug-in (agent) supports this sequence of calls. Some DRM agents, such as OMA, do not support this utility method, in which case an application must invoke acquireDrmInfo() and processDrmInfo() separately.

Parameters
`drmInfoRequest`	DrmInfoRequest!: The `DrmInfoRequest` used to acquire the rights.

Return
`Int`	ERROR_NONE for success; ERROR_UNKNOWN for failure.

canHandle

Added in API level 11

open fun canHandle(
    uri: Uri!, 
    mimeType: String!
): Boolean

Deprecated: Deprecated in Java.

Checks whether the given MIME type or URI can be handled.

Parameters
`uri`	Uri!: URI for the content to be handled.
`mimeType`	String!: MIME type of the object to be handled

Return
`Boolean`	True if the given MIME type or URI can be handled; false if they cannot be handled.

canHandle

Added in API level 11

open fun canHandle(
    path: String!, 
    mimeType: String!
): Boolean

Deprecated: Deprecated in Java.

Checks whether the given MIME type or path can be handled.

Parameters
`path`	String!: Path of the content to be handled.
`mimeType`	String!: MIME type of the object to be handled.

Return
`Boolean`	True if the given MIME type or path can be handled; false if they cannot be handled.

checkRightsStatus

Added in API level 11

open fun checkRightsStatus(uri: Uri!): Int

Deprecated: Deprecated in Java.

Check whether the given content has valid rights.

Parameters
`uri`	Uri!: URI of the rights-protected content.

Return
`Int`	An `int` representing the `DrmStore.RightsStatus` of the content.

checkRightsStatus

Added in API level 11

open fun checkRightsStatus(
    uri: Uri!, 
    action: Int
): Int

Deprecated: Deprecated in Java.

Checks whether the given rights-protected content has valid rights for the specified DrmStore.Action.

Parameters
`uri`	Uri!: URI for the rights-protected content.
`action`	Int: The `DrmStore.Action` to perform.

Return
`Int`	An `int` representing the `DrmStore.RightsStatus` of the content.

checkRightsStatus

Added in API level 11

open fun checkRightsStatus(path: String!): Int

Deprecated: Deprecated in Java.

Checks whether the given content has valid rights.

Parameters
`path`	String!: Path to the rights-protected content.

Return
`Int`	An `int` representing the `DrmStore.RightsStatus` of the content.

checkRightsStatus

Added in API level 11

open fun checkRightsStatus(
    path: String!, 
    action: Int
): Int

Deprecated: Deprecated in Java.

Checks whether the given rights-protected content has valid rights for the specified DrmStore.Action.

Parameters
`path`	String!: Path to the rights-protected content.
`action`	Int: The `DrmStore.Action` to perform.

Return
`Int`	An `int` representing the `DrmStore.RightsStatus` of the content.

close

Added in API level 24
Deprecated in API level 30

open fun close(): Unit

Deprecated: Deprecated in Java.

Releases resources associated with the current session of DrmManagerClient. It is considered good practice to call this method when the DrmManagerClient object is no longer n