Drm

Overview

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

Since: 11

Summary

Files

Name	Description
native_drm_common.h	Declares the DRM data types. File to include: <multimedia/drm_framework/native_drm_common.h> Library: libnative_drm.z.so
native_drm_err.h	Declares the DRM error codes. File to include: <multimedia/drm_framework/native_drm_err.h> Library: libnative_drm.z.so
native_mediakeysession.h	Declares the MediaKeySession API. File to include: <multimedia/drm_framework/native_mediakeysession.h> Library: libnative_drm.z.so
native_mediakeysystem.h	Declares the MediaKeySystem API. File to include: <multimedia/drm_framework/native_mediakeysystem.h> Library: libnative_drm.z.so

Structs

Name	Description
struct DRM_MediaKeyRequestInfo	Describes the information about a media key request.
struct DRM_MediaKeyRequest	Describes a media key request.
struct DRM_Statistics	Describes the statistics information about a media key system.
struct DRM_OfflineMediakeyIdArray	Describes an array holding the IDs of offline media keys.
struct DRM_KeysInfo	Describes the information about media keys.
struct DRM_MediaKeyStatus	Describes the media key status.
struct DRM_PsshInfo	Describes the Protection Scheme Specific Header (PSSH) information of the UUID.
struct DRM_MediaKeySystemInfo	Describes the media key system information obtained from a media source.
struct MediaKeySession_Callback	Describes the callback used to listen for events such as media key expiry or change.
struct DRM_MediaKeySystemDescription	Describes the name and UUID of a DRM plug-in.

Macros

Name	Description
MAX_MEDIA_KEY_REQUEST_OPTION_COUNT 16	Maximum number of options in a media key request.
MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN 64	Maximum length of an option name in a media key request.
MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN 128	Maximum length of option data in a media key request.
MAX_INIT_DATA_LEN 2048	Maximum length of data in an initial request.
MAX_MIMETYPE_LEN 64	Maximum length of a MIME type.
MAX_MEDIA_KEY_REQUEST_DATA_LEN 8192	Maximum length of a media key request.
MAX_DEFAULT_URL_LEN 2048	Maximum length of a URL.
MAX_STATISTICS_COUNT 10	Maximum number of statistical items.
MAX_STATISTICS_NAME_LEN 64	Maximum length of a statistical item name.
MAX_STATISTICS_BUFFER_LEN 256	Maximum length of a statistical item buffer.
MAX_OFFLINE_MEDIA_KEY_ID_COUNT 512	Maximum number of offline media key IDs.
MAX_OFFLINE_MEDIA_KEY_ID_LEN 64	Maximum length of an offline media key ID.
MAX_KEY_INFO_COUNT 64	Maximum number of pieces of media key information.
MAX_KEY_ID_LEN 16	Maximum length of a media key ID.
MAX_KEY_STATUS_VALUE_LEN 128	Maximum length of a key status value.
MAX_MEDIA_KEY_STATUS_COUNT 64	Maximum number of media key statuses.
MAX_MEDIA_KEY_STATUS_NAME_LEN 64	Maximum length of a media key status name.
MAX_MEDIA_KEY_STATUS_VALUE_LEN 256	Maximum length of a media key status value.
DRM_UUID_LEN 16	UUID length.
MAX_PSSH_DATA_LEN 2048	Maximum length of PSSH data.
MAX_PSSH_INFO_COUNT 8	Maximum number of pieces of PSSH information.
MAX_MEDIA_KEY_SYSTEM_NAME_LEN 128	Maximum length of a media key system name.
MAX_MEDIA_KEY_SYSTEM_NUM 8	Maximum number of supported media key systems.

Types

