• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Interfaces (Others)
2
3> **NOTE**
4>
5> The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.
6
7## ProvisionRequest
8
9Describes a provision request, which is used to request a DRM certificate from a provisioning server.
10
11**Atomic service API**: This API can be used in atomic services since API version 14.
12
13**System capability**: SystemCapability.Multimedia.Drm.Core
14
15| Name     | Type                          | Mandatory| Description        |
16| -------- | ----------------------------- |---- | ------------- |
17| data   | Uint8Array | Yes | Data carried in the provision request.     |
18| defaultURL     | string                 | Yes | URL of the provisioning server (which provisions DRM certificates).      |
19
20## OptionsData
21
22Describes the optional data carried in a media key request.
23
24**Atomic service API**: This API can be used in atomic services since API version 12.
25
26**System capability**: SystemCapability.Multimedia.Drm.Core
27
28| Name     | Type                          | Mandatory| Description        |
29| -------- | ----------------------------- |---- | ------------- |
30| name   | string | Yes | Name of the optional data.     |
31| value     | string                 | Yes | Value of the optional data.      |
32
33## MediaKeyRequest
34
35Describes a media key request.
36
37**Atomic service API**: This API can be used in atomic services since API version 12.
38
39**System capability**: SystemCapability.Multimedia.Drm.Core
40
41| Name     | Type                          | Mandatory| Description        |
42| -------- | ----------------------------- |---- | ------------- |
43| mediaKeyRequestType   | [MediaKeyRequestType](arkts-apis-drm-e.md#mediakeyrequesttype) | Yes | Type of the media key request.     |
44| data     | Uint8Array                 | Yes | Data carried in the media key request.      |
45| defaultURL     | string                 | Yes | URL of the license server (which provisions media keys).      |
46
47## EventInfo
48
49Describes the event information.
50
51**Atomic service API**: This API can be used in atomic services since API version 12.
52
53**System capability**: SystemCapability.Multimedia.Drm.Core
54
55| Name     | Type                          | Mandatory| Description        |
56| -------- | ----------------------------- |---- | ------------- |
57| info   | Uint8Array | Yes | Event information.     |
58| extraInfo     | string                 | Yes | Extended event information.      |
59
60## StatisticKeyValue
61
62Describes the statistical information.
63
64**Atomic service API**: This API can be used in atomic services since API version 14.
65
66**System capability**: SystemCapability.Multimedia.Drm.Core
67
68| Name     | Type                          | Mandatory| Description        |
69| -------- | ----------------------------- |---- | ------------- |
70| name   | string | Yes | Name of the statistical item.     |
71| value     | string                 | Yes | Value of the statistical item.      |
72
73## MediaKeyStatus
74
75Describes the media key status.
76
77**Atomic service API**: This API can be used in atomic services since API version 12.
78
79**System capability**: SystemCapability.Multimedia.Drm.Core
80
81| Name     | Type                          | Mandatory| Description        |
82| -------- | ----------------------------- |---- | ------------- |
83| name   | string | Yes | Name of the media key status (such as the media key expiration time and content protection level).     |
84| value     | string                 | Yes | Value of the media key status.      |
85
86## KeysInfo
87
88Describes the information about media keys.
89
90**Atomic service API**: This API can be used in atomic services since API version 12.
91
92**System capability**: SystemCapability.Multimedia.Drm.Core
93
94| Name     | Type                          | Mandatory| Description        |
95| -------- | ----------------------------- |---- | ------------- |
96| keyId   | Uint8Array | Yes | Media key ID.     |
97| value     | string                 | Yes | Media key status.      |
98
99## MediaKeySystemInfo
100
101Describes the DRM information, which is used to encrypt content.
102
103**Atomic service API**: This API can be used in atomic services since API version 12.
104
105**System capability**: SystemCapability.Multimedia.Drm.Core
106
107| Name     | Type                          | Mandatory| Description        |
108| -------- | ----------------------------- |---- | ------------- |
109| uuid   | string | Yes | UUID of the DRM content protection system.     |
110| pssh     | Uint8Array                 | Yes | Protection System Specific Header (PSSH) in the DRM information.      |
111
112## MediaKeySystemDescription<sup>12+</sup>
113
114Describes the plugin information.
115
116**Atomic service API**: This API can be used in atomic services since API version 14.
117
118**System capability**: SystemCapability.Multimedia.Drm.Core
119
120| Name     | Type                          | Mandatory| Description        |
121| -------- | ----------------------------- |---- | ------------- |
122| name   | string | Yes | Name of the plugin.     |
123| uuid   | string | Yes | UUID of the plugin.     |
124