xref: /docs/en/application-dev/reference/apis-drm-kit/_drm.md (revision e41f4b71)

# Drm


## Overview

The Digital Rights Management (DRM) module provides C APIs to implement digital rights protection.

**Since**: 11


## Summary


### Files

| Name| Description| 
| -------- | -------- |
| [native_drm_common.h](native__drm__common_8h.md) | Declares the DRM data types.| 
| [native_drm_err.h](native__drm__err_8h.md) | Declares the DRM error codes.| 
| [native_mediakeysession.h](native__mediakeysession_8h.md) | Declares the **MediaKeySession** APIs.| 
| [native_mediakeysystem.h](native__mediakeysystem_8h.md) | Declares the **MediaKeySystem** APIs.| 


### Structs

| Name| Description| 
| -------- | -------- |
| struct  [DRM_MediaKeyRequestInfo](_d_r_m___media_key_request_info.md) | Describes the information about a media key request.| 
| struct  [DRM_MediaKeyRequest](_d_r_m___media_key_request.md) | Describes a media key request.| 
| struct  [DRM_Statistics](_d_r_m___statistics.md) | Describes the statistical information of a media key system.| 
| struct  [DRM_OfflineMediakeyIdArray](_d_r_m___offline_mediakey_id_array.md) | Describes an array holding the IDs of offline media keys.| 
| struct  [DRM_KeysInfo](_d_r_m___keys_info.md) | Describes the information about media keys.| 
| struct  [DRM_MediaKeyStatus](_d_r_m___media_key_status.md) | Describes the media key status.| 
| struct  [DRM_PsshInfo](_d_r_m___pssh_info.md) | Describes the Protection System Specific Header (PSSH) in DRM information.| 
| struct  [DRM_MediaKeySystemInfo](_d_r_m___media_key_system_info.md) | Describes the DRM information, which is used to encrypt content.| 
| struct  [MediaKeySession_Callback](_media_key_session___callback.md) | Describes a media key session callback, which is used to listen for events such as key changes. This struct applies to the scenario where a single media file is decrypted.| 
| struct  [OH_MediaKeySession_Callback](_o_h___media_key_session___callback.md) | Describes a media key session callback, which is used to listen for events such as key changes. This struct applies to the scenario where multiple media files are decrypted.| 
| struct  [DRM_MediaKeySystemDescription](_d_r_m___media_key_system_description.md) | Describes the DRM scheme name and UUID list. | 


### Macros

