1# native_drm_common.h 2 3## 概述 4 5定义DRM数据类型。 6 7**引用文件：** <multimedia/drm_framework/native_drm_common.h> 8 9**库：** libnative_drm.z.so 10 11**系统能力：** SystemCapability.Multimedia.Drm.Core 12 13**起始版本：** 11 14 15**相关模块：** [Drm](capi-drm.md) 16 17## 汇总 18 19### 结构体 20 21| 名称 | typedef关键字 | 描述 | 22| -- | -- | -- | 23| [DRM_MediaKeyRequestInfo](capi-drm-drm-mediakeyrequestinfo.md) | DRM_MediaKeyRequestInfo | 媒体密钥请求信息。 | 24| [DRM_MediaKeyRequest](capi-drm-drm-mediakeyrequest.md) | DRM_MediaKeyRequest | 媒体密钥请求。 | 25| [DRM_Statistics](capi-drm-drm-statistics.md) | DRM_Statistics | MediaKeySystem的度量信息。 | 26| [DRM_OfflineMediakeyIdArray](capi-drm-drm-offlinemediakeyidarray.md) | DRM_OfflineMediakeyIdArray | 离线媒体密钥ID数组。 | 27| [DRM_KeysInfo](capi-drm-drm-keysinfo.md) | DRM_KeysInfo | 媒体密钥信息。 | 28| [DRM_MediaKeyStatus](capi-drm-drm-mediakeystatus.md) | DRM_MediaKeyStatus | 媒体密钥状态。 | 29| [DRM_PsshInfo](capi-drm-drm-psshinfo.md) | DRM_PsshInfo | DRM内容保护系统专用头（Protection System Specific Header）信息。 | 30| [DRM_MediaKeySystemInfo](capi-drm-drm-mediakeysysteminfo.md) | DRM_MediaKeySystemInfo | 加密媒体内容的DRM信息。 | 31| [DRM_MediaKeySystemDescription](capi-drm-drm-mediakeysystemdescription.md) | DRM_MediaKeySystemDescription | DRM解决方案名称及其UUID的列表。| 32| [MediaKeySystem](capi-drm-mediakeysystem.md) | MediaKeySystem | MediaKeySystem结构。 | 33| [MediaKeySession](capi-drm-mediakeysession.md) | MediaKeySession | MediaKeySession结构。 | 34 35### 枚举 36 37| 名称 | typedef关键字 | 描述 | 38| -- | -- | -- | 39| [DRM_EventType](#drm_eventtype) | DRM_EventType | 监听事件类型。 | 40| [DRM_ContentProtectionLevel](#drm_contentprotectionlevel) | DRM_ContentProtectionLevel | 内容保护级别。 | 41| [DRM_MediaKeyType](#drm_mediakeytype) | DRM_MediaKeyType | 媒体密钥类型。 | 42| [DRM_MediaKeyRequestType](#drm_mediakeyrequesttype) | DRM_MediaKeyRequestType | 媒体密钥请求类型。 | 43| [DRM_OfflineMediaKeyStatus](#drm_offlinemediakeystatus) | DRM_OfflineMediaKeyStatus | 离线媒体密钥状态。 | 44| [DRM_CertificateStatus](#drm_certificatestatus) | DRM_CertificateStatus | 设备DRM证书状态。 | 45 46### 函数 47 48| 名称 | typedef关键字 | 描述 | 49| -- | -- | -- | 50| [typedef void (\*DRM_MediaKeySystemInfoCallback)(DRM_MediaKeySystemInfo *mediaKeySystemInfo)](#drm_mediakeysysteminfocallback) | DRM_MediaKeySystemInfoCallback | 应用为从媒体源获取DRM信息而设置的回调。 | 51 52### 宏定义 53 54| 名称 | 描述 | 55| -- | -- | 56| MAX_MEDIA_KEY_REQUEST_OPTION_COUNT 16 | 媒体密钥请求可选数据的最大数量。<br>**起始版本：** 11 | 57| MAX_MEDIA_KEY_REQUEST_OPTION_NAME_LEN 64 | 媒体密钥请求可选数据名称的最大长度。<br>**起始版本：** 11 | 58| MAX_MEDIA_KEY_REQUEST_OPTION_DATA_LEN 128 | 媒体密钥请求可选数据的最大长度。<br>**起始版本：** 11 | 59| MAX_INIT_DATA_LEN 2048 | 媒体密钥请求初始化数据的最大长度。<br>**起始版本：** 11 | 60| MAX_MIMETYPE_LEN 64 | 媒体mimetype的最大长度。<br>**起始版本：** 11 | 61| MAX_MEDIA_KEY_REQUEST_DATA_LEN 8192 | 媒体密钥请求数据的最大长度。<br>**起始版本：** 11 | 62| MAX_DEFAULT_URL_LEN 2048 | URL最大长度。<br>**起始版本：** 11 | 63| MAX_STATISTICS_COUNT 10 | 度量记录的最大数量。<br>**起始版本：** 11 | 64| MAX_STATISTICS_NAME_LEN 64 | 度量记录名称的最大长度。<br>**起始版本：** 11 | 65| MAX_STATISTICS_BUFFER_LEN 256 | 度量记录缓冲区的最大长度。<br>**起始版本：** 11 | 66| MAX_OFFLINE_MEDIA_KEY_ID_COUNT 512 | 离线媒体密钥标识的最大数量。<br>**起始版本：** 11 | 67| MAX_OFFLINE_MEDIA_KEY_ID_LEN 64 | 离线媒体密钥标识的最大长度。<br>**起始版本：** 11 | 68| MAX_KEY_INFO_COUNT 64 | 密钥信息的最大数量。<br>**起始版本：** 11 | 69| MAX_KEY_ID_LEN 16 | 密钥标识的最大长度。<br>**起始版本：** 11 | 70| MAX_KEY_STATUS_VALUE_LEN 128 | 密钥状态值的最大长度。<br>**起始版本：** 11 | 71| MAX_MEDIA_KEY_STATUS_COUNT 64 | 媒体密钥状态的最大数量。<br>**起始版本：** 11 | 72| MAX_MEDIA_KEY_STATUS_NAME_LEN 64 | 媒体密钥状态名称的最大长度。<br>**起始版本：** 11 | 73| MAX_MEDIA_KEY_STATUS_VALUE_LEN 256 | 媒体密钥状态值的最大长度。<br>**起始版本：** 11 | 74| DRM_UUID_LEN 16 | DRM解决方案的UUID长度。<br>**起始版本：** 11 | 75| MAX_PSSH_DATA_LEN 2048 | PSSH（Protected System Specific Header）信息的最大长度。<br>**起始版本：** 11 | 76| MAX_PSSH_INFO_COUNT 8 | PSSH（Protected System Specific Header）信息的最大数量。<br>**起始版本：** 11 | 77| MAX_MEDIA_KEY_SYSTEM_NAME_LEN 128 | MediaKeySystem名称的最大长度。<br>**起始版本：** 12 | 78| MAX_MEDIA_KEY_SYSTEM_NUM 8 | MediaKeySystem的最大数量。<br>**起始版本：** 12 | 79 80## 枚举类型说明 81 82### DRM_EventType 83 84``` 85enum DRM_EventType 86``` 87 88**描述** 89 90监听事件类型。 91 92**系统能力：** SystemCapability.Multimedia.Drm.Core 93 94**起始版本：** 11 95 96| 枚举项 | 描述 | 97| -- | -- | 98| EVENT_DRM_BASE = 200 | DRM基础事件。 | 99| EVENT_PROVISION_REQUIRED = 201 | 设备证书请求事件。 | 100| EVENT_KEY_REQUIRED = 202 | 密钥请求事件。 | 101| EVENT_KEY_EXPIRED = 203 | 密钥过期事件。 | 102| EVENT_VENDOR_DEFINED = 204 | DRM解决方案自定义事件。 | 103| EVENT_EXPIRATION_UPDATE = 206 | 密钥过期更新事件。 | 104 105### DRM_ContentProtectionLevel 106 107``` 108enum DRM_ContentProtectionLevel 109``` 110 111**描述** 112 113内容保护级别。 114 115**系统能力：** SystemCapability.Multimedia.Drm.Core 116 117**起始版本：** 11 118 119| 枚举项 | 描述 | 120| -- | -- | 121| CONTENT_PROTECTION_LEVEL_UNKNOWN = 0 | 未知级别。 | 122| CONTENT_PROTECTION_LEVEL_SW_CRYPTO | 软件安全级别。 | 123| CONTENT_PROTECTION_LEVEL_HW_CRYPTO | 硬件安全级别。 | 124| CONTENT_PROTECTION_LEVEL_ENHANCED_HW_CRYPTO | 硬件增强级别。 | 125| CONTENT_PROTECTION_LEVEL_MAX | 最大安全级别。 | 126 127### DRM_MediaKeyType 128 129``` 130enum DRM_MediaKeyType 131``` 132 133**描述** 134 135媒体密钥类型。 136 137**系统能力：** SystemCapability.Multimedia.Drm.Core 138 139**起始版本：** 11 140 141| 枚举项 | 描述 | 142| -- | -- | 143| MEDIA_KEY_TYPE_OFFLINE = 0 | 离线。 | 144| MEDIA_KEY_TYPE_ONLINE | 在线。 | 145 146### DRM_MediaKeyRequestType 147 148``` 149enum DRM_MediaKeyRequestType 150``` 151 152**描述** 153 154媒体密钥请求类型。 155 156**系统能力：** SystemCapability.Multimedia.Drm.Core 157 158**起始版本：** 11 159 160| 枚举项 | 描述 | 161| -- | -- | 162| MEDIA_KEY_REQUEST_TYPE_UNKNOWN = 0 | 未知请求类型。 | 163| MEDIA_KEY_REQUEST_TYPE_INITIAL | 初始化请求。 | 164| MEDIA_KEY_REQUEST_TYPE_RENEWAL | 续订请求。 | 165| MEDIA_KEY_REQUEST_TYPE_RELEASE | 释放请求。 | 166| MEDIA_KEY_REQUEST_TYPE_NONE | 无请求。 | 167| MEDIA_KEY_REQUEST_TYPE_UPDATE | 更新请求。 | 168 169### DRM_OfflineMediaKeyStatus 170 171``` 172enum DRM_OfflineMediaKeyStatus 173``` 174 175**描述** 176 177离线媒体密钥状态。 178 179**系统能力：** SystemCapability.Multimedia.Drm.Core 180 181**起始版本：** 11 182 183| 枚举项 | 描述 | 184| -- | -- | 185| OFFLINE_MEDIA_KEY_STATUS_UNKNOWN = 0 | 未知状态。 | 186| OFFLINE_MEDIA_KEY_STATUS_USABLE | 可用状态。 | 187| OFFLINE_MEDIA_KEY_STATUS_INACTIVE | 失活状态。 | 188 189### DRM_CertificateStatus 190 191``` 192enum DRM_CertificateStatus 193``` 194 195**描述** 196 197设备DRM证书状态。 198 199**系统能力：** SystemCapability.Multimedia.Drm.Core 200 201**起始版本：** 11 202 203| 枚举项 | 描述 | 204| -- | -- | 205| CERT_STATUS_PROVISIONED = 0 | 设备已安装设备DRM证书。 | 206| CERT_STATUS_NOT_PROVISIONED | 设备未安装设备DRM证书或证书状态异常。 | 207| CERT_STATUS_EXPIRED | 设备DRM证书过期。 | 208| CERT_STATUS_INVALID | 设备DRM证书无效。 | 209| CERT_STATUS_UNAVAILABLE | 设备DRM证书不可用。 | 210 211 212## 函数说明 213 214### DRM_MediaKeySystemInfoCallback() 215 216``` 217typedef void (*DRM_MediaKeySystemInfoCallback)(DRM_MediaKeySystemInfo *mediaKeySystemInfo) 218``` 219 220**描述** 221 222应用为从媒体源获取DRM信息而设置的回调。 223 224**起始版本：** 11 225 226 227**参数：** 228 229| 参数项 | 描述 | 230| -- | -- | 231| [DRM_MediaKeySystemInfo](capi-drm-drm-mediakeysysteminfo.md) *mediaKeySystemInfo | 从媒体源获取的DRM信息。 | 232 233 234