1# IIntellVoiceEngineAdapter
2
3
4## 概述
5
6IntelligentVoiceEngine模块向上层服务提供了智能语音引擎适配器接口。
7
8上层服务开发人员可根据IntelligentVoiceEngine模块提供的向上智能语音引擎适配器接口实现设置回调、加载唤醒算法引擎、卸载唤醒算法引擎、设置唤醒算法参数、获取唤醒算法参数、启动唤醒算法引擎、停止唤醒算法引擎、读写数据等功能。
9
10**起始版本：** 4.0
11
12**相关模块：**[IntelligentVoiceEngine](_intelligent_voice_engine.md)
13
14
15## 汇总
16
17
18### Public 成员函数
19
20| 名称 | 描述 |
21| -------- | -------- |
22| [SetCallback](#setcallback) ([in] [IIntellVoiceEngineCallback](interface_i_intell_voice_engine_callback.md) engineCallback) | 上层服务设置回调接口。  |
23| [Attach](#attach) ([in] struct [IntellVoiceEngineAdapterInfo](_intell_voice_engine_adapter_info.md) info) | 加载唤醒算法引擎。  |
24| [Detach](#detach) () | 卸载唤醒算法引擎。  |
25| [SetParameter](#setparameter) ([in] String keyValueList) | 设置唤醒算法参数。  |
26| [GetParameter](#getparameter) ([in] String keyList, [out] String valueList) | 获取唤醒算法参数。  |
27| [Start](#start) ([in] struct [StartInfo](_start_info.md) info) | 启动唤醒算法引擎。  |
28| [Stop](#stop) () | 停止唤醒算法引擎。  |
29| [WriteAudio](#writeaudio) ([in] List< unsigned char > buffer) | 写语音数据。  |
30| [Read](#read) ([in] enum [ContentType](_intelligent_voice_engine.md#contenttype) type, [out] Ashmem buffer) | 读数据。  |
31
32
33## 成员函数说明
34
35
36### Attach()
37
38```
39IIntellVoiceEngineAdapter::Attach ([in] struct IntellVoiceEngineAdapterInfo info)
40```
41**描述**
42
43加载唤醒算法引擎。
44
45**起始版本：** 4.0
46
47**参数:**
48
49| 名称 | 描述 |
50| -------- | -------- |
51| info | 智能语音唤醒算法引擎适配器信息，具体参考[IntellVoiceEngineAdapterInfo](_intell_voice_engine_adapter_info.md)。 |
52
53**返回：**
54
55如果操作成功，则返回0。
56
57如果操作失败，则返回负值。
58
59
60### Detach()
61
62```
63IIntellVoiceEngineAdapter::Detach ()
64```
65**描述**
66
67卸载唤醒算法引擎。
68
69**起始版本：** 4.0
70
71**返回：**
72
73如果操作成功，则返回0。
74
75如果操作失败，则返回负值。
76
77
78### GetParameter()
79
80```
81IIntellVoiceEngineAdapter::GetParameter ([in] String keyList, [out] String valueList )
82```
83**描述**
84
85获取唤醒算法参数。
86
87**起始版本：** 4.0
88
89**参数:**
90
91| 名称 | 描述 |
92| -------- | -------- |
93| keyList | 键列表，多个键之间通过分号分割，key和value的具体值由开发者自定义。  |
94| valueList | 返回值列表，多个返回值之间通过分号分割。 |
95
96**返回：**
97
98如果操作成功，则返回0。
99
100如果操作失败，则返回负值。
101
102
103### Read()
104
105```
106IIntellVoiceEngineAdapter::Read ([in] enum ContentType type, [out] Ashmem buffer )
107```
108**描述**
109
110读数据。
111
112**起始版本：** 4.0
113
114**参数:**
115
116| 名称 | 描述 |
117| -------- | -------- |
118| type | 数据类型，具体参考[ContentType](_intelligent_voice_engine.md#contenttype)。  |
119| buffer | 数据内容。 |
120
121**返回：**
122
123如果操作成功，则返回0。
124
125如果操作失败，则返回负值。
126
127
128### SetCallback()
129
130```
131IIntellVoiceEngineAdapter::SetCallback ([in] IIntellVoiceEngineCallback engineCallback)
132```
133**描述**
134
135上层服务设置回调接口。
136
137**起始版本：** 4.0
138
139**参数:**
140
141| 名称 | 描述 |
142| -------- | -------- |
143| engineCallback | 回调接口，具体参考[IIntellVoiceEngineCallback](interface_i_intell_voice_engine_callback.md)。 |
144
145**返回：**
146
147如果操作成功，则返回0。
148
149如果操作失败，则返回负值。
150
151
152### SetParameter()
153
154```
155IIntellVoiceEngineAdapter::SetParameter ([in] String keyValueList)
156```
157**描述**
158
159设置唤醒算法参数。
160
161**起始版本：** 4.0
162
163**参数:**
164
165| 名称 | 描述 |
166| -------- | -------- |
167| keyValueList | 键值对列表，键值对的格式为"key=value"，多个键值对之间通过分号分割，key和value的具体值由开发者自定义。 |
168
169**返回：**
170
171如果操作成功，则返回0。
172
173如果操作失败，则返回负值。
174
175
176### Start()
177
178```
179IIntellVoiceEngineAdapter::Start ([in] struct StartInfo info)
180```
181**描述**
182
183启动唤醒算法引擎。
184
185**起始版本：** 4.0
186
187**参数:**
188
189| 名称 | 描述 |
190| -------- | -------- |
191| info | 启动信息，具体参考[StartInfo](_start_info.md)。 |
192
193**返回：**
194
195如果操作成功，则返回0。
196
197如果操作失败，则返回负值。
198
199
200### Stop()
201
202```
203IIntellVoiceEngineAdapter::Stop ()
204```
205**描述**
206
207停止唤醒算法引擎。
208
209**起始版本：** 4.0
210
211**返回：**
212
213如果操作成功，则返回0。
214
215如果操作失败，则返回负值。
216
217
218### WriteAudio()
219
220```
221IIntellVoiceEngineAdapter::WriteAudio ([in] List< unsigned char > buffer)
222```
223**描述**
224
225写语音数据。
226
227**起始版本：** 4.0
228
229**参数:**
230
231| 名称 | 描述 |
232| -------- | -------- |
233| buffer | 语音数据，语音数据大小由开发者指定，默认是20ms语音数据。 |
234
235**返回：**
236
237如果操作成功，则返回0。
238
239如果操作失败，则返回负值。
240