DrmManagerClient

ERROR_NONE

public static final int ERROR_NONE

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

Constant Value: 0 (0x00000000)

ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

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

Constant Value: -2000 (0xfffff830)

DrmManagerClient

public DrmManagerClient (Context context)

Creates a DrmManagerClient.

acquireDrmInfo

public DrmInfo acquireDrmInfo (DrmInfoRequest drmInfoRequest)

Retrieves information for registering, unregistering, or acquiring rights.

acquireRights

public int acquireRights (DrmInfoRequest drmInfoRequest)

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.

canHandle

public boolean canHandle (String path, 
                String mimeType)

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

canHandle

public boolean canHandle (Uri uri, 
                String mimeType)

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

checkRightsStatus

public int checkRightsStatus (String path)

Checks whether the given content has valid rights.

checkRightsStatus

public int checkRightsStatus (Uri uri)

Check whether the given content has valid rights.

checkRightsStatus

public int checkRightsStatus (String path, 
                int action)

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

checkRightsStatus

public int checkRightsStatus (Uri uri, 
                int action)

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

close

public void close ()

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 needed in your application. After this method is called, DrmManagerClient is no longer usable since it has lost all of its required resource. This method was added in API 24. In API versions 16 through 23, release() should be called instead. There is no need to do anything for API versions prior to 16.

closeConvertSession

public DrmConvertedStatus closeConvertSession (int convertId)

Informs the DRM plug-in (agent) that there is no more data to convert or that an error has occurred. Upon successful conversion of the data, the DRM agent will provide an offset value indicating where the header and body signature should be added. Appending the signature is necessary to protect the integrity of the converted file.

convertData

public DrmConvertedStatus convertData (int convertId, 
                byte[] inputData)

Converts the input data (content) that is part of a rights-protected file. The converted data and status is returned in a DrmConvertedStatus object. This method should be called each time there is a new block of data received by the application.

getAvailableDrmEngines

public String[] getAvailableDrmEngines ()

Retrieves information about all the DRM plug-ins (agents) that are registered with the DRM framework.

getAvailableDrmSupportInfo

public Collection<DrmSupportInfo> getAvailableDrmSupportInfo ()

Retrieves information about all the DRM plug-ins (agents) that are registered with the DRM framework.

getConstraints

public ContentValues getConstraints (String path, 
                int action)

Retrieves constraint information for rights-protected content.

getConstraints

public ContentValues getConstraints (Uri uri, 
                int action)

Retrieves constraint information for rights-protected content.

getDrmObjectType

public int getDrmObjectType (Uri uri, 
                String mimeType)

Retrieves the type of rights-protected object (for example, content object, rights object, and so on) using the specified URI or MIME type. At least one parameter must be specified to retrieve the DRM object type.

getDrmObjectType

public int getDrmObjectType (String path, 
                String mimeType)

Retrieves the type of rights-protected object (for example, content object, rights object, and so on) using the specified path or MIME type. At least one parameter must be specified to retrieve the DRM object type.

getMetadata

public ContentValues getMetadata (String path)

Retrieves metadata information for rights-protected content.

getMetadata

public ContentValues getMetadata (Uri uri)

Retrieves metadata information for rights-protected content.

getOriginalMimeType

public String getOriginalMimeType (Uri uri)

Retrieves the MIME type embedded in the original content.

getOriginalMimeType

public String getOriginalMimeType (String path)

Retrieves the MIME type embedded in the original content.

openConvertSession

public int openConvertSession (String mimeType)

Initiates a new conversion session. An application must initiate a conversion session with this method each time it downloads a rights-protected file that needs to be converted.

This method applies only to forward-locking (copy protection) DRM schemes.

processDrmInfo

public int processDrmInfo (DrmInfo drmInfo)

Processes the given DRM information based on the information type.

release

public void release ()

This method was deprecated in API level 24.
replaced by close().

removeAllRights

public int removeAllRights ()

Removes all the rights information of every DRM plug-in (agent) associated with the DRM framework.

removeRights

public int removeRights (String path)

Removes the rights associated with the given rights-protected content.

removeRights

public int removeRights (Uri uri)

Removes the rights associated with the given rights-protected content.

saveRights

public int saveRights (DrmRights drmRights, 
                String rightsPath, 
                String contentPath)

Saves rights to a specified path and associates that path with the content path.

Note: For OMA or WM-DRM, rightsPath and contentPath can be null.

setOnErrorListener

public void setOnErrorListener (DrmManagerClient.OnErrorListener errorListener)

Registers an DrmManagerClient.OnErrorListener callback, which is invoked when the DRM framework sends error information.

setOnEventListener

public void setOnEventListener (DrmManagerClient.OnEventListener eventListener)

Registers an DrmManagerClient.OnEventListener callback, which is invoked when the DRM framework sends information about DRM processing.

setOnInfoListener

public void setOnInfoListener (DrmManagerClient.OnInfoListener infoListener)

Registers an DrmManagerClient.OnInfoListener callback, which is invoked when the DRM framework sends status or warning information during registration or rights acquisition.

finalize

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.