1# IntelligentVoiceEngine
2
3
4## 概述
5
6IntelligentVoiceEngine模块向上层服务提供了统一接口。
7
8上层服务开发人员可根据IntelligentVoiceEngine模块提供的向上统一接口获取如下能力：创建销毁唤醒算法引擎、启动停止唤醒算法引擎、写语音数据、读文件、回调函数注册等。
9
10**起始版本：** 4.0
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [IIntellVoiceEngineAdapter.idl](_i_intell_voice_engine_adapter_8idl.md) | IntelligentVoiceEngine模块智能语音引擎适配器接口，包括设置回调、加载唤醒算法引擎、卸载唤醒算法引擎、设置唤醒算法参数、获取唤醒算法参数、启动唤醒算法引擎、停止唤醒算法引擎、读写数据等。 |
21| [IIntellVoiceEngineCallback.idl](_i_intell_voice_engine_callback_8idl.md) | IntelligentVoiceEngine模块智能语音引擎回调接口，用于通知上层服务事件信息。 |
22| [IIntellVoiceEngineManager.idl](_i_intell_voice_engine_manager_8idl.md) | IntelligentVoiceEngine模块引擎管理接口，包括获取引擎适配器描述符、创建引擎适配器、释放引擎适配器等。 |
23| [IntellVoiceEngineTypes.idl](_intell_voice_engine_types_8idl.md) | IntelligentVoiceEngine模块接口定义中使用的数据类型，包括引擎适配器类型、数据类型、回调消息类型、回调消息错误码、引擎适配器描述、回调事件信息等。 |
24
25
26### 类
27
28| 名称 | 描述 |
29| -------- | -------- |
30| interface  [IIntellVoiceEngineAdapter](interface_i_intell_voice_engine_adapter.md) | IntelligentVoiceEngine模块向上层服务提供了智能语音引擎适配器接口。 |
31| interface  [IIntellVoiceEngineCallback](interface_i_intell_voice_engine_callback.md) | IntelligentVoiceEngine模块向上层服务提供了智能语音引擎回调接口。 |
32| interface  [IIntellVoiceEngineManager](interface_i_intell_voice_engine_manager.md) | IntelligentVoiceEngine模块向上层服务提供了智能语音引擎管理接口。 |
33| struct  [IntellVoiceEngineAdapterDescriptor](_intell_voice_engine_adapter_descriptor.md) | 智能语音引擎适配器描述符。 |
34| struct  [IntellVoiceEngineAdapterInfo](_intell_voice_engine_adapter_info.md) | 智能语音引擎适配器信息。 |
35| struct  [StartInfo](_start_info.md) | 智能语音引擎启动信息。 |
36| struct  [IntellVoiceEngineCallBackEvent](_intell_voice_engine_call_back_event.md) | 智能语音引擎回调事件信息。 |
37
38
39### 枚举
40
41| 名称 | 描述 |
42| -------- | -------- |
43| [IntellVoiceEngineAdapterType](#intellvoiceengineadaptertype) { ENROLL_ADAPTER_TYPE = 0 , WAKEUP_ADAPTER_TYPE = 1 , UPDATE_ADAPTER_TYPE = 2 , ADAPTER_TYPE_BUT } | 智能语音引擎适配器类型。 |
44| [ContentType](#contenttype) { DSP_MODLE = 0 , CONTENT_TYPE_BUT } | 数据类型。 |
45| [IntellVoiceEngineMessageType](#intellvoiceenginemessagetype) {<br/>INTELL_VOICE_ENGINE_MSG_NONE = 0 , INTELL_VOICE_ENGINE_MSG_INIT_DONE = 1 , INTELL_VOICE_ENGINE_MSG_ENROLL_COMPLETE = 2 , INTELL_VOICE_ENGINE_MSG_COMMIT_ENROLL_COMPLETE = 3 , INTELL_VOICE_ENGINE_MSG_RECOGNIZE_COMPLETE = 4<br/>} | 回调消息类型。 |
46| [IntellVoiceEngineErrors](#intellvoiceengineerrors) {<br/>INTELL_VOICE_ENGINE_OK = 0 , INTELL_VOICE_ENGINE_ERROR_OFFSET = -100 , INTELL_VOICE_ENGINE_INVALID_PARAMS = -101 , INTELL_VOICE_ENGINE_INIT_FAILED = -102 , INTELL_VOICE_ENGINE_ENROLL_FAILED = -103 , INTELL_VOICE_ENGINE_COMMIT_ENROLL_FAILED = -104 , INTELL_VOICE_ENGINE_WAKEUP_FAILED = -105<br/>} | 回调消息错误码。 |
47
48
49## 枚举类型说明
50
51
52### ContentType
53
54```
55enum ContentType
56```
57
58**描述**
59
60
61数据类型。
62
63上层服务读取的数据类型。
64
65**起始版本：** 4.0
66
67| 枚举值 | 描述 |
68| -------- | -------- |
69| DSP_MODLE | DSP模型文件 |
70| CONTENT_TYPE_BUT | 无效数据类型 |
71
72
73### IntellVoiceEngineAdapterType
74
75```
76enum IntellVoiceEngineAdapterType
77```
78
79**描述**
80
81
82智能语音引擎适配器类型。
83
84**起始版本：** 4.0
85
86| 枚举值 | 描述 |
87| -------- | -------- |
88| ENROLL_ADAPTER_TYPE | 注册引擎适配器 |
89| WAKEUP_ADAPTER_TYPE | 唤醒引擎适配器 |
90| UPDATE_ADAPTER_TYPE | 静默升级引擎适配器 |
91| ADAPTER_TYPE_BUT | 无效引擎适配器 |
92
93
94### IntellVoiceEngineErrors
95
96```
97enum IntellVoiceEngineErrors
98```
99
100**描述**
101
102
103回调消息错误码。
104
105通知上层服务的消息错误码。
106
107**起始版本：** 4.0
108
109| 枚举值 | 描述 |
110| -------- | -------- |
111| INTELL_VOICE_ENGINE_OK | 成功 |
112| INTELL_VOICE_ENGINE_ERROR_OFFSET | 错误码偏移 |
113| INTELL_VOICE_ENGINE_INVALID_PARAMS | 无效参数 |
114| INTELL_VOICE_ENGINE_INIT_FAILED | 初始化失败 |
115| INTELL_VOICE_ENGINE_ENROLL_FAILED | 注册失败 |
116| INTELL_VOICE_ENGINE_COMMIT_ENROLL_FAILED | 确认注册失败 |
117| INTELL_VOICE_ENGINE_WAKEUP_FAILED | 唤醒失败 |
118
119
120### IntellVoiceEngineMessageType
121
122```
123enum IntellVoiceEngineMessageType
124```
125
126**描述**
127
128
129回调消息类型。
130
131通知上层服务的消息类型。
132
133**起始版本：** 4.0
134
135| 枚举值 | 描述 |
136| -------- | -------- |
137| INTELL_VOICE_ENGINE_MSG_NONE | 无效消息类型 |
138| INTELL_VOICE_ENGINE_MSG_INIT_DONE | 初始化完成消息 |
139| INTELL_VOICE_ENGINE_MSG_ENROLL_COMPLETE | 注册完成消息 |
140| INTELL_VOICE_ENGINE_MSG_COMMIT_ENROLL_COMPLETE | 确认注册完成消息 |
141| INTELL_VOICE_ENGINE_MSG_RECOGNIZE_COMPLETE | 唤醒识别消息 |
142