Name	Description
typedef enum DRM_EventType DRM_EventType	Defines an enum for the types of events that can be subscribed to.
typedef enum DRM_ContentProtectionLevel DRM_ContentProtectionLevel	Defines an enum for the content protection levels.
typedef enum DRM_MediaKeyType DRM_MediaKeyType	Defines an enum for the media key types.
typedef enum DRM_MediaKeyRequestType DRM_MediaKeyRequestType	Defines an enum for the types of requests for media keys.
typedef enum DRM_OfflineMediaKeyStatus DRM_OfflineMediaKeyStatus	Defines an enum for the statuses of offline media keys.
typedef enum DRM_CertificateStatus DRM_CertificateStatus	Defines an enum for the certificate statuses.
typedef struct DRM_MediaKeyRequestInfo DRM_MediaKeyRequestInfo	Defines a struct for the information about a media key request.
typedef struct DRM_MediaKeyRequest DRM_MediaKeyRequest	Defines a struct for a media key request.
typedef struct DRM_Statistics DRM_Statistics	Defines a struct for the statistics information about a media key system.
typedef struct DRM_OfflineMediakeyIdArray DRM_OfflineMediakeyIdArray	Defines a struct for an array holding the IDs of offline media keys.
typedef struct DRM_KeysInfo DRM_KeysInfo	Defines a struct for the information about media keys.
typedef struct DRM_MediaKeyStatus DRM_MediaKeyStatus	Defines a struct for the media key status.
typedef struct DRM_PsshInfo DRM_PsshInfo	Defines a struct for the PSSH information of the UUID.
typedef struct DRM_MediaKeySystemInfo DRM_MediaKeySystemInfo	Defines a struct for the media key system information obtained from a media source.
typedef struct DRM_MediaKeySystemDescription DRM_MediaKeySystemDescription	Defines a struct for the name and UUID of a DRM plug-in.
typedef void(* DRM_MediaKeySystemInfoCallback) (DRM_MediaKeySystemInfo *mediaKeySystemInfo)	Defines the callback used to obtain media key system information from a media source.
typedef struct MediaKeySystem MediaKeySystem	Defines a struct for a media key system.
typedef struct MediaKeySession MediaKeySession	Defines a struct for a media key session.
typedef enum Drm_ErrCode Drm_ErrCode	Defines an enum for the DRM error codes.
typedef Drm_ErrCode(* MediaKeySession_EventCallback) (DRM_EventType eventType, uint8_t info, int32_t infoLen, char extra)	Defines the callback that is invoked when a DRM event is triggered.
typedef Drm_ErrCode(* MediaKeySession_KeyChangeCallback) (DRM_KeysInfo *keysInfo, bool newKeysAvailable)	Defines the callback that is invoked when the key is changed.
typedef struct MediaKeySession_Callback MediaKeySession_Callback	Defines the callback used to listen for events such as media key expiry or change.
typedef Drm_ErrCode(* MediaKeySystem_Callback) (DRM_EventType eventType, uint8_t info, int32_t infoLen, char extra)	Defines the callback that is invoked when a DRM event is triggered.

Enums

