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**起始版本：** 4.0 45 46**参数:** 47 48| 名称 | 描述 | 49| -------- | -------- | 50| info | 智能语音唤醒算法引擎适配器信息，具体参考[IntellVoiceEngineAdapterInfo](_intell_voice_engine_adapter_info.md)。 | 51 52**返回：** 53 54如果操作成功，则返回0。 55 56如果操作失败，则返回负值。 57 58 59### Detach() 60 61``` 62IIntellVoiceEngineAdapter::Detach () 63``` 64**描述** 65卸载唤醒算法引擎。 66 67**起始版本：** 4.0 68 69**返回：** 70 71如果操作成功，则返回0。 72 73如果操作失败，则返回负值。 74 75 76### GetParameter() 77 78``` 79IIntellVoiceEngineAdapter::GetParameter ([in] String keyList, [out] String valueList ) 80``` 81**描述** 82获取唤醒算法参数。 83 84**起始版本：** 4.0 85 86**参数:** 87 88| 名称 | 描述 | 89| -------- | -------- | 90| keyList | 键列表，多个键之间通过分号分割，key和value的具体值由开发者自定义。 | 91| valueList | 返回值列表，多个返回值之间通过分号分割。 | 92 93**返回：** 94 95如果操作成功，则返回0。 96 97如果操作失败，则返回负值。 98 99 100### Read() 101 102``` 103IIntellVoiceEngineAdapter::Read ([in] enum ContentType type, [out] Ashmem buffer ) 104``` 105**描述** 106读数据。 107 108**起始版本：** 4.0 109 110**参数:** 111 112| 名称 | 描述 | 113| -------- | -------- | 114| type | 数据类型，具体参考[ContentType](_intelligent_voice_engine.md#contenttype)。 | 115| buffer | 数据内容。 | 116 117**返回：** 118 119如果操作成功，则返回0。 120 121如果操作失败，则返回负值。 122 123 124### SetCallback() 125 126``` 127IIntellVoiceEngineAdapter::SetCallback ([in] IIntellVoiceEngineCallback engineCallback) 128``` 129**描述** 130上层服务设置回调接口。 131 132**起始版本：** 4.0 133 134**参数:** 135 136| 名称 | 描述 | 137| -------- | -------- | 138| engineCallback | 回调接口，具体参考[IIntellVoiceEngineCallback](interface_i_intell_voice_engine_callback.md)。 | 139 140**返回：** 141 142如果操作成功，则返回0。 143 144如果操作失败，则返回负值。 145 146 147### SetParameter() 148 149``` 150IIntellVoiceEngineAdapter::SetParameter ([in] String keyValueList) 151``` 152**描述** 153设置唤醒算法参数。 154 155**起始版本：** 4.0 156 157**参数:** 158 159| 名称 | 描述 | 160| -------- | -------- | 161| keyValueList | 键值对列表，键值对的格式为"key=value"，多个键值对之间通过分号分割，key和value的具体值由开发者自定义。 | 162 163**返回：** 164 165如果操作成功，则返回0。 166 167如果操作失败，则返回负值。 168 169 170### Start() 171 172``` 173IIntellVoiceEngineAdapter::Start ([in] struct StartInfo info) 174``` 175**描述** 176启动唤醒算法引擎。 177 178**起始版本：** 4.0 179 180**参数:** 181 182| 名称 | 描述 | 183| -------- | -------- | 184| info | 启动信息，具体参考[StartInfo](_start_info.md)。 | 185 186**返回：** 187 188如果操作成功，则返回0。 189 190如果操作失败，则返回负值。 191 192 193### Stop() 194 195``` 196IIntellVoiceEngineAdapter::Stop () 197``` 198**描述** 199停止唤醒算法引擎。 200 201**起始版本：** 4.0 202 203**返回：** 204 205如果操作成功，则返回0。 206 207如果操作失败，则返回负值。 208 209 210### WriteAudio() 211 212``` 213IIntellVoiceEngineAdapter::WriteAudio ([in] List< unsigned char > buffer) 214``` 215**描述** 216写语音数据。 217 218**起始版本：** 4.0 219 220**参数:** 221 222| 名称 | 描述 | 223| -------- | -------- | 224| buffer | 语音数据，语音数据大小由开发者指定，默认是20ms语音数据。 | 225 226**返回：** 227 228如果操作成功，则返回0。 229 230如果操作失败，则返回负值。 231