1# IMetadata
2
3
4## 概述
5
6定义显示数据映射接口。
7
8**起始版本：** 4.1
9
10**相关模块：**[Display](_display_v11.md)
11
12
13## 汇总
14
15
16### Public 成员函数
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [RegisterBuffer](#registerbuffer) ([in] NativeBuffer handle) | IPC后的初始化NativeBuffer |
21| [SetMetadata](#setmetadata) ([in] NativeBuffer handle, [in] unsigned int key, [in] unsigned char[] value) | 通过键值对的方式设置随帧数据 |
22| [GetMetadata](#getmetadata) ([in] NativeBuffer handle, [in] unsigned int key, [out] unsigned char[] value) | 通过键值对的方式设置随帧数据 |
23| [ListMetadataKeys](#listmetadatakeys) ([in] NativeBuffer handle, [out] unsigned int[] keys) | 列出bufferhandle中设置的所有key值 |
24| [EraseMetadataKey](#erasemetadatakey) ([in] NativeBuffer handle, [in] unsigned int key) | 按键值内存删除数据 |
25
26
27## 成员函数说明
28
29
30### EraseMetadataKey()
31
32```
33IMetadata::EraseMetadataKey ([in] NativeBuffer handle, [in] unsigned int key )
34```
35
36**描述**
37
38
39按键值内存删除数据
40
41**起始版本：** 4.1
42
43**参数:**
44
45| 名称 | 描述 |
46| -------- | -------- |
47| handle | 待无效cache的handle指针。 |
48| key | 要擦除的元数据密钥 |
49
50**返回：**
51
52返回0 表示执行成功。
53
54返回其他值表示执行失败，具体错误码查看[DispErrCode](_display_v10.md#disperrcode)。
55
56
57### GetMetadata()
58
59```
60IMetadata::GetMetadata ([in] NativeBuffer handle, [in] unsigned int key, [out] unsigned char[] value )
61```
62
63**描述**
64
65
66通过键值对的方式设置随帧数据
67
68**起始版本：** 4.1
69
70**参数:**
71
72| 名称 | 描述 |
73| -------- | -------- |
74| handle | 待无效cache的handle指针。 |
75| key | metadata key |
76| value | metadata value |
77
78**返回：**
79
80返回0 表示执行成功。
81
82返回其他值表示执行失败，具体错误码查看[DispErrCode](_display_v10.md#disperrcode)。
83
84
85### ListMetadataKeys()
86
87```
88IMetadata::ListMetadataKeys ([in] NativeBuffer handle, [out] unsigned int[] keys )
89```
90
91**描述**
92
93
94列出bufferhandle中设置的所有key值
95
96**起始版本：** 4.1
97
98**参数:**
99
100| 名称 | 描述 |
101| -------- | -------- |
102| handle | 待无效cache的handle指针。 |
103| keys | 数据键 |
104
105**返回：**
106
107返回0 表示执行成功。
108
109返回其他值表示执行失败，具体错误码查看[DispErrCode](_display_v10.md#disperrcode)。
110
111
112### RegisterBuffer()
113
114```
115IMetadata::RegisterBuffer ([in] NativeBuffer handle)
116```
117
118**描述**
119
120
121IPC后的初始化NativeBuffer
122
123**起始版本：** 4.1
124
125**参数:**
126
127| 名称 | 描述 |
128| -------- | -------- |
129| handle | 待无效cache的handle指针。 |
130
131**返回：**
132
133返回0 表示执行成功。
134
135返回其他值表示执行失败，具体错误码查看[DispErrCode](_display_v10.md#disperrcode)。
136
137
138### SetMetadata()
139
140```
141IMetadata::SetMetadata ([in] NativeBuffer handle, [in] unsigned int key, [in] unsigned char[] value )
142```
143
144**描述**
145
146
147通过键值对的方式设置随帧数据
148
149**起始版本：** 4.1
150
151**参数:**
152
153| 名称 | 描述 |
154| -------- | -------- |
155| handle | 待无效cache的handle指针。 |
156| key | 数据键 |
157| value | 数据值 |
158
159**返回：**
160
161返回0 表示执行成功。
162
163返回其他值表示执行失败，具体错误码查看[DispErrCode](_display_v10.md#disperrcode)。
164