Name	Description
DRM_EventType { EVENT_DRM_BASE = 200, EVENT_PROVISION_REQUIRED = 201, EVENT_KEY_REQUIRED = 202, EVENT_KEY_EXPIRED = 203, EVENT_VENDOR_DEFINED = 204, EVENT_EXPIRATION_UPDATE = 206 }	Enumerates the types of events that can be subscribed to.
DRM_ContentProtectionLevel { CONTENT_PROTECTION_LEVEL_UNKNOWN = 0, CONTENT_PROTECTION_LEVEL_SW_CRYPTO, CONTENT_PROTECTION_LEVEL_HW_CRYPTO, CONTENT_PROTECTION_LEVEL_ENHANCED_HW_CRYPTO, CONTENT_PROTECTION_LEVEL_MAX }	Enumerates the content protection levels.
DRM_MediaKeyType { MEDIA_KEY_TYPE_OFFLINE = 0, MEDIA_KEY_TYPE_ONLINE }	Enumerates the media key types.
DRM_MediaKeyRequestType { MEDIA_KEY_REQUEST_TYPE_UNKNOWN = 0, MEDIA_KEY_REQUEST_TYPE_INITIAL, MEDIA_KEY_REQUEST_TYPE_RENEWAL, MEDIA_KEY_REQUEST_TYPE_RELEASE, MEDIA_KEY_REQUEST_TYPE_NONE, MEDIA_KEY_REQUEST_TYPE_UPDATE }	Enumerates the types of requests for media keys.
DRM_OfflineMediaKeyStatus { OFFLINE_MEDIA_KEY_STATUS_UNKNOWN = 0, OFFLINE_MEDIA_KEY_STATUS_USABLE, OFFLINE_MEDIA_KEY_STATUS_INACTIVE }	Enumerates the statuses of offline media keys.
DRM_CertificateStatus { CERT_STATUS_PROVISIONED = 0, CERT_STATUS_NOT_PROVISIONED, CERT_STATUS_EXPIRED, CERT_STATUS_INVALID, CERT_STATUS_UNAVAILABLE }	Enumerates the certificate statuses.
Drm_ErrCode { DRM_ERR_OK = 0, DRM_CAPI_ERR_BASE = 24700500, DRM_ERR_NO_MEMORY = DRM_CAPI_ERR_BASE + 1, DRM_ERR_OPERATION_NOT_PERMITTED = DRM_CAPI_ERR_BASE + 2, DRM_ERR_INVALID_VAL = DRM_CAPI_ERR_BASE + 3, DRM_ERR_IO = DRM_CAPI_ERR_BASE + 4, DRM_ERR_TIMEOUT = DRM_CAPI_ERR_BASE + 5, DRM_ERR_UNKNOWN = DRM_CAPI_ERR_BASE + 6, DRM_ERR_SERVICE_DIED = DRM_CAPI_ERR_BASE + 7, DRM_ERR_INVALID_STATE = DRM_CAPI_ERR_BASE + 8, DRM_ERR_UNSUPPORTED = DRM_CAPI_ERR_BASE + 9, DRM_ERR_MAX_SYSTEM_NUM_REACHED = DRM_CAPI_ERR_BASE + 10, DRM_ERR_MAX_SESSION_NUM_REACHED = DRM_CAPI_ERR_BASE + 11, DRM_ERR_EXTEND_START = DRM_CAPI_ERR_BASE + 100 }	Enumerates the DRM error codes.

Functions