| Name| Description| 
| -------- | -------- |
| [MAX_MEDIA_KEY_REQUEST_OPTION_COUNT](#max_media_key_request_option_count)   16 | Maximum number of optional data items in a media key request.| 
| [MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN](#max_media_key_request_option_name_len)   64 | Maximum length of an optional data name in a media key request.| 
| [MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN](#max_media_key_request_option_data_len)   128 | Maximum length of optional data in a media key request.| 
| [MAX_INIT_DATA_LEN](#max_init_data_len)   2048 | Maximum length of data in an initial request.| 
| [MAX_MIMETYPE_LEN](#max_mimetype_len)   64 | Maximum length of a MIME type.| 
| [MAX_MEDIA_KEY_REQUEST_DATA_LEN](#max_media_key_request_data_len)   8192 | Maximum length of data in a media key request.| 
| [MAX_DEFAULT_URL_LEN](#max_default_url_len)   2048 | Maximum length of a URL.| 
| [MAX_STATISTICS_COUNT](#max_statistics_count)   10 | Maximum number of statistical items.| 
| [MAX_STATISTICS_NAME_LEN](#max_statistics_name_len)   64 | Maximum length of a statistical item name.| 
| [MAX_STATISTICS_BUFFER_LEN](#max_statistics_buffer_len)   256 | Maximum length of a statistical item buffer.| 
| [MAX_OFFLINE_MEDIA_KEY_ID_COUNT](#max_offline_media_key_id_count)   512 | Maximum number of offline media key IDs.| 
| [MAX_OFFLINE_MEDIA_KEY_ID_LEN](#max_offline_media_key_id_len)   64 | Maximum length of an offline media key ID.| 
| [MAX_KEY_INFO_COUNT](#max_key_info_count)   64 | Maximum number of pieces of media key information.| 
| [MAX_KEY_ID_LEN](#max_key_id_len)   16 | Maximum length of a media key ID.| 
| [MAX_KEY_STATUS_VALUE_LEN](#max_key_status_value_len)   128 | Maximum length of a key status value.| 
| [MAX_MEDIA_KEY_STATUS_COUNT](#max_media_key_status_count)   64 | Maximum number of media key statuses.| 
| [MAX_MEDIA_KEY_STATUS_NAME_LEN](#max_media_key_status_name_len)   64 | Maximum length of a media key status name.| 
| [MAX_MEDIA_KEY_STATUS_VALUE_LEN](#max_media_key_status_value_len)   256 | Maximum length of a media key status value.| 
| [DRM_UUID_LEN](#drm_uuid_len)   16 | Length of the UUID of a DRM scheme.| 
| [MAX_PSSH_DATA_LEN](#max_pssh_data_len)   2048 | Maximum length of PSSH data.| 
| [MAX_PSSH_INFO_COUNT](#max_pssh_info_count)   8 | Maximum number of pieces of PSSH data.| 
| [MAX_MEDIA_KEY_SYSTEM_NAME_LEN](#max_media_key_system_name_len)   128 | Maximum length of a **MediaKeySystem** instance name. | 
| [MAX_MEDIA_KEY_SYSTEM_NUM](#max_media_key_system_num)   8 | Maximum number of **MediaKeySystem** instances. | 


### Types

| Name| Description| 
| -------- | -------- |
| typedef enum [DRM_EventType](#drm_eventtype-1) [DRM_EventType](#drm_eventtype) | Defines an enum for the types of events that can be subscribed to.| 
| typedef enum [DRM_ContentProtectionLevel](#drm_contentprotectionlevel-1) [DRM_ContentProtectionLevel](#drm_contentprotectionlevel) | Defines an enum for the content protection levels.| 
| typedef enum [DRM_MediaKeyType](#drm_mediakeytype-1) [DRM_MediaKeyType](#drm_mediakeytype) | Defines an enum for the types of media keys.| 
| typedef enum [DRM_MediaKeyRequestType](#drm_mediakeyrequesttype-1) [DRM_MediaKeyRequestType](#drm_mediakeyrequesttype) | Defines an enum for the types of media key requests.| 
| typedef enum [DRM_OfflineMediaKeyStatus](#drm_offlinemediakeystatus-1) [DRM_OfflineMediaKeyStatus](#drm_offlinemediakeystatus) | Defines an enum for the statuses of offline media keys.| 
| typedef enum [DRM_CertificateStatus](#drm_certificatestatus-1) [DRM_CertificateStatus](#drm_certificatestatus) | Defines an enum for the DRM certificate statuses.| 
| typedef struct [DRM_MediaKeyRequestInfo](_d_r_m___media_key_request_info.md) [DRM_MediaKeyRequestInfo](#drm_mediakeyrequestinfo) | Defines a struct for the information about a media key request.| 
| typedef struct [DRM_MediaKeyRequest](_d_r_m___media_key_request.md) [DRM_MediaKeyRequest](#drm_mediakeyrequest) | Defines a struct for a media key request.| 
| typedef struct [DRM_Statistics](_d_r_m___statistics.md) [DRM_Statistics](#drm_statistics) | Defines a struct for the statistical information of a media key system.| 
| typedef struct [DRM_OfflineMediakeyIdArray](_d_r_m___offline_mediakey_id_array.md) [DRM_OfflineMediakeyIdArray](#drm_offlinemediakeyidarray) | Defines a struct for the array holding the IDs of offline media keys.| 
| typedef struct [DRM_KeysInfo](_d_r_m___keys_info.md) [DRM_KeysInfo](#drm_keysinfo) | Defines a struct for the information about media keys.| 
| typedef struct [DRM_MediaKeyStatus](_d_r_m___media_key_status.md) [DRM_MediaKeyStatus](#drm_mediakeystatus) | Defines a struct for the media key status.| 
| typedef struct [DRM_PsshInfo](_d_r_m___pssh_info.md) [DRM_PsshInfo](#drm_psshinfo) | Defines a struct for PSSH data in DRM information.| 
| typedef struct [DRM_MediaKeySystemInfo](_d_r_m___media_key_system_info.md) [DRM_MediaKeySystemInfo](#drm_mediakeysysteminfo) | Defines a struct for the DRM information, which is used to encrypt content.| 
| typedef struct [DRM_MediaKeySystemDescription](_d_r_m___media_key_system_description.md) [DRM_MediaKeySystemDescription](#drm_mediakeysystemdescription) | Defines a struct for the DRM scheme name and UUID list. | 
| typedef void(\* [DRM_MediaKeySystemInfoCallback](#drm_mediakeysysteminfocallback)) ([DRM_MediaKeySystemInfo](_d_r_m___media_key_system_info.md) \*mediaKeySystemInfo) | Defines a callback for media key system information.| 
| typedef struct [MediaKeySystem](#mediakeysystem) [MediaKeySystem](#mediakeysystem) | Defines a struct for a media key system.| 
| typedef struct [MediaKeySession](#mediakeysession) [MediaKeySession](#mediakeysession) | Defines a struct for a media key session.| 
| typedef enum [Drm_ErrCode](#drm_errcode-1) [Drm_ErrCode](#drm_errcode) | Defines an enum for the DRM error codes.| 
| typedef [Drm_ErrCode](#drm_errcode)(\* [MediaKeySession_EventCallback](#mediakeysession_eventcallback)) ([DRM_EventType](#drm_eventtype) eventType, uint8_t \*info, int32_t infoLen, char \*extra) | Defines the callback that is invoked when a media key session event is triggered. No **MediaKeySession** instance is returned. This callback applies to the scenario where a single media file is decrypted.| 
| typedef [Drm_ErrCode](#drm_errcode)(\* [MediaKeySession_KeyChangeCallback](#mediakeysession_keychangecallback)) ([DRM_KeysInfo](_d_r_m___keys_info.md) \*keysInfo, bool newKeysAvailable) | Defines the callback that is invoked when the media key in a **MediaKeySession** instance is changed. No **MediaKeySession** instance is returned. This callback applies to the scenario where a single media file is decrypted.| 
| typedef struct [MediaKeySession_Callback](_media_key_session___callback.md) [MediaKeySession_Callback](#mediakeysession_callback) | Defines a struct for the media key session callback. This struct applies to the scenario where a single media file is decrypted.| 
| typedef [Drm_ErrCode](#drm_errcode)(\* [OH_MediaKeySession_EventCallback](#oh_mediakeysession_eventcallback)) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, [DRM_EventType](#drm_eventtype) eventType, uint8_t \*info, int32_t infoLen, char \*extra) | Defines the callback that is invoked when a media key session event is triggered. A **MediaKeySession** instance is returned. This callback applies to the scenario where multiple media files are decrypted.| 
| typedef [Drm_ErrCode](#drm_errcode)(\* [OH_MediaKeySession_KeyChangeCallback](#oh_mediakeysession_keychangecallback)) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, [DRM_KeysInfo](_d_r_m___keys_info.md) \*keysInfo, bool newKeysAvailable) | Defines the callback that is invoked when the media key in a **MediaKeySession** instance is changed. A **MediaKeySession** instance is returned. This callback applies to the scenario where multiple media files are decrypted.| 
| typedef struct [OH_MediaKeySession_Callback](_o_h___media_key_session___callback.md) [OH_MediaKeySession_Callback](#oh_mediakeysession_callback) | Defines a struct for the media key session callback. This struct applies to the scenario where multiple media files are decrypted.| 
| typedef [Drm_ErrCode](#drm_errcode)(\* [MediaKeySystem_Callback](#mediakeysystem_callback)) ([DRM_EventType](#drm_eventtype) eventType, uint8_t \*info, int32_t infoLen, char \*extra) | Defines the callback that is invoked when a media key system event is triggered. No **MediaKeySystem** instance is returned. This callback applies to the scenario where a single **MediaKeySystem** instance is used.| 
| typedef [Drm_ErrCode](#drm_errcode)(\* [OH_MediaKeySystem_Callback](#oh_mediakeysystem_callback)) (MediaKeySystem \*mediaKeySystem, [DRM_EventType](#drm_eventtype) eventType, uint8_t \*info, int32_t infoLen, char \*extra) | Defines the callback that is invoked when a media key system event is triggered. A **MediaKeySystem** instance is returned. This callback applies to the scenario where multiple **MediaKeySystem** instances are used.| 


### Enums

| Name| Description| 
| -------- | -------- |
| [DRM_EventType](#drm_eventtype-1) {<br>EVENT_DRM_BASE = 200, <br>EVENT_PROVISION_REQUIRED = 201, <br>EVENT_KEY_REQUIRED = 202, <br>EVENT_KEY_EXPIRED = 203,<br>EVENT_VENDOR_DEFINED = 204, <br>EVENT_EXPIRATION_UPDATE = 206<br>} | Enumerates the event types.| 
| [DRM_ContentProtectionLevel](#drm_contentprotectionlevel-1) {<br>CONTENT_PROTECTION_LEVEL_UNKNOWN = 0, <br>CONTENT_PROTECTION_LEVEL_SW_CRYPTO, <br>CONTENT_PROTECTION_LEVEL_HW_CRYPTO, <br>CONTENT_PROTECTION_LEVEL_ENHANCED_HW_CRYPTO,<br>CONTENT_PROTECTION_LEVEL_MAX<br>} | Enumerates the content protection levels.| 
| [DRM_MediaKeyType](#drm_mediakeytype-1) { <br>MEDIA_KEY_TYPE_OFFLINE = 0, <br>MEDIA_KEY_TYPE_ONLINE <br>} | Enumerates the types of media keys.| 
| [DRM_MediaKeyRequestType](#drm_mediakeyrequesttype-1) {<br>MEDIA_KEY_REQUEST_TYPE_UNKNOWN = 0, <br>MEDIA_KEY_REQUEST_TYPE_INITIAL, <br>MEDIA_KEY_REQUEST_TYPE_RENEWAL, <br>MEDIA_KEY_REQUEST_TYPE_RELEASE,<br>MEDIA_KEY_REQUEST_TYPE_NONE, <br>MEDIA_KEY_REQUEST_TYPE_UPDATE<br>} | Enumerates the types of media key requests.| 
| [DRM_OfflineMediaKeyStatus](#drm_offlinemediakeystatus-1) { <br>OFFLINE_MEDIA_KEY_STATUS_UNKNOWN = 0, <br>OFFLINE_MEDIA_KEY_STATUS_USABLE, <br>OFFLINE_MEDIA_KEY_STATUS_INACTIVE } | Enumerates the statuses of offline media keys.| 
| [DRM_CertificateStatus](#drm_certificatestatus-1) {<br>CERT_STATUS_PROVISIONED = 0, <br>CERT_STATUS_NOT_PROVISIONED, <br>CERT_STATUS_EXPIRED, <br>CERT_STATUS_INVALID,<br>CERT_STATUS_UNAVAILABLE<br>} | Enumerates the DRM certificate statuses.| 
| [Drm_ErrCode](#drm_errcode-1) {<br>DRM_ERR_OK = 0, <br>DRM_CAPI_ERR_BASE = 24700500, <br>DRM_ERR_NO_MEMORY = DRM_CAPI_ERR_BASE + 1, <br>DRM_ERR_OPERATION_NOT_PERMITTED = DRM_CAPI_ERR_BASE + 2,<br>DRM_ERR_INVALID_VAL = DRM_CAPI_ERR_BASE + 3, <br>DRM_ERR_IO = DRM_CAPI_ERR_BASE + 4, <br>DRM_ERR_TIMEOUT = DRM_CAPI_ERR_BASE + 5, <br>DRM_ERR_UNKNOWN = DRM_CAPI_ERR_BASE + 6,<br>DRM_ERR_SERVICE_DIED = DRM_CAPI_ERR_BASE + 7, <br>DRM_ERR_INVALID_STATE = DRM_CAPI_ERR_BASE + 8, <br>DRM_ERR_UNSUPPORTED = DRM_CAPI_ERR_BASE + 9, <br>DRM_ERR_MAX_SYSTEM_NUM_REACHED = DRM_CAPI_ERR_BASE + 10,<br>DRM_ERR_MAX_SESSION_NUM_REACHED = DRM_CAPI_ERR_BASE + 11, <br>DRM_ERR_EXTEND_START = DRM_CAPI_ERR_BASE + 100<br>} | Enumerates the DRM error codes.| 


### Functions

| Name| Description| 
| -------- | -------- |
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_GenerateMediaKeyRequest](#oh_mediakeysession_generatemediakeyrequest) ([MediaKeySession](#mediakeysession) \*mediaKeySession, [DRM_MediaKeyRequestInfo](_d_r_m___media_key_request_info.md) \*info, [DRM_MediaKeyRequest](_d_r_m___media_key_request.md) \*mediaKeyRequest) | Generates a media key request.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_ProcessMediaKeyResponse](#oh_mediakeysession_processmediakeyresponse) ([MediaKeySession](#mediakeysession) \*mediaKeySession, uint8_t \*response, int32_t responseLen, uint8_t \*offlineMediaKeyId, int32_t \*offlineMediaKeyIdLen) | Processes a media key response.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_CheckMediaKeyStatus](#oh_mediakeysession_checkmediakeystatus) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, [DRM_MediaKeyStatus](_d_r_m___media_key_status.md) \*mediaKeyStatus) | Checks the status of media keys.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_ClearMediaKeys](#oh_mediakeysession_clearmediakeys) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin) | Clears media keys.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_GenerateOfflineReleaseRequest](#oh_mediakeysession_generateofflinereleaserequest) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, uint8_t \*offlineMediaKeyId, int32_t offlineMediaKeyIdLen, uint8_t \*releaseRequest, int32_t \*releaseRequestLen) | Generates a request to release offline media keys.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_ProcessOfflineReleaseResponse](#oh_mediakeysession_processofflinereleaseresponse) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, uint8_t \*offlineMediaKeyId, int32_t offlineMediaKeyIdLen, uint8_t \*releaseReponse, int32_t releaseReponseLen) | Processes a response to a request for releasing offline media keys.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_RestoreOfflineMediaKeys](#oh_mediakeysession_restoreofflinemediakeys) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, uint8_t \*offlineMediaKeyId, int32_t offlineMediaKeyIdLen) | Restores offline media keys.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_GetContentProtectionLevel](#oh_mediakeysession_getcontentprotectionlevel) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, [DRM_ContentProtectionLevel](#drm_contentprotectionlevel) \*contentProtectionLevel) | Obtains the content protection level of a media key session.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_RequireSecureDecoderModule](#oh_mediakeysession_requiresecuredecodermodule) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, const char \*mimeType, bool \*status) | Checks whether secure decoding is required.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_SetMediaKeySessionCallback](#oh_mediakeysession_setmediakeysessioncallback) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, [MediaKeySession_Callback](_media_key_session___callback.md) \*callback) | Sets a media key session event callback. It applies to the scenario where a single media file is decrypted.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_SetCallback](#oh_mediakeysession_setcallback) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin, [OH_MediaKeySession_Callback](_o_h___media_key_session___callback.md) \*callback) | Sets a media key session event callback. It applies to the scenario where multiple media files are decrypted.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySession_Destroy](#oh_mediakeysession_destroy) ([MediaKeySession](#mediakeysession) \*mediaKeySessoin) | Releases a **MediaKeySession** instance.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_SetCallback](#oh_mediakeysystem_setcallback) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, [OH_MediaKeySystem_Callback](#oh_mediakeysystem_callback) callback) | Sets a media key system event callback.| 
| bool [OH_MediaKeySystem_IsSupported](#oh_mediakeysystem_issupported) (const char \*name) | Checks whether the device supports the specified DRM scheme.| 
| bool [OH_MediaKeySystem_IsSupported2](#oh_mediakeysystem_issupported2) (const char \*name, const char \*mimeType) | Checks whether the device supports the combination of the DRM scheme and MIME type.| 
| bool [OH_MediaKeySystem_IsSupported3](#oh_mediakeysystem_issupported3) (const char \*name, const char \*mimeType, [DRM_ContentProtectionLevel](#drm_contentprotectionlevel) contentProtectionLevel) | Checks whether the device supports the combination of the DRM scheme, MIME type, and content protection level.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GetMediaKeySystems](#oh_mediakeysystem_getmediakeysystems) ([DRM_MediaKeySystemDescription](#drm_mediakeysystemdescription) \*infos, uint32_t \*count) | Obtains the list of DRM schemes supported by the device.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_Create](#oh_mediakeysystem_create) (const char \*name, [MediaKeySystem](#mediakeysystem) \*\*mediaKeySystem) | Creates a **MediaKeySystem** instance.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_SetConfigurationString](#oh_mediakeysystem_setconfigurationstring) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, const char \*configName, const char \*value) | Sets a configuration item in the form of a string.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GetConfigurationString](#oh_mediakeysystem_getconfigurationstring) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, const char \*configName, char \*value, int32_t valueLen) | Obtains the value of a configuration item in the form of a string.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_SetConfigurationByteArray](#oh_mediakeysystem_setconfigurationbytearray) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, const char \*configName, uint8_t \*value, int32_t valueLen) | Sets a configuration item in the form of a byte array.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GetConfigurationByteArray](#oh_mediakeysystem_getconfigurationbytearray) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, const char \*configName, uint8_t \*value, int32_t \*valueLen) | Obtains the value of a configuration item in the form of a byte array.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GetStatistics](#oh_mediakeysystem_getstatistics) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, [DRM_Statistics](_d_r_m___statistics.md) \*statistics) | Obtains the statistical information of a media key system.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GetMaxContentProtectionLevel](#oh_mediakeysystem_getmaxcontentprotectionlevel) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, [DRM_ContentProtectionLevel](#drm_contentprotectionlevel) \*contentProtectionLevel) | Obtains the maximum content protection level supported by the current DRM scheme.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_SetMediaKeySystemCallback](#oh_mediakeysystem_setmediakeysystemcallback) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, [MediaKeySystem_Callback](#mediakeysystem_callback) callback) | Sets a media key system event callback.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_CreateMediaKeySession](#oh_mediakeysystem_createmediakeysession) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, [DRM_ContentProtectionLevel](#drm_contentprotectionlevel) \*level, [MediaKeySession](#mediakeysession) \*\*mediaKeySession) | Creates a **MediaKeySession** instance.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GenerateKeySystemRequest](#oh_mediakeysystem_generatekeysystemrequest) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, uint8_t \*request, int32_t \*requestLen, char \*defaultUrl, int32_t defaultUrlLen) | Generates a provision request.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_ProcessKeySystemResponse](#oh_mediakeysystem_processkeysystemresponse) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, uint8_t \*response, int32_t responseLen) | Processes a provision response.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GetOfflineMediaKeyIds](#oh_mediakeysystem_getofflinemediakeyids) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, [DRM_OfflineMediakeyIdArray](_d_r_m___offline_mediakey_id_array.md) \*offlineMediaKeyIds) | Obtains the IDs of offline media keys.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GetOfflineMediaKeyStatus](#oh_mediakeysystem_getofflinemediakeystatus) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, uint8_t \*offlineMediaKeyId, int32_t offlineMediaKeyIdLen, [DRM_OfflineMediaKeyStatus](#drm_offlinemediakeystatus) \*status) | Obtains the status of an offline media key.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_ClearOfflineMediaKeys](#oh_mediakeysystem_clearofflinemediakeys) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, uint8_t \*offlineMediaKeyId, int32_t offlineMediaKeyIdLen) | Clears offline media keys.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_GetCertificateStatus](#oh_mediakeysystem_getcertificatestatus) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem, [DRM_CertificateStatus](#drm_certificatestatus) \*certStatus) | Obtains the status of a DRM certificate.| 
| [Drm_ErrCode](#drm_errcode) [OH_MediaKeySystem_Destroy](#oh_mediakeysystem_destroy) ([MediaKeySystem](#mediakeysystem) \*mediaKeySystem) | Destroys a **MediaKeySystem** instance.| 


### Variables

| Name| Description| 
| -------- | -------- |
| [DRM_MediaKeyType](#drm_mediakeytype) [DRM_MediaKeyRequestInfo::type](#type-12) | Type of the media key in a media key request.| 
| int32_t [DRM_MediaKeyRequestInfo::initDataLen](#initdatalen) | Initial data length.| 
| uint8_t [DRM_MediaKeyRequestInfo::initData](#initdata) [[MAX_INIT_DATA_LEN](#max_init_data_len)] | Initial data.| 
| char [DRM_MediaKeyRequestInfo::mimeType](#mimetype) [[MAX_MIMETYPE_LEN](#max_mimetype_len)] | MIME type.| 
| uint32_t [DRM_MediaKeyRequestInfo::optionsCount](#optionscount) | Number of optional data items.| 
| char [DRM_MediaKeyRequestInfo::optionName](#optionname) [[MAX_MEDIA_KEY_REQUEST_OPTION_COUNT](#max_media_key_request_option_count)][[MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN](#max_media_key_request_option_name_len)] | Array of optional data names.| 
| char [DRM_MediaKeyRequestInfo::optionData](#optiondata) [[MAX_MEDIA_KEY_REQUEST_OPTION_COUNT](#max_media_key_request_option_count)][[MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN](#max_media_key_request_option_data_len)] | Array of optional data.| 
| [DRM_MediaKeyRequestType](#drm_mediakeyrequesttype) [DRM_MediaKeyRequest::type](#type-22) | Type of a media key request.| 
| int32_t [DRM_MediaKeyRequest::dataLen](#datalen-12) | Length of data in a media key request.| 
| uint8_t [DRM_MediaKeyRequest::data](#data-12) [[MAX_MEDIA_KEY_REQUEST_DATA_LEN](#max_media_key_request_data_len)] | Data carried in a media key request.| 
| char [DRM_MediaKeyRequest::defaultUrl](#defaulturl) [[MAX_DEFAULT_URL_LEN](#max_default_url_len)] | DRM service URL.| 
| uint32_t [DRM_Statistics::statisticsCount](#statisticscount) | Number of statistical items.| 
| char [DRM_Statistics::statisticsName](#statisticsname) [[MAX_STATISTICS_COUNT](#max_statistics_count)][[MAX_STATISTICS_NAME_LEN](#max_statistics_name_len)] | Array of statistical item names.| 
| char [DRM_Statistics::statisticsDescription](#statisticsdescription) [[MAX_STATISTICS_COUNT](#max_statistics_count)][[MAX_STATISTICS_BUFFER_LEN](#max_statistics_buffer_len)] | Array of statistical descriptors.| 
| uint32_t [DRM_OfflineMediakeyIdArray::idsCount](#idscount) | Number of offline media key IDs.| 
| int32_t [DRM_OfflineMediakeyIdArray::idsLen](#idslen) [[MAX_OFFLINE_MEDIA_KEY_ID_COUNT](#max_offline_media_key_id_count)] | Length of offline media key IDs.| 
| uint8_t [DRM_OfflineMediakeyIdArray::ids](#ids) [[MAX_OFFLINE_MEDIA_KEY_ID_COUNT](#max_offline_media_key_id_count)][[MAX_OFFLINE_MEDIA_KEY_ID_LEN](#max_offline_media_key_id_len)] | Array of offline media key IDs.|
| uint32_t [DRM_KeysInfo::keysInfoCount](#keysinfocount) | Number of media keys in the key information.| 
| uint8_t [DRM_KeysInfo::keyId](#keyid) [[MAX_KEY_INFO_COUNT](#max_key_info_count)][[MAX_KEY_ID_LEN](#max_key_id_len)] | Array of offline media key IDs.| 
| char [DRM_KeysInfo::statusValue](#statusvalue-12) [[MAX_KEY_INFO_COUNT](#max_key_info_count)][[MAX_KEY_STATUS_VALUE_LEN](#max_key_status_value_len)] | Media key status in the key information.| 
| uint32_t [DRM_MediaKeyStatus::statusCount](#statuscount) | Number of media key statuses.| 
| char [DRM_MediaKeyStatus::statusName](#statusname) [[MAX_MEDIA_KEY_STATUS_COUNT](#max_media_key_status_count)][[MAX_MEDIA_KEY_STATUS_NAME_LEN](#max_media_key_status_name_len)] | Array of media key status names.| 
| char [DRM_MediaKeyStatus::statusValue](#statusvalue-22) [[MAX_MEDIA_KEY_STATUS_COUNT](#max_media_key_status_count)][[MAX_MEDIA_KEY_STATUS_VALUE_LEN](#max_media_key_status_value_len)] | Array of media key status values.| 
| uint8_t [DRM_PsshInfo::uuid](#uuid-12) [[DRM_UUID_LEN](#drm_uuid_len)] | UUID of a DRM scheme.| 
| int32_t [DRM_PsshInfo::dataLen](#datalen-22) | Length of PSSH data.| 
| uint8_t [DRM_PsshInfo::data](#data-22) [[MAX_PSSH_DATA_LEN](#max_pssh_data_len)] | PSSH data.| 
| uint32_t [DRM_MediaKeySystemInfo::psshCount](#psshcount) | Number of pieces of PSSH data.| 
| [DRM_PsshInfo](_d_r_m___pssh_info.md) [DRM_MediaKeySystemInfo::psshInfo](#psshinfo) [[MAX_PSSH_INFO_COUNT](#max_pssh_info_count)] | PSSH data.| 
| char [DRM_MediaKeySystemDescription::name](#name) [[MAX_MEDIA_KEY_SYSTEM_NAME_LEN](#max_media_key_system_name_len)] | DRM scheme name. | 
| uint8_t [DRM_MediaKeySystemDescription::uuid](#uuid-22) [[DRM_UUID_LEN](#drm_uuid_len)] | UUID of a DRM scheme. | 
| [MediaKeySession_EventCallback](#mediakeysession_eventcallback) [MediaKeySession_Callback::eventCallback](#eventcallback-12) | Media key session event callback, for example, a media key expiry event.| 
| [MediaKeySession_KeyChangeCallback](#mediakeysession_keychangecallback) [MediaKeySession_Callback::keyChangeCallback](#keychangecallback-12) | Callback of the media key change event| 
| [OH_MediaKeySession_EventCallback](#oh_mediakeysession_eventcallback) [OH_MediaKeySession_Callback::eventCallback](#eventcallback-22) | Media key session event callback, for example, a media key expiry event.| 
| [OH_MediaKeySession_KeyChangeCallback](#oh_mediakeysession_keychangecallback) [OH_MediaKeySession_Callback::keyChangeCallback](#keychangecallback-22) | Callback of the media key change event|



## Macro Description


### DRM_UUID_LEN

```
#define DRM_UUID_LEN   16
```

**Description**

Length of the UUID of a DRM scheme.

**Since**: 11


### MAX_DEFAULT_URL_LEN

```
#define MAX_DEFAULT_URL_LEN   2048
```

**Description**

Maximum length of the URL of the DRM service.

**Since**: 11


### MAX_INIT_DATA_LEN

```
#define MAX_INIT_DATA_LEN   2048
```

**Description**

Maximum length of data in an initial request.

**Since**: 11


### MAX_KEY_ID_LEN

```
#define MAX_KEY_ID_LEN   16
```

**Description**

Maximum length of a media key ID.

**Since**: 11


### MAX_KEY_INFO_COUNT

```
#define MAX_KEY_INFO_COUNT   64
```

**Description**

Maximum number of pieces of media key information.

**Since**: 11


### MAX_KEY_STATUS_VALUE_LEN

```
#define MAX_KEY_STATUS_VALUE_LEN   128
```

**Description**

Maximum length of a media key status value.

**Since**: 11


### MAX_MEDIA_KEY_REQUEST_DATA_LEN

```
#define MAX_MEDIA_KEY_REQUEST_DATA_LEN   8192
```

**Description**

Maximum length of a media key request.

**Since**: 11


### MAX_MEDIA_KEY_REQUEST_OPTION_COUNT

```
#define MAX_MEDIA_KEY_REQUEST_OPTION_COUNT   16
```

**Description**

Maximum number of optional data items in a media key request.

**Since**: 11


### MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN

```
#define MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN   128
```

**Description**

Maximum length of optional data in a media key request.

**Since**: 11


### MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN

```
#define MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN   64
```

**Description**

Maximum length of an optional data name in a media key request.

**Since**: 11


### MAX_MEDIA_KEY_STATUS_COUNT

```
#define MAX_MEDIA_KEY_STATUS_COUNT   64
```

**Description**

Maximum number of media key statuses.

**Since**: 11


### MAX_MEDIA_KEY_STATUS_NAME_LEN

```
#define MAX_MEDIA_KEY_STATUS_NAME_LEN   64
```

**Description**

Maximum length of a media key status name.

**Since**: 11


### MAX_MEDIA_KEY_STATUS_VALUE_LEN

```
#define MAX_MEDIA_KEY_STATUS_VALUE_LEN   256
```

**Description**

Maximum length of a media key status value.

**Since**: 11


### MAX_MEDIA_KEY_SYSTEM_NAME_LEN

```
#define MAX_MEDIA_KEY_SYSTEM_NAME_LEN   128
```
**Description**

Maximum length of a DRM scheme name.

**Since**: 12


### MAX_MEDIA_KEY_SYSTEM_NUM

```
#define MAX_MEDIA_KEY_SYSTEM_NUM   8
```
**Description**

Maximum number of DRM schemes supported.

**Since**: 12


### MAX_MIMETYPE_LEN

```
#define MAX_MIMETYPE_LEN   64
```

**Description**

Maximum length of a MIME type.

**Since**: 11


### MAX_OFFLINE_MEDIA_KEY_ID_COUNT

```
#define MAX_OFFLINE_MEDIA_KEY_ID_COUNT   512
```

**Description**

Maximum number of offline media key IDs.

**Since**: 11


### MAX_OFFLINE_MEDIA_KEY_ID_LEN

```
#define MAX_OFFLINE_MEDIA_KEY_ID_LEN   64
```

**Description**

Maximum length of an offline media key ID.

**Since**: 11


### MAX_PSSH_DATA_LEN

```
#define MAX_PSSH_DATA_LEN   2048
```

**Description**

Maximum length of PSSH data.

**Since**: 11


### MAX_PSSH_INFO_COUNT

```
#define MAX_PSSH_INFO_COUNT   8
```

**Description**

Maximum number of pieces of PSSH data.

**Since**: 11


### MAX_STATISTICS_BUFFER_LEN

```
#define MAX_STATISTICS_BUFFER_LEN   256
```

**Description**

Maximum length of a statistical item buffer.

**Since**: 11


### MAX_STATISTICS_COUNT

```
#define MAX_STATISTICS_COUNT   10
```

**Description**

Maximum number of statistical items.

**Since**: 11


### MAX_STATISTICS_NAME_LEN

```
#define MAX_STATISTICS_NAME_LEN   64
```

**Description**

Maximum length of a statistical item name.

**Since**: 11


## Type Description


### DRM_CertificateStatus

```
typedef enum DRM_CertificateStatus DRM_CertificateStatus
```

**Description**

Defines an enum for the DRM certificate statuses.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11


### DRM_ContentProtectionLevel

```
typedef enum DRM_ContentProtectionLevel DRM_ContentProtectionLevel
```

**Description**

Defines an enum for the content protection levels.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11


### Drm_ErrCode

```
typedef enum Drm_ErrCode Drm_ErrCode
```

**Description**

Defines an enum for the DRM error codes.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11


### DRM_EventType

```
typedef enum DRM_EventType DRM_EventType
```

**Description**

Defines an enum for the types of events that can be subscribed to.

**Since**: 11


### DRM_KeysInfo

```
typedef struct DRM_KeysInfo DRM_KeysInfo
```

**Description**

Defines a struct for the information about media keys.

**Since**: 11


### DRM_MediaKeyRequest

```
typedef struct DRM_MediaKeyRequest DRM_MediaKeyRequest
```

**Description**

Defines a struct for a media key request.

**Since**: 11


### DRM_MediaKeyRequestInfo

```
typedef struct DRM_MediaKeyRequestInfo DRM_MediaKeyRequestInfo
```

**Description**

Defines a struct for the information about a media key request.

**Since**: 11


### DRM_MediaKeyRequestType

```
typedef enum DRM_MediaKeyRequestType DRM_MediaKeyRequestType
```

**Description**

Defines an enum for the types of media key requests.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11


### DRM_MediaKeyStatus

```
typedef struct DRM_MediaKeyStatus DRM_MediaKeyStatus
```

**Description**

Defines a struct for the media key status.

**Since**: 11


### DRM_MediaKeySystemDescription

```
typedef struct DRM_MediaKeySystemDescription DRM_MediaKeySystemDescription
```
**Description**

Defines a struct for the name and UUID of a DRM scheme.

**Since**: 12


### DRM_MediaKeySystemInfo

```
typedef struct DRM_MediaKeySystemInfo DRM_MediaKeySystemInfo
```

**Description**

Defines a struct for the DRM information obtained by the player from a media source.

**Since**: 11


### DRM_MediaKeySystemInfoCallback

```
typedef void(* DRM_MediaKeySystemInfoCallback) (DRM_MediaKeySystemInfo *mediaKeySystemInfo)
```

**Description**

Defines the callback used to obtain DRM information from a media source.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystemInfo | Pointer to the DRM information obtained from the media source.| 

### DRM_MediaKeyType

```
typedef enum DRM_MediaKeyType DRM_MediaKeyType
```

**Description**

Defines an enum for the types of media keys.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11


### DRM_OfflineMediakeyIdArray

```
typedef struct DRM_OfflineMediakeyIdArray DRM_OfflineMediakeyIdArray
```

**Description**

Defines a struct for an array holding the IDs of offline media keys.

**Since**: 11


### DRM_OfflineMediaKeyStatus

```
typedef enum DRM_OfflineMediaKeyStatus DRM_OfflineMediaKeyStatus
```

**Description**

Defines an enum for the statuses of offline media keys.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11


### DRM_PsshInfo

```
typedef struct DRM_PsshInfo DRM_PsshInfo
```

**Description**

Defines a struct for the PSSH data that contains the UUID of a DRM scheme.

**Since**: 11


### DRM_Statistics

```
typedef struct DRM_Statistics DRM_Statistics
```

**Description**

Defines a struct for the statistical information of a media key system.

**Since**: 11


### MediaKeySession

```
typedef struct MediaKeySession MediaKeySession
```

**Description**

Defines a struct for a media key session.

**Since**: 11


### MediaKeySession_Callback

```
typedef struct MediaKeySession_Callback MediaKeySession_Callback
```

**Description**

Defines the callback used to listen for events such as media key expiry, without returning media key session instances. It applies to the scenario where a single media key session needs to be decrypted.

**Since**: 11


### MediaKeySession_EventCallback

```
typedef Drm_ErrCode(* MediaKeySession_EventCallback) (DRM_EventType eventType, uint8_t *info, int32_t infoLen, char *extra)
```

**Description**

Defines the callback used to listen for media key session events, for example, a key expiration event.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| eventType | Event type.| 
| info | Pointer to the event information obtained from the media key session.| 
| infoLen | Length of the event information.| 
| extra | Pointer to the additional information obtained from the media key session.| 

**Returns**

Returns an error code defined in **Drm_ErrCode**.


### MediaKeySession_KeyChangeCallback

```
typedef Drm_ErrCode(* MediaKeySession_KeyChangeCallback) (DRM_KeysInfo *keysInfo, bool newKeysAvailable)
```

**Description**

Defines the callback that is invoked when the key is changed.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| keysInfo | Pointer to the media key information.| 
| newKeysAvailable | Whether the new key is available.| 

**Returns**

Returns **DRM_ERR_OK** is the call is successful; returns **DRM_ERR_INVALID_VAL** if the parameter check fails.


### MediaKeySystem

```
typedef struct MediaKeySystem MediaKeySystem
```

**Description**

Defines a struct for a media key system.

**Since**: 11


### MediaKeySystem_Callback

```
typedef Drm_ErrCode(* MediaKeySystem_Callback) (DRM_EventType eventType, uint8_t *info, int32_t infoLen, char *extra)
```

**Description**

Defines the callback used to listen for media key system events. No **MediaKeySystem** instance is returned. This callback applies to the scenario where a single **MediaKeySystem** instance is used.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| eventType | Event type.| 
| info | Pointer to the event information.| 
| infoLen | Length of the event information.| 
| extra | Pointer to extended event information.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: An input parameter is invalid.


### OH_MediaKeySession_Callback

```
typedef struct OH_MediaKeySession_CallbackOH_MediaKeySession_Callback
```

**Description**

Defines the callback used to listen for events such as media key expiry, with media key session instances returned. It applies to the scenario where multiple media key sessions need to be decrypted.

**Since**: 12


### OH_MediaKeySession_EventCallback

```
typedef Drm_ErrCode(* OH_MediaKeySession_EventCallback) (MediaKeySession *mediaKeySessoin, DRM_EventType eventType, uint8_t *info, int32_t infoLen, char *extra)
```

**Description**

Defines the callback that is invoked when a media key system event is triggered.

**Since**: 12

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySessoin | Pointer to the **MediaKeySession** instance.| 
| eventType | Event type.| 
| info | Pointer to the event information.| 
| infoLen | Length of the event information.| 
| extra | Pointer to extended event information.| 

**Returns**

Returns an error code defined in **Drm_ErrCode**.


### OH_MediaKeySession_KeyChangeCallback

```
typedef Drm_ErrCode(* OH_MediaKeySession_KeyChangeCallback) (MediaKeySession *mediaKeySessoin, DRM_KeysInfo *keysInfo, bool newKeysAvailable)
```

**Description**

Defines the callback that is invoked when the key is changed.

**Since**: 12

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySessoin | Pointer to the **MediaKeySession** instance.| 
| keysInfo | Pointer to the media key information.| 
| newKeysAvailable | Whether the new keys are available. The value **true** means that the new keys are available, and **false** means the opposite.| 

**Returns**

Returns **DRM_ERR_OK** is the call is successful; returns **DRM_ERR_INVALID_VAL** if the parameter check fails.


### OH_MediaKeySystem_Callback

```
typedef Drm_ErrCode(* OH_MediaKeySystem_Callback) (MediaKeySystem *mediaKeySystem, DRM_EventType eventType, uint8_t *info, int32_t infoLen, char *extra)
```

**Description**

Defines the callback used to listen for media key system events. A **MediaKeySystem** instance is returned. This callback applies to the scenario where multiple **MediaKeySystem** instances are used.

**Since**: 12

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| eventType | Event type.| 
| info | Pointer to the event information.| 
| infoLen | Length of the event information.| 
| extra | Pointer to extended event information.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: An input parameter is invalid.


## Enum Description


### DRM_CertificateStatus

```
enum DRM_CertificateStatus
```

**Description**

Enumerates the DRM certificate statuses.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11

| Value| Description| 
| -------- | -------- |
| CERT_STATUS_PROVISIONED | A DRM certificate has been installed on the device.| 
| CERT_STATUS_NOT_PROVISIONED | No device certificate is installed on the device or the certificate status is abnormal.| 
| CERT_STATUS_EXPIRED | The DRM certificate has expired.| 
| CERT_STATUS_INVALID | The DRM certificate is invalid.| 
| CERT_STATUS_UNAVAILABLE | The DRM certificate is unavailable.| 


### DRM_ContentProtectionLevel

```
enum DRM_ContentProtectionLevel
```

**Description**

Enumerates the content protection levels.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11

| Value| Description| 
| -------- | -------- |
| CONTENT_PROTECTION_LEVEL_UNKNOWN | Unknown/Default content protection level.| 
| CONTENT_PROTECTION_LEVEL_SW_CRYPTO | Software content protection level.| 
| CONTENT_PROTECTION_LEVEL_HW_CRYPTO | Hardware content protection level.| 
| CONTENT_PROTECTION_LEVEL_ENHANCED_HW_CRYPTO | Hardware enhancement level.| 
| CONTENT_PROTECTION_LEVEL_MAX | Highest content protection level.| 


### Drm_ErrCode

```
enum Drm_ErrCode
```

**Description**

Enumerates the DRM error codes.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11

| Value| Description| 
| -------- | -------- |
| DRM_ERR_OK | Operation successful.| 
| DRM_CAPI_ERR_BASE | Basic error.| 
| DRM_ERR_NO_MEMORY | Insufficient memory.| 
| DRM_ERR_OPERATION_NOT_PERMITTED | Operation not allowed.| 
| DRM_ERR_INVALID_VAL | Invalid parameters.| 
| DRM_ERR_IO | I/O error.| 
| DRM_ERR_TIMEOUT | Network timeout.| 
| DRM_ERR_UNKNOWN | Unknown error.| 
| DRM_ERR_SERVICE_DIED | DRM service error.| 
| DRM_ERR_INVALID_STATE | Invalid operation status.| 
| DRM_ERR_UNSUPPORTED | Unsupported operation.| 
| DRM_ERR_MAX_SYSTEM_NUM_REACHED | Too many **MediaKeySystem** instances.| 
| DRM_ERR_MAX_SESSION_NUM_REACHED | Too many **MediaKeySession** instances.| 
| DRM_ERR_EXTEND_START | Extended error.| 


### DRM_EventType

```
enum DRM_EventType
```

**Description**

Enumerates the types of events that can be subscribed to.

**Since**: 11

| Value| Description| 
| -------- | -------- |
| EVENT_DRM_BASE | DRM event.| 
| EVENT_PROVISION_REQUIRED | Event indicating that the application needs to request a DRM certificate.| 
| EVENT_KEY_REQUIRED | Event indicating that the application needs to request a media key.| 
| EVENT_KEY_EXPIRED | Event indicating that the media key expires.| 
| EVENT_VENDOR_DEFINED | Vendor-defined event.| 
| EVENT_EXPIRATION_UPDATE | Event indicating that the media key updates on expiry.| 


### DRM_MediaKeyRequestType

```
enum DRM_MediaKeyRequestType
```

**Description**

Enumerates the types of media key requests.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11

| Value| Description| 
| -------- | -------- |
| MEDIA_KEY_REQUEST_TYPE_UNKNOWN | Unknown type.| 
| MEDIA_KEY_REQUEST_TYPE_INITIAL | Initial request.| 
| MEDIA_KEY_REQUEST_TYPE_RENEWAL | Renewal request.| 
| MEDIA_KEY_REQUEST_TYPE_RELEASE | Release request.| 
| MEDIA_KEY_REQUEST_TYPE_NONE | None.| 
| MEDIA_KEY_REQUEST_TYPE_UPDATE | Update request.| 


### DRM_MediaKeyType

```
enum DRM_MediaKeyType
```

**Description**

Enumerates the types of media keys.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11

| Value| Description| 
| -------- | -------- |
| MEDIA_KEY_TYPE_OFFLINE | Offline.| 
| MEDIA_KEY_TYPE_ONLINE | Online.| 


### DRM_OfflineMediaKeyStatus

```
enum DRM_OfflineMediaKeyStatus
```

**Description**

Enumerates the statuses of offline media keys.

**System capability**: SystemCapability.Multimedia.Drm.Core

**Since**: 11

| Value| Description| 
| -------- | -------- |
| OFFLINE_MEDIA_KEY_STATUS_UNKNOWN | Unknown status.| 
| OFFLINE_MEDIA_KEY_STATUS_USABLE | The media key is available.| 
| OFFLINE_MEDIA_KEY_STATUS_INACTIVE | The media key is inactive.| 


## Function Description


### OH_MediaKeySession_CheckMediaKeyStatus()

```
Drm_ErrCode OH_MediaKeySession_CheckMediaKeyStatus (MediaKeySession *mediaKeySessoin, DRM_MediaKeyStatus *mediaKeyStatus)
```

**Description**

Checks the status of media keys.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| mediaKeyStatus | Pointer to the media key status obtained.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of **mediaKeyStatus** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_ClearMediaKeys()

```
Drm_ErrCode OH_MediaKeySession_ClearMediaKeys (MediaKeySession *mediaKeySessoin)
```

**Description**

Clears media keys.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_Destroy()

```
Drm_ErrCode OH_MediaKeySession_Destroy (MediaKeySession *mediaKeySessoin)
```

**Description**

Destroys a **MediaKeySession** instance.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_GenerateMediaKeyRequest()

```
Drm_ErrCode OH_MediaKeySession_GenerateMediaKeyRequest (MediaKeySession *mediaKeySession, DRM_MediaKeyRequestInfo *info, DRM_MediaKeyRequest *mediaKeyRequest)
```

**Description**

Generates a media key request.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| info | Pointer to the information about the media key request.| 
| mediaKeyRequest | Pointer to the media key request.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of **info** or **mediaKeyRequest** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_GenerateOfflineReleaseRequest()

```
Drm_ErrCode OH_MediaKeySession_GenerateOfflineReleaseRequest (MediaKeySession *mediaKeySessoin, uint8_t *offlineMediaKeyId, int32_t offlineMediaKeyIdLen, uint8_t *releaseRequest, int32_t *releaseRequestLen)
```

**Description**

Generates a request to release offline media keys.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| offlineMediaKeyId | Pointer to the ID of an offline media key.| 
| offlineMediaKeyIdLen| Length of the offline media key ID.| 
| releaseRequest| Pointer to a request to release offline media keys.| 
| releaseRequestLen| Length of the request to release offline media keys.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of another parameter of the pointer type is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_GetContentProtectionLevel()

```
Drm_ErrCode OH_MediaKeySession_GetContentProtectionLevel (MediaKeySession *mediaKeySessoin, DRM_ContentProtectionLevel *contentProtectionLevel)
```

**Description**

Obtains the content protection level of a media key session.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| contentProtectionLevel | Pointer to the content protection level.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of **contentProtectionLevel** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_ProcessMediaKeyResponse()

```
Drm_ErrCode OH_MediaKeySession_ProcessMediaKeyResponse (MediaKeySession *mediaKeySession, uint8_t *response, int32_t responseLen, uint8_t *offlineMediaKeyId, int32_t *offlineMediaKeyIdLen)
```

**Description**

Processes a media key response.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| response | Pointer to a media key response.| 
| responseLen | Pointer to the length of the media key response.| 
| offlineMediaKeyId | Pointer to the ID of an offline media key.| 
| offlineMediaKeyIdLen | Length of the offline media key ID.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of another parameter of the pointer type is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_ProcessOfflineReleaseResponse()

```
Drm_ErrCode OH_MediaKeySession_ProcessOfflineReleaseResponse (MediaKeySession *mediaKeySessoin, uint8_t *offlineMediaKeyId, int32_t offlineMediaKeyIdLen, uint8_t *releaseReponse, int32_t releaseReponseLen)
```

**Description**

Processes a response to a request for releasing offline media keys.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| offlineMediaKeyId | Pointer to the ID of an offline media key.| 
| offlineMediaKeyIdLen | Length of the offline media key ID.| 
| releaseReponse | Pointer to the response.| 
| releaseReponseLen | Length of the response.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of another parameter of the pointer type is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_RequireSecureDecoderModule()

```
Drm_ErrCode OH_MediaKeySession_RequireSecureDecoderModule (MediaKeySession *mediaKeySessoin, const char *mimeType, bool *status)
```

**Description**

Checks whether secure decoding is required.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| mimeType | Pointer to the MIME type. The supported MIME types depend on the DRM scheme. Example types are video/avc and video/hev.| 
| status | Pointer to the result indicating whether secure decoding is required.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of another parameter of the pointer type is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_RestoreOfflineMediaKeys()

```
Drm_ErrCode OH_MediaKeySession_RestoreOfflineMediaKeys (MediaKeySession *mediaKeySessoin, uint8_t *offlineMediaKeyId, int32_t offlineMediaKeyIdLen)
```

**Description**

Restores offline media keys.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| offlineMediaKeyId | Pointer to the ID of an offline media key.| 
| offlineMediaKeyIdLen | Length of the offline media key ID.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of another parameter of the pointer type is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySession_SetCallback()

```
Drm_ErrCode OH_MediaKeySession_SetCallback (MediaKeySession *mediaKeySessoin, OH_MediaKeySession_Callback *callback)
```

**Description**

Sets a media key session event callback.

**Since**: 12

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| callback | Pointer to the callback for the media key session event.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of **callback** is a null pointer.


### OH_MediaKeySession_SetMediaKeySessionCallback()

```
Drm_ErrCode OH_MediaKeySession_SetMediaKeySessionCallback (MediaKeySession *mediaKeySessoin, MediaKeySession_Callback *callback)
```

**Description**

Sets a media key session event callback.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySession | Pointer to the **MediaKeySession** instance.| 
| callback | Pointer to the callback for the media key session event.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySession** is a null pointer or invalid, or the value of **callback** is a null pointer.


### OH_MediaKeySystem_ClearOfflineMediaKeys()

```
Drm_ErrCode OH_MediaKeySystem_ClearOfflineMediaKeys (MediaKeySystem *mediaKeySystem, uint8_t *offlineMediaKeyId, int32_t offlineMediaKeyIdLen)
```

**Description**

Clears offline media keys by ID.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| offlineMediaKeyId | Pointer to the ID of an offline media key.| 
| offlineMediaKeyIdLen | Length of the offline media key ID.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **offlineMediaKeyId** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_Create()

```
Drm_ErrCode OH_MediaKeySystem_Create (const char *name, MediaKeySystem **mediaKeySystem)
```

**Description**

Creates a **MediaKeySystem** instance.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| name | Pointer to the DRM scheme name.| 
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **name** is a null pointer or its length is 0, or the value of **mediaKeySystem** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.
- **DRM_ERR_SERVICE_DIED**: The service is dead.
- DRM_ERR_MAX_SYSTEM_NUM_REACHED: The number of created **MediaKeySystem** instances has reached the upper limit (64).


### OH_MediaKeySystem_CreateMediaKeySession()

```
Drm_ErrCode OH_MediaKeySystem_CreateMediaKeySession (MediaKeySystem *mediaKeySystem, DRM_ContentProtectionLevel *level, MediaKeySession **mediaKeySession)
```

**Description**

Creates a **MediaKeySession** instance.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| level | Pointer to the content protection level.| 
| mediaKeySession | Double pointer to the **MediaKeySession** instance created.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, the value of **level** is out of range, or the value of **mediaKeySession** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.
- **DRM_ERR_SERVICE_DIED**: The service is dead.
- **DRM_ERR_MAX_SESSION_NUM_REACHED**: The number of **MediaKeySession** instances created by the **MediaKeySystem** instance reaches the upper limit (64).


### OH_MediaKeySystem_Destroy()

```
Drm_ErrCode OH_MediaKeySystem_Destroy (MediaKeySystem *mediaKeySystem)
```

**Description**

Destroys a **MediaKeySystem** instance.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GenerateKeySystemRequest()

```
Drm_ErrCode OH_MediaKeySystem_GenerateKeySystemRequest (MediaKeySystem *mediaKeySystem, uint8_t *request, int32_t *requestLen, char *defaultUrl, int32_t defaultUrlLen)
```

**Description**

Generates a provision request.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| request | Pointer to the provision request, which is used to request a DRM certificate from a provisioning server.| 
| requestLen | Pointer to the length of the provision request.| 
| defaultUrl | Pointer to the URL of the provisioning server.| 
| defaultUrlLen | Length of the URL of the provisioning server.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of another parameter of the pointer type is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GetCertificateStatus()

```
Drm_ErrCode OH_MediaKeySystem_GetCertificateStatus (MediaKeySystem *mediaKeySystem, DRM_CertificateStatus *certStatus)
```

**Description**

Obtains the status of a DRM certificate.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| certStatus | Pointer to the DRM certificate status.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **certStatus** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GetConfigurationByteArray()

```
Drm_ErrCode OH_MediaKeySystem_GetConfigurationByteArray (MediaKeySystem *mediaKeySystem, const char *configName, uint8_t *value, int32_t *valueLen)
```

**Description**

Obtains the value of a configuration item in the form of an array.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| configName | Pointer to the name of the configuration item.| 
| value | Pointer to the value of the configuration item.| 
| valueLen | Pointer to the length of the value.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **configName**, **value**, or **valueLen** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GetConfigurationString()

```
Drm_ErrCode OH_MediaKeySystem_GetConfigurationString (MediaKeySystem *mediaKeySystem, const char *configName, char *value, int32_t valueLen)
```

**Description**

Obtains the value of a configuration item in the form of a string.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| configName | Pointer to the name of the configuration item.| 
| value | Pointer to the value of the configuration item.| 
| valueLen | Length of the value.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **configName** or **value** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GetMaxContentProtectionLevel()

```
Drm_ErrCode OH_MediaKeySystem_GetMaxContentProtectionLevel (MediaKeySystem *mediaKeySystem, DRM_ContentProtectionLevel *contentProtectionLevel)
```

**Description**

Obtains the maximum content protection level supported by the device.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| contentProtectionLevel | Pointer to the content protection level.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **contentProtectionLevel** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GetMediaKeySystems()

```
Drm_ErrCode OH_MediaKeySystem_GetMediaKeySystems (DRM_MediaKeySystemDescription *infos, uint32_t *count)
```

**Description**

Obtains the name and ID list of the DRM schemes supported by the device.

**Since**: 12

**Parameters**

| Name| Description| 
| -------- | -------- |
| infos | Pointer to the list of the names and UUIDs of DRM schemes.| 
| count | Pointer to the length of the list.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- DRM_ERR_INVALID_VAL: The value of **infos** or **count** is a null pointer, or the length of **infos** is insufficient.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GetOfflineMediaKeyIds()

```
Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyIds (MediaKeySystem *mediaKeySystem, DRM_OfflineMediakeyIdArray *offlineMediaKeyIds)
```

**Description**

Obtains the list of offline media key IDs, which are used to manage offline media keys.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| offlineMediaKeyIds | Pointer to the IDs of offline media keys.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **offlineMediaKeyIds** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GetOfflineMediaKeyStatus()

```
Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyStatus (MediaKeySystem *mediaKeySystem, uint8_t *offlineMediaKeyId, int32_t offlineMediaKeyIdLen, DRM_OfflineMediaKeyStatus *status)
```

**Description**

Obtains the status of an offline media key.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| offlineMediaKeyId | Pointer to the ID of an offline media key.| 
| offlineMediaKeyIdLen | Length of the offline media key ID.| 
| status | Pointer to the media key status obtained.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of another parameter of the pointer type is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_GetStatistics()

```
Drm_ErrCode OH_MediaKeySystem_GetStatistics (MediaKeySystem *mediaKeySystem, DRM_Statistics *statistics)
```

**Description**

Obtains the statistical information of a media key system.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| statistics | Pointer to the statistical information.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **statistics** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_IsSupported()

```
bool OH_MediaKeySystem_IsSupported (const char *name)
```

**Description**

Checks whether the device supports the specified DRM scheme.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| name | Pointer to the DRM scheme name.| 

**Returns**

Returns **true** if the device supports the DRM scheme; returns **false** otherwise.


### OH_MediaKeySystem_IsSupported2()

```
bool OH_MediaKeySystem_IsSupported2 (const char *name, const char *mimeType)
```

**Description**

Checks whether the device supports the combination of the specified DRM scheme and MIME type.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| name | Pointer to the DRM scheme name.| 
| mimeType | Pointer to the MIME type. The supported MIME types depend on the DRM scheme. Example types are video/avc and video/hev.| 

**Returns**

Returns **true** if the device supports the combination; returns **false** otherwise.


### OH_MediaKeySystem_IsSupported3()

```
bool OH_MediaKeySystem_IsSupported3 (const char *name, const char *mimeType, DRM_ContentProtectionLevel contentProtectionLevel)
```

**Description**

Checks whether the device supports the combination of the specified DRM scheme, MIME type, and content protection level.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| name | Pointer to the DRM scheme name.| 
| mimeType | Pointer to the MIME type. The supported MIME types depend on the DRM scheme. Example types are video/avc and video/hev.| 
| contentProtectionLevel | Content protection level.| 

**Returns**

Returns **true** if the device supports the combination; returns **false** otherwise.


### OH_MediaKeySystem_ProcessKeySystemResponse()

```
Drm_ErrCode OH_MediaKeySystem_ProcessKeySystemResponse (MediaKeySystem *mediaKeySystem, uint8_t *response, int32_t responseLen)
```

**Description**

Processes a provision response.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| response | Pointer to the provision response.| 
| responseLen | Length of the provision response.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **response** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.


### OH_MediaKeySystem_SetCallback()

```
Drm_ErrCode OH_MediaKeySystem_SetCallback (MediaKeySystem *mediaKeySystem, OH_MediaKeySystem_Callback callback)
```

**Description**

Sets a media key system event callback.

**Since**: 12

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| callback | Callback.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: An input parameter is invalid.


### OH_MediaKeySystem_SetConfigurationByteArray()

```
Drm_ErrCode OH_MediaKeySystem_SetConfigurationByteArray (MediaKeySystem *mediaKeySystem, const char *configName, uint8_t *value, int32_t valueLen)
```

**Description**

Sets a configuration item in the form of an array.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| configName | Pointer to the name of the configuration item.| 
| value | Pointer to the value of the configuration item.| 
| valueLen | Length of the value.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_NO_MEMORY**: The memory fails to be allocated due to insufficient memory.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **configName** or **value** is a null pointer.
- **DRM_ERR_UNKNOWN**: An internal error occurs. Check the log details.

### OH_MediaKeySystem_SetConfigurationString()

```
Drm_ErrCode OH_MediaKeySystem_SetConfigurationString (MediaKeySystem *mediaKeySystem, const char *configName, const char *value)
```

**Description**

Sets a configuration item in the form of a string.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| configName | Pointer to the name of the configuration item.| 
| value | Pointer to the value of the configuration item, in the form of a string.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid, or the value of **configName** or **value** is a null pointer.


### OH_MediaKeySystem_SetMediaKeySystemCallback()

```
Drm_ErrCode OH_MediaKeySystem_SetMediaKeySystemCallback (MediaKeySystem *mediaKeySystem, MediaKeySystem_Callback callback)
```

**Description**

Sets a media key system event callback.

**Since**: 11

**Parameters**

| Name| Description| 
| -------- | -------- |
| mediaKeySystem | Pointer to the **MediaKeySystem** instance.| 
| callback | Callback.| 

**Returns**

Returns a result code defined in [Drm_ErrCode](#drm_errcode-1).
- **DRM_ERR_OK**: The operation is successful.
- **DRM_ERR_INVALID_VAL**: The value of **mediaKeySystem** is a null pointer or invalid.


## Variable Description


### data [1/2]

```
uint8_t DRM_MediaKeyRequest::data[MAX_MEDIA_KEY_REQUEST_DATA_LEN]
```

**Description**

Data in a media key request sent to the DRM service.


### data [2/2]

```
uint8_t DRM_PsshInfo::data[MAX_PSSH_DATA_LEN]
```

**Description**

PSSH data.


### dataLen [1/2]

```
int32_t DRM_MediaKeyRequest::dataLen
```

**Description**

Length of data in a media key request.


### dataLen [2/2]

```
int32_t DRM_PsshInfo::dataLen
```

**Description**

Length of PSSH data.


### defaultUrl

```
char DRM_MediaKeyRequest::defaultUrl[MAX_DEFAULT_URL_LEN]
```

**Description**

URL of the license server (which provisions media keys).


### eventCallback [1/2]

```
MediaKeySession_EventCallback MediaKeySession_Callback::eventCallback
```

**Description**

Media key session event callback, for example, a media key expiry event.


### eventCallback [2/2]

```
OH_MediaKeySession_EventCallback OH_MediaKeySession_Callback::eventCallback
```

**Description**

Media key session event callback, for example, a media key expiry event.

### ids

```
uint8_t DRM_OfflineMediakeyIdArray::ids[MAX_OFFLINE_MEDIA_KEY_ID_COUNT][MAX_OFFLINE_MEDIA_KEY_ID_LEN]
```

**Description**

Array of offline media key IDs.


### idsCount

```
uint32_t DRM_OfflineMediakeyIdArray::idsCount
```

**Description**

Number of offline media key IDs.


### idsLen

```
int32_t DRM_OfflineMediakeyIdArray::idsLen[MAX_OFFLINE_MEDIA_KEY_ID_COUNT]
```

**Description**

Length of offline media key IDs.


### initData

```
uint8_t DRM_MediaKeyRequestInfo::initData[MAX_INIT_DATA_LEN]
```

**Description**

Initial data in a media key request.


### initDataLen

```
int32_t DRM_MediaKeyRequestInfo::initDataLen
```

**Description**

Length of the initial data in a media key request.


### keyChangeCallback [1/2]

```
MediaKeySession_KeyChangeCallback MediaKeySession_Callback::keyChangeCallback
```

**Description**

Key change callback.


### keyChangeCallback [2/2]

```
OH_MediaKeySession_KeyChangeCallback OH_MediaKeySession_Callback::keyChangeCallback
```

**Description**

Key change callback.

### keyId

```
uint8_t DRM_KeysInfo::keyId[MAX_KEY_INFO_COUNT][MAX_KEY_ID_LEN]
```

**Description**

Media key ID array.


### keysInfoCount

```
uint32_t DRM_KeysInfo::keysInfoCount
```

**Description**

Number of media keys.


### mimeType

```
char DRM_MediaKeyRequestInfo::mimeType[MAX_MIMETYPE_LEN]
```

**Description**

Media key type.


### name

```
char DRM_MediaKeySystemDescription::name[MAX_MEDIA_KEY_SYSTEM_NAME_LEN]
```
**Description**
DRM scheme name.


### optionData

```
char DRM_MediaKeyRequestInfo::optionData[MAX_MEDIA_KEY_REQUEST_OPTION_COUNT][MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN]
```

**Description**

Optional data set.


### optionName

```
char DRM_MediaKeyRequestInfo::optionName[MAX_MEDIA_KEY_REQUEST_OPTION_COUNT][MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN]
```

**Description**

Optional data name set.


### optionsCount

```
uint32_t DRM_MediaKeyRequestInfo::optionsCount
```

**Description**

Number of optional data items.


### psshCount

```
uint32_t DRM_MediaKeySystemInfo::psshCount
```

**Description**

Number of pieces of PSSH data in DRM information.


### psshInfo

```
DRM_PsshInfo DRM_MediaKeySystemInfo::psshInfo[MAX_PSSH_INFO_COUNT]
```

**Description**

Array of PSSH data in DRM information.


### statisticsCount

```
uint32_t DRM_Statistics::statisticsCount
```

**Description**

Number of statistical items.


### statisticsDescription

```
char DRM_Statistics::statisticsDescription[MAX_STATISTICS_COUNT][MAX_STATISTICS_BUFFER_LEN]
```

**Description**

Statistical information set.


### statisticsName

```
char DRM_Statistics::statisticsName[MAX_STATISTICS_COUNT][MAX_STATISTICS_NAME_LEN]
```

**Description**

Statistical item name set.


### statusCount

```
uint32_t DRM_MediaKeyStatus::statusCount
```

**Description**

Length of the media key status array.


### statusName

```
char DRM_MediaKeyStatus::statusName[MAX_MEDIA_KEY_STATUS_COUNT][MAX_MEDIA_KEY_STATUS_NAME_LEN]
```

**Description**

Array of media key status names.


### statusValue [1/2]

```
char DRM_KeysInfo::statusValue[MAX_KEY_INFO_COUNT][MAX_KEY_STATUS_VALUE_LEN]
```

**Description**

Array of media key status values in the media key information.


### statusValue [2/2]

```
char DRM_MediaKeyStatus::statusValue[MAX_MEDIA_KEY_STATUS_COUNT][MAX_MEDIA_KEY_STATUS_VALUE_LEN]
```

**Description**

Array of media key status values in a media key session.


### type [1/2]

```
DRM_MediaKeyType DRM_MediaKeyRequestInfo::type
```

**Description**

Media key type, which can be online or offline, in a media key request.


### type [2/2]

```
DRM_MediaKeyRequestType DRM_MediaKeyRequest::type
```

**Description**

Type of a media key request.


### uuid [1/2]

```
uint8_t DRM_PsshInfo::uuid[DRM_UUID_LEN]
```

**Description**
UUID of a DRM scheme in PSSH data.


### uuid [2/2]

```
uint8_t DRM_MediaKeySystemDescription::uuid[DRM_UUID_LEN]
```
**Description**
UUID of a DRM scheme supported by the device.