Name	Description
Drm_ErrCode OH_MediaKeySession_GenerateMediaKeyRequest (MediaKeySession mediaKeySession, DRM_MediaKeyRequestInfo info, DRM_MediaKeyRequest *mediaKeyRequest)	Generates a media key request.
Drm_ErrCode OH_MediaKeySession_ProcessMediaKeyResponse (MediaKeySession mediaKeySession, uint8_t response, int32_t responseLen, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen)	Processes a response to the media key request.
Drm_ErrCode OH_MediaKeySession_CheckMediaKeyStatus (MediaKeySession mediaKeySessoin, DRM_MediaKeyStatus mediaKeyStatus)	Checks the status of media keys.
Drm_ErrCode OH_MediaKeySession_ClearMediaKeys (MediaKeySession *mediaKeySessoin)	Clears media keys.
Drm_ErrCode OH_MediaKeySession_GenerateOfflineReleaseRequest (MediaKeySession mediaKeySessoin, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen, uint8_t releaseRequest, int32_t releaseRequestLen)	Generates a request to release offline media keys.
Drm_ErrCode OH_MediaKeySession_ProcessOfflineReleaseResponse (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 OH_MediaKeySession_RestoreOfflineMediaKeys (MediaKeySession mediaKeySessoin, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen)	Restores offline media keys.
Drm_ErrCode OH_MediaKeySession_GetContentProtectionLevel (MediaKeySession mediaKeySessoin, DRM_ContentProtectionLevel contentProtectionLevel)	Obtains the content protection level of a media key session.
Drm_ErrCode OH_MediaKeySession_RequireSecureDecoderModule (MediaKeySession mediaKeySessoin, const char mimeType, bool *status)	Checks whether secure decoding is required for encrypted content.
Drm_ErrCode OH_MediaKeySession_SetMediaKeySessionCallback (MediaKeySession mediaKeySessoin, MediaKeySession_Callback callback)	Sets a media key session event callback.
Drm_ErrCode OH_MediaKeySession_Destroy (MediaKeySession *mediaKeySessoin)	Releases the media key session resources.
bool OH_MediaKeySystem_IsSupported (const char *name)	Checks whether a media key system is supported.
bool OH_MediaKeySystem_IsSupported2 (const char name, const char mimeType)	Checks whether a media key system is supported.
bool OH_MediaKeySystem_IsSupported3 (const char name, const char mimeType, DRM_ContentProtectionLevel contentProtectionLevel)	Checks whether a media key system is supported.
Drm_ErrCode OH_MediaKeySystem_Create (const char name, MediaKeySystem *mediaKeySystem)	Creates a MediaKeySystem instance by name.
Drm_ErrCode OH_MediaKeySystem_SetConfigurationString (MediaKeySystem mediaKeySystem, const char configName, const char *value)	Sets a configuration item in the form of a string for a media key system.
Drm_ErrCode OH_MediaKeySystem_GetConfigurationString (MediaKeySystem mediaKeySystem, const char configName, char *value, int32_t valueLen)	Obtains the value of a configuration item in the form of a string for a media key system.
Drm_ErrCode OH_MediaKeySystem_SetConfigurationByteArray (MediaKeySystem mediaKeySystem, const char configName, uint8_t *value, int32_t valueLen)	Sets a configuration item in the form of a byte array for a media key system.
Drm_ErrCode OH_MediaKeySystem_GetConfigurationByteArray (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 for a media key system.
Drm_ErrCode OH_MediaKeySystem_GetStatistics (MediaKeySystem mediaKeySystem, DRM_Statistics statistics)	Obtains the statistics information about a media key system.
Drm_ErrCode OH_MediaKeySystem_GetMaxContentProtectionLevel (MediaKeySystem mediaKeySystem, DRM_ContentProtectionLevel contentProtectionLevel)	Obtains the media key system with the maximum content protection level supported by the device.
Drm_ErrCode OH_MediaKeySystem_SetMediaKeySystemCallback (MediaKeySystem *mediaKeySystem, MediaKeySystem_Callback callback)	Sets a media key system event callback.
Drm_ErrCode OH_MediaKeySystem_CreateMediaKeySession (MediaKeySystem mediaKeySystem, DRM_ContentProtectionLevel level, MediaKeySession **mediaKeySession)	Creates a MediaKeySession instance.
Drm_ErrCode OH_MediaKeySystem_GenerateKeySystemRequest (MediaKeySystem mediaKeySystem, uint8_t request, int32_t requestLen, char defaultUrl, int32_t defaultUrlLen)	Generates a media key system request to obtain a provision request.
Drm_ErrCode OH_MediaKeySystem_ProcessKeySystemResponse (MediaKeySystem mediaKeySystem, uint8_t response, int32_t responseLen)	Processes a response to the media key system request.
Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyIds (MediaKeySystem mediaKeySystem, DRM_OfflineMediakeyIdArray offlineMediaKeyIds)	Obtains the IDs of offline media keys.
Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyStatus (MediaKeySystem mediaKeySystem, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen, DRM_OfflineMediaKeyStatus *status)	Obtains the status of offline media keys.
Drm_ErrCode OH_MediaKeySystem_ClearOfflineMediaKeys (MediaKeySystem mediaKeySystem, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen)	Clears offline media keys by ID.
Drm_ErrCode OH_MediaKeySystem_GetCertificateStatus (MediaKeySystem mediaKeySystem, DRM_CertificateStatus certStatus)	Obtains the certificate status of a media key system.
Drm_ErrCode OH_MediaKeySystem_Destroy (MediaKeySystem *mediaKeySystem)	Destroys a MediaKeySystem instance.

Variables

Name	Description
DRM_MediaKeyType DRM_MediaKeyRequestInfo::type	Key type.
int32_t DRM_MediaKeyRequestInfo::initDataLen	Initial data length.
uint8_t DRM_MediaKeyRequestInfo::initData [MAX_INIT_DATA_LEN]	Initial data in PSSH format after Base64 decoding.
char DRM_MediaKeyRequestInfo::mimeType [MAX_MIMETYPE_LEN]	MIME type of the media context.
uint32_t DRM_MediaKeyRequestInfo::optionsCount	Number of options.
char DRM_MediaKeyRequestInfo::optionName [MAX_MEDIA_KEY_REQUEST_OPTION_COUNT][MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN]	Option name set.
char DRM_MediaKeyRequestInfo::optionData [MAX_MEDIA_KEY_REQUEST_OPTION_COUNT][MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN]	Option data set.
DRM_MediaKeyRequestType DRM_MediaKeyRequest::type	Type of a media key request.
int32_t DRM_MediaKeyRequest::dataLen	Length of data in a media key request.
uint8_t DRM_MediaKeyRequest::data [MAX_MEDIA_KEY_REQUEST_DATA_LEN]	Data in a media key request sent to the media key server.
char DRM_MediaKeyRequest::defaultUrl [MAX_DEFAULT_URL_LEN]	URL of a media key server.
uint32_t DRM_Statistics::statisticsCount	Number of statistical items.
char DRM_Statistics::statisticsName [MAX_STATISTICS_COUNT][MAX_STATISTICS_NAME_LEN]	Statistical item name set.
char DRM_Statistics::statisticsDescription [MAX_STATISTICS_COUNT][MAX_STATISTICS_BUFFER_LEN]	Set of statistics information description.
uint32_t DRM_OfflineMediakeyIdArray::idsCount	Number of IDs.
int32_t DRM_OfflineMediakeyIdArray::idsLen [MAX_OFFLINE_MEDIA_KEY_ID_COUNT]	ID length set.
uint8_t DRM_OfflineMediakeyIdArray::ids [MAX_OFFLINE_MEDIA_KEY_ID_COUNT][MAX_OFFLINE_MEDIA_KEY_ID_LEN]	ID data set.
uint32_t DRM_KeysInfo::keysInfoCount	Number of keys.
uint8_t DRM_KeysInfo::keyId [MAX_KEY_INFO_COUNT][MAX_KEY_ID_LEN]	Key ID set.
char DRM_KeysInfo::statusValue [MAX_KEY_INFO_COUNT][MAX_KEY_STATUS_VALUE_LEN]	Key status value.
uint32_t DRM_MediaKeyStatus::statusCount	Number of media key statuses.
char DRM_MediaKeyStatus::statusName [MAX_MEDIA_KEY_STATUS_COUNT][MAX_MEDIA_KEY_STATUS_NAME_LEN]	Array of status names.
char DRM_MediaKeyStatus::statusValue [MAX_MEDIA_KEY_STATUS_COUNT][MAX_MEDIA_KEY_STATUS_VALUE_LEN]	Array of status values.
uint8_t DRM_PsshInfo::uuid [DRM_UUID_LEN]	UUID.
int32_t DRM_PsshInfo::dataLen	PSSH data length.
uint8_t DRM_PsshInfo::data [MAX_PSSH_DATA_LEN]	uint8_t PSSH data.
uint32_t DRM_MediaKeySystemInfo::psshCount	Number of pieces of PSSH data.
DRM_PsshInfo DRM_MediaKeySystemInfo::psshInfo [MAX_PSSH_INFO_COUNT]	PSSH information.
char DRM_MediaKeySystemDescription::name [MAX_MEDIA_KEY_SYSTEM_NAME_LEN]	Name of the DRM plug-in.
uint8_t DRM_MediaKeySystemDescription::uuid [DRM_UUID_LEN]	UUID of the DRM plug-in.
MediaKeySession_EventCallback MediaKeySession_Callback::eventCallback	Event callback, for example, a media key expiry event.
MediaKeySession_KeyChangeCallback MediaKeySession_Callback::keyChangeCallback	Callback of the media key change event.

Macro Description

DRM_UUID_LEN

#define DRM_UUID_LEN   16

Description

UUID length.

Since: 11

MAX_DEFAULT_URL_LEN

#define MAX_DEFAULT_URL_LEN   2048

Description

Maximum length of a URL.

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 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 options 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 option 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 option 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 media key system name.

Since: 12

MAX_MEDIA_KEY_SYSTEM_NUM

#define MAX_MEDIA_KEY_SYSTEM_NUM   8

Description

Maximum number of supported media key systems.

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

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 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 requests for media keys.

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 plug-in.

Since: 12

DRM_MediaKeySystemInfo

typedef struct DRM_MediaKeySystemInfo DRM_MediaKeySystemInfo

Description

Defines a struct for the media key system information obtained from a media source.

Since: 11

DRM_MediaKeySystemInfoCallback

typedef void(* DRM_MediaKeySystemInfoCallback) (DRM_MediaKeySystemInfo *mediaKeySystemInfo)

Description

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

Since: 11

Parameters

Name	Description
mediaKeySystemInfo	Pointer to the media key system information obtained from the media source.

DRM_MediaKeyType

typedef enum DRM_MediaKeyType DRM_MediaKeyType

Description

Defines an enum for the media key types.

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 information of the UUID.

Since: 11

DRM_Statistics

typedef struct DRM_Statistics DRM_Statistics

Description

Defines a struct for the statistics information about 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 or change.

Since: 11

MediaKeySession_EventCallback

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

Description

Defines the callback that is invoked when a DRM event is triggered.

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 key information obtained from the media key system.
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 that is invoked when a DRM event is triggered.

Since: 11

Parameters

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

Returns

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

Enum Description

DRM_CertificateStatus

enum DRM_CertificateStatus

Description

Enumerates the certificate statuses.

System capability: SystemCapability.Multimedia.Drm.Core

Since: 11

Value	Description
CERT_STATUS_PROVISIONED	A device certificate has been installed on the device.
CERT_STATUS_NOT_PROVISIONED	No device certificate is installed on the device.
CERT_STATUS_EXPIRED	The device certificate has expired.
CERT_STATUS_INVALID	The device certificate is invalid.
CERT_STATUS_UNAVAILABLE	The device 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 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 suspended.
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 device 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 requests for media keys.

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 media key types.

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 DRM_ERR_OK is the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails.

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 DRM_ERR_OK is the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails.

OH_MediaKeySession_Destroy()

Drm_ErrCode OH_MediaKeySession_Destroy (MediaKeySession * mediaKeySessoin)

Description

Releases the media key session resources.

Since: 11

Parameters

Name	Description
mediaKeySession	Pointer to the MediaKeySession instance.

Returns

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

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

Returns

Returns an error code defined in Drm_ErrCode.

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 the offline media keys.
releaseRequestLen	Length of the offline media key ID.

Returns

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

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

Returns

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

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 response to the media key request.

Since: 11

Parameters

Name	Description
mediaKeySession	Pointer to the MediaKeySession instance.
response	Pointer to the response.
responseLen	Length of the response.
offlineMediaKeyId	Pointer to the ID of the offline media keys.
offlineMediaKeyIdLen	Pointer to the length of the offline media key ID for data inside and outside the buffer.

Returns

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

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 the offline media keys.
offlineMediaKeyIdLen	Length of the offline media key ID.
releaseReponse	Pointer to the response.
releaseReponseLen	Length of the response.

Returns

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

OH_MediaKeySession_RequireSecureDecoderModule()

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

Description

Checks whether secure decoding is required for encrypted content.

Since: 11

Parameters

Name	Description
mediaKeySession	Pointer to the MediaKeySession instance.
mimeType	Pointer to the MIME type.
status	Pointer to the result indicating whether secure decoding is required.

Returns

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

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 the offline media keys.
offlineMediaKeyIdLen	Length of the offline media key ID.

Returns

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

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 to be set for the media key session.

Returns

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

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 the offline media keys.
offlineMediaKeyIdLen	Length of the offline media key ID.

Returns

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

OH_MediaKeySystem_Create()

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

Description

Creates a MediaKeySystem instance by name.

Since: 11

Parameters

Name	Description
name	Pointer to the name.
mediaKeySystem	Double pointer to the MediaKeySystem instance created.

Returns

Returns DRM_ERR_OK if the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails; returns DRM_ERR_MAX_SYSTEM_NUM_REACHED if the maximum number of media key systems is reached.

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 for which a MediaKeySession instance will be created.
level	Pointer to the content protection level.
mediaKeySession	Double pointer to the MediaKeySession instance created.

Returns

Returns DRM_ERR_OK if the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails; returns DRM_ERR_MAX_SESSION_NUM_REACHED if the maximum number of media key sessions is reached.

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 DRM_ERR_OK is the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails.

OH_MediaKeySystem_GenerateKeySystemRequest()

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

Description

Generates a media key system request to obtain a provision request.

Since: 11

Parameters

Name	Description
mediaKeySystem	Pointer to the MediaKeySystem instance.
request	Pointer to the provision request, which will be sent to the 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 DRM_ERR_OK is the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails.

OH_MediaKeySystem_GetCertificateStatus()

Drm_ErrCode OH_MediaKeySystem_GetCertificateStatus (MediaKeySystem * mediaKeySystem, DRM_CertificateStatus * certStatus )

Description

Obtains the certificate status of a media key system.

Since: 11

Parameters

Name	Description
mediaKeySystem	Pointer to the MediaKeySystem instance.
certStatus	Pointer to the certificate status obtained.

Returns

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

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 a byte array for a media key system.

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 DRM_ERR_OK is the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails.

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 for a media key system.

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 DRM_ERR_OK is the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails.

OH_MediaKeySystem_GetMaxContentProtectionLevel()

Drm_ErrCode OH_MediaKeySystem_GetMaxContentProtectionLevel (MediaKeySystem * mediaKeySystem, DRM_ContentProtectionLevel * contentProtectionLevel )

Description

Obtains the media key system with 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 DRM_ERR_OK is the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails.

OH_MediaKeySystem_GetMediaKeySystems()

Drm_ErrCode OH_MediaKeySystem_GetMediaKeySystems (DRM_MediaKeySystemDescription * infos, uint32_t * count )

Description

Obtains the names and UUIDs of the supported media key systems.

Since: 12

Parameters

Name	Description
infos	Array holding the names and UUIDs of the media key systems.
count	Number of the DRM_MediaKeySystemMapInfo structs.

Returns

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

OH_MediaKeySystem_GetOfflineMediaKeyIds()

Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyIds (MediaKeySystem * mediaKeySystem, DRM_OfflineMediakeyIdArray * offlineMediaKeyIds )

Description

Obtains the IDs of offline media keys.

Since: 11

Parameters

Name	Description
mediaKeySystem	Pointer to the MediaKeySystem instance.
offlineMediaKeyIds	Pointer to the IDs of all offline media keys.

Returns

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

OH_MediaKeySystem_GetOfflineMediaKeyStatus()

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

Description

Obtains the status of offline media keys.

Since: 11

Parameters

Name	Description
mediaKeySystem	Pointer to the MediaKeySystem instance.
offlineMediaKeyId	Pointer to the ID of the offline media keys.
offlineMediaKeyIdLen	Length of the offline media key ID.
status	Pointer to the media key status obtained.

Returns

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

OH_MediaKeySystem_GetStatistics()

Drm_ErrCode OH_MediaKeySystem_GetStatistics (MediaKeySystem * mediaKeySystem, DRM_Statistics * statistics )

Description

Obtains the statistics information about a media key system.

Since: 11

Parameters

Name	Description
mediaKeySystem	Pointer to the MediaKeySystem instance.
statistics	Pointer to the statistics information obtained.

Returns

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

OH_MediaKeySystem_IsSupported()

bool OH_MediaKeySystem_IsSupported (const char * name)

Description

Checks whether a media key system is supported.

Since: 11

Parameters

Name	Description
name	Pointer to the name of the media key system.

Returns

Returns true if the media key system is supported; returns false otherwise.

OH_MediaKeySystem_IsSupported2()

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

Description

Checks whether a media key system is supported.

Since: 11

Parameters

Name	Description
name	Pointer to the name of the media key system.
mimeType	Pointer to the MIME type.

Returns

Returns true if the media key system is supported; returns false otherwise.

OH_MediaKeySystem_IsSupported3()

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

Description

Checks whether a media key system is supported.

Since: 11

Parameters

Name	Description
name	Pointer to the name of the media key system.
mimeType	Pointer to the MIME type.
contentProtectionLevel	Content protection level.

Returns

Returns true if the media key system is supported; returns false otherwise.

OH_MediaKeySystem_ProcessKeySystemResponse()

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

Description

Processes a response to the media key system request.

Since: 11

Parameters

Name	Description
mediaKeySystem	Pointer to the MediaKeySystem instance.
response	Pointer to the response.
responseLen	Length of the response.

Returns

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

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 a byte array for a media key system.

Since: 11

Parameters

Name	Description
mediaKeySystem	Pointer to the MediaKeySystem instance.
configName	Pointer to the name of the configuration item.
value	Pointer to the values of the configuration item, in the form of a byte array.
valueLen	Length of the byte array.

Returns

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

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 for a media key system.

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 DRM_ERR_OK is the call is successful; returns DRM_ERR_INVALID_VAL if the parameter check fails.

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 to be set for the media key system.

Returns

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

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 media key server.

data [2/2]

uint8_t DRM_PsshInfo::data[MAX_PSSH_DATA_LEN]

Description

uint8_t 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

PSSH data length.

defaultUrl

char DRM_MediaKeyRequest::defaultUrl[MAX_DEFAULT_URL_LEN]

Description

URL of a media key server.

eventCallback

MediaKeySession_EventCallback MediaKeySession_Callback::eventCallback

Description

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

ID data set.

idsCount

uint32_t DRM_OfflineMediakeyIdArray::idsCount

Description

Number of IDs.

idsLen

int32_t DRM_OfflineMediakeyIdArray::idsLen[MAX_OFFLINE_MEDIA_KEY_ID_COUNT]

Description

ID length set.

initData

uint8_t DRM_MediaKeyRequestInfo::initData[MAX_INIT_DATA_LEN]

Description

Initial data in PSSH format after Base64 decoding.

initDataLen

int32_t DRM_MediaKeyRequestInfo::initDataLen

Description

Initial data length.

keyChangeCallback

MediaKeySession_KeyChangeCallback MediaKeySession_Callback::keyChangeCallback

Description

Callback of the media key change event.

keyId

uint8_t DRM_KeysInfo::keyId[MAX_KEY_INFO_COUNT][MAX_KEY_ID_LEN]

Description

Key ID set.

keysInfoCount

uint32_t DRM_KeysInfo::keysInfoCount

Description

Number of keys.

mimeType

char DRM_MediaKeyRequestInfo::mimeType[MAX_MIMETYPE_LEN]

Description

MIME type of the media context.

name

char DRM_MediaKeySystemDescription::name[MAX_MEDIA_KEY_SYSTEM_NAME_LEN]

Description Name of the DRM plug-in.

optionData

char DRM_MediaKeyRequestInfo::optionData[MAX_MEDIA_KEY_REQUEST_OPTION_COUNT][MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN]

Description

Option data set.

optionName

char DRM_MediaKeyRequestInfo::optionName[MAX_MEDIA_KEY_REQUEST_OPTION_COUNT][MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN]

Description

Option name set.

optionsCount

uint32_t DRM_MediaKeyRequestInfo::optionsCount

Description

Number of options.

psshCount

uint32_t DRM_MediaKeySystemInfo::psshCount

Description

Number of pieces of PSSH data.

psshInfo

DRM_PsshInfo DRM_MediaKeySystemInfo::psshInfo[MAX_PSSH_INFO_COUNT]

Description

PSSH 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

Set of statistics information description.

statisticsName

char DRM_Statistics::statisticsName[MAX_STATISTICS_COUNT][MAX_STATISTICS_NAME_LEN]

Description

Statistical item name set.

statusCount

uint32_t DRM_MediaKeyStatus::statusCount

Description

Number of media key statuses.

statusName

char DRM_MediaKeyStatus::statusName[MAX_MEDIA_KEY_STATUS_COUNT][MAX_MEDIA_KEY_STATUS_NAME_LEN]

Description

Array of status names.

statusValue [1/2]

char DRM_KeysInfo::statusValue[MAX_KEY_INFO_COUNT][MAX_KEY_STATUS_VALUE_LEN]

Description

Key status value.

statusValue [2/2]

char DRM_MediaKeyStatus::statusValue[MAX_MEDIA_KEY_STATUS_COUNT][MAX_MEDIA_KEY_STATUS_VALUE_LEN]

Description

Array of status values.

type [1/2]

DRM_MediaKeyType DRM_MediaKeyRequestInfo::type

Description

Key type.

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.

uuid [2/2]

uint8_t DRM_MediaKeySystemDescription::uuid[DRM_UUID_LEN]

Description

UUID.