Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 ef3ebac0 编写于 作者: L lvqiang214
浏览文件
操作

reviews fix 

Signed-off-by: Nlvqiang214 <lvqiang1@huawei.com>
上级 143a745b
显示空白变更内容
内联 并排
Showing with 285 addition and 256 deletion
zh-cn/application-dev/reference/apis/js-apis-intelligentVoice.md
浏览文件 @ ef3ebac0
...@@ -39,12 +39,11 @@ getIntelligentVoiceManager(): IntelligentVoiceManager ...@@ -39,12 +39,11 @@ getIntelligentVoiceManager(): IntelligentVoiceManager
**示例：** **示例：**
```js ```js
var intelligentvoiceManager = intelligentVoice.getIntelligentVoiceManager(); var intelligentVoiceManager = nullptr;
if (intelligentvoiceManager == null) { try {
console.error("Get IntelligentVoiceManager failed."); intelligentVoiceManager = intelligentVoice.getIntelligentVoiceManager();
} else { } catch (error) {
console.info("Get IntelligentVoiceManager success."); console.error("Get IntelligentVoiceManager failed. Error: ${err}");
return;
} }
``` ```
...@@ -62,8 +61,8 @@ createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescr ...@@ -62,8 +61,8 @@ createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescr
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ---------------------- | | -------- | ----------------------------------- | ---- | ---------------------- |
| descriptor | [EnrollIntelligentVoiceEngineDescriptor](#enrollintelligentvoiceenginedescriptor) | 是 | 表示智能语音注册引擎描述符。 | | descriptor | [EnrollIntelligentVoiceEngineDescriptor](#enrollintelligentvoiceenginedescriptor) | 是 | 智能语音注册引擎描述符。 |
| callback | AsyncCallback\<[EnrollIntelligentVoiceEngine](#enrollintelligentvoiceengine)\> | 是 | 智能语音注册引擎结果回调。 | | callback | AsyncCallback\<[EnrollIntelligentVoiceEngine](#enrollintelligentvoiceengine)\> | 是 | 返回注册智能语音引擎。 |
**错误码：** **错误码：**
...@@ -72,20 +71,21 @@ createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescr ...@@ -72,20 +71,21 @@ createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescr
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700101 | No memory. | | 22700101 | No memory. |
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
let engineDescriptor = { let engineDescriptor = {
wakeupPhrase: '', wakeupPhrase: '小艺小艺',
} }
intelligentVoice.createEnrollIntelligentVoiceEngine(engineDescriptor,(err, data) => { var enrollIntelligentVoiceEngine = nullptr;
intelligentVoice.createEnrollIntelligentVoiceEngine(engineDescriptor, (err, data) => {
if (err) { if (err) {
console.error(`EnrollIntelligentVoice Created: Error: ${err}`); console.error(`EnrollIntelligentVoice Created: Error: ${err}`);
} else { } else {
console.info('EnrollIntelligentVoice Created: Success: SUCCESS'); console.info('EnrollIntelligentVoice Created: Success: SUCCESS');
let engine = data; enrollIntelligentVoiceEngine = data;
} }
}); });
``` ```
...@@ -105,13 +105,13 @@ createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescr ...@@ -105,13 +105,13 @@ createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescr
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ---------------------- | | -------- | ----------------------------------- | ---- | ---------------------- |
| descriptor | [EnrollIntelligentVoiceEngineDescriptor](#enrollintelligentvoiceenginedescriptor) | 是 | 表示智能语音注册引擎描述符。 | | descriptor | [EnrollIntelligentVoiceEngineDescriptor](#enrollintelligentvoiceenginedescriptor) | 是 | 智能语音注册引擎描述符。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Promise\<[EnrollIntelligentVoiceEngine](#enrollintelligentvoiceengine)\> | 智能语音注册引擎。 | | Promise\<[EnrollIntelligentVoiceEngine](#enrollintelligentvoiceengine)\> | 返回注册智能语音引擎。 |
**错误码：** **错误码：**
...@@ -120,25 +120,21 @@ createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescr ...@@ -120,25 +120,21 @@ createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescr
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700101 | No memory. | | 22700101 | No memory. |
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
var engine = null; var enrollIntelligentVoiceEngine = null;
let engineDescriptor = { let engineDescriptor = {
wakeupPhrase: '', wakeupPhrase: '小艺小艺',
} }
intelligentVoice.createEnrollIntelligentVoiceEngine(engineDescriptor).then((data) => { intelligentVoice.createEnrollIntelligentVoiceEngine(engineDescriptor).then((data) => {
engine = data; enrollIntelligentVoiceEngine = data;
console.info('Create EnrollIntelligentVoice Engine finish'); console.info('Create EnrollIntelligentVoice Engine finish');
}).catch((err) => { }).catch((err) => {
console.error('Create EnrollIntelligentVoice Engine failed, err: ' + err.message); console.error('Create EnrollIntelligentVoice Engine failed, err: ' + err.message);
}); });
if (engine == null) {
console.error('Create EnrollIntelligentVoice Engine failed');
return;
}
``` ```
## intelligentVoice.createWakeupIntelligentVoiceEngine ## intelligentVoice.createWakeupIntelligentVoiceEngine
...@@ -156,8 +152,8 @@ createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescr ...@@ -156,8 +152,8 @@ createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescr
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ---------------------- | | -------- | ----------------------------------- | ---- | ---------------------- |
| descriptor | [WakeupIntelligentVoiceEngineDescriptor](#wakeupintelligentvoiceenginedescriptor) | 是 | 表示智能语音唤醒引擎描述符。 | | descriptor | [WakeupIntelligentVoiceEngineDescriptor](#wakeupintelligentvoiceenginedescriptor) | 是 | 唤醒智能语音引擎描述符。 |
| callback | AsyncCallback\<[WakeupIntelligentVoiceEngine](#wakeupintelligentvoiceengine)\> | 是 | 智能语音唤醒引擎结果回调。 | | callback | AsyncCallback\<[WakeupIntelligentVoiceEngine](#wakeupintelligentvoiceengine)\> | 是 | 返回唤醒智能语音引擎。 |
**错误码：** **错误码：**
...@@ -166,21 +162,22 @@ createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescr ...@@ -166,21 +162,22 @@ createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescr
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700101 | No memory. | | 22700101 | No memory. |
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
let engineDescriptor = { let engineDescriptor = {
needApAlgEngine: true, needApAlgEngine: true,
wakeupPhrase: '', wakeupPhrase: '小艺小艺',
} }
intelligentVoice.createWakeupIntelligentVoiceEngine(engineDescriptor,(err, data) => { var wkeupIntelligentVoiceEngine = nullptr;
intelligentVoice.createWakeupIntelligentVoiceEngine(engineDescriptor, (err, data) => {
if (err) { if (err) {
console.error(`WakeupIntelligentVoice Created: Error: ${err}`); console.error(`WakeupIntelligentVoice Created: Error: ${err}`);
} else { } else {
console.info('WakeupIntelligentVoice Created: Success: SUCCESS'); console.info('WakeupIntelligentVoice Created: Success: SUCCESS');
let engine = data; wkeupIntelligentVoiceEngine = data;
} }
}); });
``` ```
...@@ -199,13 +196,13 @@ createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescr ...@@ -199,13 +196,13 @@ createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescr
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ---------------------- | | -------- | ----------------------------------- | ---- | ---------------------- |
| descriptor | [WakeupIntelligentVoiceEngineDescriptor](#wakeupintelligentvoiceenginedescriptor) | 是 | 表示智能语音唤醒引擎描述符。 | | descriptor | [WakeupIntelligentVoiceEngineDescriptor](#wakeupintelligentvoiceenginedescriptor) | 是 | 唤醒智能语音引擎描述符。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Promise\<[WakeupIntelligentVoiceEngine](#wakeupintelligentvoiceengine)> | 智能语音唤醒引擎。 | | Promise\<[WakeupIntelligentVoiceEngine](#wakeupintelligentvoiceengine)> | 返回唤醒智能语音引擎。 |
**错误码：** **错误码：**
...@@ -214,37 +211,33 @@ createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescr ...@@ -214,37 +211,33 @@ createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescr
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700101 | No memory. | | 22700101 | No memory. |
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
var engine = null;
let engineDescriptor = { let engineDescriptor = {
needApAlgEngine: true, needReconfirm: true,
wakeupPhrase: '', wakeupPhrase: '小艺小艺',
} }
var wkeupIntelligentVoiceEngine = nullptr;
intelligentVoice.createWakeupIntelligentVoiceEngine(engineDescriptor).then((data) => { intelligentVoice.createWakeupIntelligentVoiceEngine(engineDescriptor).then((data) => {
engine = data; wkeupIntelligentVoiceEngine = data;
console.info('Create WakeupIntelligentVoice Engine finish'); console.info('Create WakeupIntelligentVoice Engine finish');
}).catch((err) => { }).catch((err) => {
console.error('Create WakeupIntelligentVoice Engine failed, err: ' + err.message); console.error('Create WakeupIntelligentVoice Engine failed, err: ' + err.message);
}); });
if (engine == null) {
console.error('Create WakeupIntelligentVoice Engine failed');
return;
}
``` ```
## IntelligentVoiceManager ## IntelligentVoiceManager
智能语音管理器类，使用前需要通过getIntelligentVoiceManager获取智能语音管理实例。 智能语音管理类，使用前需要通过[getIntelligentVoiceManager()](#intelligentvoicegetintelligentvoicemanager)获取智能语音管理实例。
### getCapabilityInfo ### getCapabilityInfo
getCapabilityInfo(): Array&lt;IntelligentVoiceEngineType&gt; getCapabilityInfo(): Array&lt;IntelligentVoiceEngineType&gt;
获取能力信息。 获取支持的智能语音引擎列表信息。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -259,7 +252,7 @@ getCapabilityInfo(): Array&lt;IntelligentVoiceEngineType&gt; ...@@ -259,7 +252,7 @@ getCapabilityInfo(): Array&lt;IntelligentVoiceEngineType&gt;
**示例：** **示例：**
```js ```js
let info = intelligentvoiceManager.getCapabilityInfo(); let info = intelligentVoiceManager.getCapabilityInfo();
``` ```
### on('serviceChange') ### on('serviceChange')
...@@ -277,17 +270,17 @@ on(type: 'serviceChange', callback: Callback&lt;ServiceChangeType&gt;): void ...@@ -277,17 +270,17 @@ on(type: 'serviceChange', callback: Callback&lt;ServiceChangeType&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| type | string | 是 | 系统服务变更事件，固定取值为'serviceChange'，表示服务变更事件。 | | type | string | 是 | 系统服务变更事件，固定取值为'serviceChange'，表示服务变更事件。 |
| callback | Callback\<[ServiceChangeType](#servicechangetype)\> | 是 | 事件触发时调用回调。| | callback | Callback\<[ServiceChangeType](#servicechangetype)\> | 是 | 事件触发时回调接口。|
**示例：** **示例：**
```js ```js
intelligentvoiceManager.on('serviceChange', (serviceChangeType) => {}); intelligentVoiceManager.on('serviceChange', (serviceChangeType) => {});
``` ```
### off('serviceChange') ### off('serviceChange')
off(type: 'serviceChange'): void off(type: 'serviceChange', callback?: Callback\<ServiceChangeType\>): void
取消订阅服务变更事件。 取消订阅服务变更事件。
...@@ -300,34 +293,35 @@ off(type: 'serviceChange'): void ...@@ -300,34 +293,35 @@ off(type: 'serviceChange'): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| type | string | 是 | 系统服务变更事件，固定取值为'serviceChange'。 | | type | string | 是 | 系统服务变更事件，固定取值为'serviceChange'。 |
| callback | Callback\<[ServiceChangeType](#servicechangetype)\> | 否 | 事件触发时调用回调接口。|
**示例：** **示例：**
```js ```js
intelligentvoiceManager.off('serviceChange'); intelligentVoiceManager.off('serviceChange');
``` ```
## ServiceChangeType ## ServiceChangeType
枚举,服务变更类型。 枚举，服务状态变更类型。
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------------------- | ---- | ------------ | | ------------------------- | ---- | ------------ |
| SERVICE_UNAVAILABLE | 0 | 服务不可用。 | | SERVICE_UNAVAILABLE | 0 | 服务状态不可用。 |
## IntelligentVoiceEngineType ## IntelligentVoiceEngineType
枚举,智能语音引擎类型。 枚举，智能语音引擎类型。
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------------------- | ---- | ------------ | | ------------------------- | ---- | ------------ |
| ENROLL_ENGINE_TYPE | 0 | 注册引擎。 | | ENROLL_ENGINE_TYPE | 0 | 语音注册引擎。 |
| WAKEUP_ENGINE_TYPE | 1 | 唤醒引擎。 | | WAKEUP_ENGINE_TYPE | 1 | 语音唤醒引擎。 |
| UPDATE_ENGINE_TYPE | 2 | 更新引擎。 | | UPDATE_ENGINE_TYPE | 2 | 静默升级引擎。 |
## EnrollIntelligentVoiceEngineDescriptor ## EnrollIntelligentVoiceEngineDescriptor
...@@ -347,7 +341,7 @@ intelligentvoiceManager.off('serviceChange'); ...@@ -347,7 +341,7 @@ intelligentvoiceManager.off('serviceChange');
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | -------------- | ---------- | | ------ | ----------------------------- | -------------- | ---------- |
| needApAlgEngine | boolean | 是 | 需要ap算法引擎。 | | needReconfirm | boolean | 是 | 需要再次确认唤醒结果，true为需求，false为不需要。 |
| wakeupPhrase | string | 是 | 唤醒词。 | | wakeupPhrase | string | 是 | 唤醒词。 |
## EnrollEngineConfig ## EnrollEngineConfig
...@@ -363,7 +357,7 @@ intelligentvoiceManager.off('serviceChange'); ...@@ -363,7 +357,7 @@ intelligentvoiceManager.off('serviceChange');
## SensibilityType ## SensibilityType
枚举，敏感类型。 枚举，唤醒灵敏度类型。
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
...@@ -384,19 +378,6 @@ intelligentvoiceManager.off('serviceChange'); ...@@ -384,19 +378,6 @@ intelligentvoiceManager.off('serviceChange');
| bundleName | string | 是 | 唤醒应用bundlename。 | | bundleName | string | 是 | 唤醒应用bundlename。 |
| abilityName | string | 是 | 唤醒应用ailityname。 | | abilityName | string | 是 | 唤醒应用ailityname。 |
## EnrollIntelligentVoiceEventType
枚举，注册智能语音事件类型。
**系统能力：** SystemCapability.AI.IntelligentVoice.Core
| 名称 | 值 | 说明 |
| ------------------------- | ---- | ------------ |
| INTELLIGENT_VOICE_EVENT_ENROLL_NONE | 0 | 无注册。 |
| INTELLIGENT_VOICE_EVENT_ENROLL_INIT_DONE | 1 | 初始化完成。 |
| INTELLIGENT_VOICE_EVENT_ENROLL_COMPLETE | 2 | 注册完成。 |
| INTELLIGENT_VOICE_EVENT_COMMIT_ENROLL_COMPLETE | 3 | 提交注册完成。 |
## WakeupIntelligentVoiceEventType ## WakeupIntelligentVoiceEventType
枚举，唤醒智能语音事件类型。 枚举，唤醒智能语音事件类型。
...@@ -416,24 +397,37 @@ intelligentvoiceManager.off('serviceChange'); ...@@ -416,24 +397,37 @@ intelligentvoiceManager.off('serviceChange');
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------------------- | ---- | ------------ | | ------------------------- | ---- | ------------ |
| INTELLIGENT_VOICE_SUCCESS | 0 | 成功。 |
| INTELLIGENT_VOICE_NO_MEMORY | 22700101 | 内存不足。 | | INTELLIGENT_VOICE_NO_MEMORY | 22700101 | 内存不足。 |
| INTELLIGENT_VOICE_INVALID_PARAM | 22700102 | 参数无效。 | | INTELLIGENT_VOICE_INVALID_PARAM | 22700102 | 参数无效。 |
| INTELLIGENT_VOICE_INIT_FAILED | 22700103 | 初始化失败。 | | INTELLIGENT_VOICE_INIT_FAILED | 22700103 | 注册失败。 |
| INTELLIGENT_VOICE_ENROLL_FAILED | 22700104 | 注册失败。 | | INTELLIGENT_VOICE_COMMIT_ENROLL_FAILED | 22700104 | 确认注册结果失败。 |
| INTELLIGENT_VOICE_COMMIT_ENROLL_FAILED | 22700105 | 提交注册失败。 |
| INTELLIGENT_VOICE_RECOGNIZE_FAILED | 22700106 | 识别失败。 |
## EnrollIntelligentVoiceEngineCallbackInfo ## EnrollResult
介绍注册智能语音引擎回调信息。 枚举，注册结果。
**系统能力：** SystemCapability.AI.IntelligentVoice.Core
| 名称 | 值 | 说明 |
| ------------------------- | ---- | ------------ |
| SUCCESS | 0 | 注册成功。 |
| VPR_TRAIN_FAILED | -1 | 声纹训练失败。 |
| WAKEUP_PHRASE_NOT_MATCH | -2 | 唤醒短语不匹配。 |
| TOO_NOISY | -3 | 周边环境太吵。 |
| TOO_LOUD | -4 | 声音太大。 |
| INTERVAL_LARGE | -5 | 唤醒词时间间隔太大。 |
| DIFFERENT_PERSON | -6 | 不同人注册唤醒词。 |
| UNKNOWN_ERROR | -100 | 未知错误。 |
## EnrollCallbackInfo
注册回调信息。
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | -------------- | ---------- | | ------ | ----------------------------- | -------------- | ---------- |
| eventId | [EnrollIntelligentVoiceEventType](#enrollintelligentvoiceeventtype) | 是 | 注册事件ID。 | | result | [EnrollResult](#enrollresult) | 是 | 错误码。 |
| errCode | [IntelligentVoiceErrorCode](#intelligentvoiceerrorcode) | 是 | 错误码。 |
| context | string | 是 | 描述注册事件上下文。 | | context | string | 是 | 描述注册事件上下文。 |
## WakeupIntelligentVoiceEngineCallbackInfo ## WakeupIntelligentVoiceEngineCallbackInfo
...@@ -445,12 +439,12 @@ intelligentvoiceManager.off('serviceChange'); ...@@ -445,12 +439,12 @@ intelligentvoiceManager.off('serviceChange');
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | -------------- | ---------- | | ------ | ----------------------------- | -------------- | ---------- |
| eventId | [WakeupIntelligentVoiceEventType](#wakeupintelligentvoiceeventtype) | 是 | 唤醒事件ID。 | | eventId | [WakeupIntelligentVoiceEventType](#wakeupintelligentvoiceeventtype) | 是 | 唤醒事件ID。 |
| errCode | [IntelligentVoiceErrorCode](#intelligentvoiceerrorcode) | 是 | 错误码。 | | isSuccess | boolean | 是 | 是否唤醒成功，false为唤醒失败，true为唤醒成功。 |
| context | string | 是 | 描述注册事件上下文。 | | context | string | 是 | 描述唤醒事件上下文。 |
## EnrollIntelligentVoiceEngine ## EnrollIntelligentVoiceEngine
实现注册智能语音引擎。 实现注册智能语音引擎，通过[createEnrollIntelligentVoiceEngine()](#intelligentvoicecreateenrollintelligentvoiceengine)获取注册智能语音引擎。
### getSupportedRegions ### getSupportedRegions
...@@ -466,17 +460,18 @@ getSupportedRegions(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void ...@@ -466,17 +460,18 @@ getSupportedRegions(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 支持区域的回调结果。 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 返回支持区域的数组。 |
**示例：** **示例：**
```js ```js
let regions = nullptr;
enrollIntelligentVoiceEngine.getSupportedRegions((err, data) => { enrollIntelligentVoiceEngine.getSupportedRegions((err, data) => {
if (err) { if (err) {
console.error(`Failed to getSupportedRegions, ${err}`); console.error(`Failed to getSupportedRegions, ${err}`);
} else { } else {
console.info('getSupportedRegions success.'); console.info('getSupportedRegions success.');
let regions = data; regions = data;
} }
}); });
``` ```
...@@ -495,12 +490,12 @@ getSupportedRegions(): Promise&lt;Array&lt;string&gt;&gt; ...@@ -495,12 +490,12 @@ getSupportedRegions(): Promise&lt;Array&lt;string&gt;&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 返回支持区域。 | | Promise&lt;Array&lt;string&gt;&gt; | 返回支持区域的数组。 |
**示例：** **示例：**
```js ```js
let regions; let regions = nullptr;
enrollIntelligentVoiceEngine.getSupportedRegions().then((data) => { enrollIntelligentVoiceEngine.getSupportedRegions().then((data) => {
regions = data; regions = data;
console.info('getSupportedRegions success'); console.info('getSupportedRegions success');
...@@ -511,7 +506,7 @@ enrollIntelligentVoiceEngine.getSupportedRegions().then((data) => { ...@@ -511,7 +506,7 @@ enrollIntelligentVoiceEngine.getSupportedRegions().then((data) => {
### init ### init
init(config: EnrollEngineConfig, callback: AsyncCallback&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt;): void init(config: EnrollEngineConfig, callback: AsyncCallback&lt;void&gt;): void
初始化引擎，使用callback异步回调。 初始化引擎，使用callback异步回调。
...@@ -523,8 +518,8 @@ init(config: EnrollEngineConfig, callback: AsyncCallback&lt;EnrollIntelligentVoi ...@@ -523,8 +518,8 @@ init(config: EnrollEngineConfig, callback: AsyncCallback&lt;EnrollIntelligentVoi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| config | [EnrollEngineConfig](#enrollengineconfig) | 是 | config表示注册引擎配置。 | | config | [EnrollEngineConfig](#enrollengineconfig) | 是 | 注册引擎配置。 |
| callback |AsyncCallback\<[EnrollIntelligentVoiceEngineCallbackInfo](#enrollintelligentvoiceenginecallbackinfo)\> | 是 | 初始化返回结果。 | | callback |AsyncCallback&lt;void&gt; | 是 | 返回初始化结果。 |
**错误码：** **错误码：**
...@@ -532,7 +527,8 @@ init(config: EnrollEngineConfig, callback: AsyncCallback&lt;EnrollIntelligentVoi ...@@ -532,7 +527,8 @@ init(config: EnrollEngineConfig, callback: AsyncCallback&lt;EnrollIntelligentVoi
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
| 22700103 | Init failed. |
**示例：** **示例：**
...@@ -541,19 +537,18 @@ let config = { ...@@ -541,19 +537,18 @@ let config = {
language: "zh", language: "zh",
area: "CN", area: "CN",
} }
enrollIntelligentVoiceEngine.init(config,(err, data) => { enrollIntelligentVoiceEngine.init(config, (err) => {
if (err) { if (err) {
console.error(`Init EnrollIntelligentVoice Engine finish, Error: ${err}`); console.error(`Init EnrollIntelligentVoice Engine finish, Error: ${err}`);
} else { } else {
console.info('Init EnrollIntelligentVoice Engine SUCCESS'); console.info('Init EnrollIntelligentVoice Engine SUCCESS');
let callbackInfo = data;
} }
}); });
``` ```
### init ### init
init(config: EnrollEngineConfig): Promise&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt; init(config: EnrollEngineConfig): Promise&lt;void&gt;
初始化引擎，使用Promise异步回调。 初始化引擎，使用Promise异步回调。
...@@ -571,7 +566,7 @@ init(config: EnrollEngineConfig): Promise&lt;EnrollIntelligentVoiceEngineCallbac ...@@ -571,7 +566,7 @@ init(config: EnrollEngineConfig): Promise&lt;EnrollIntelligentVoiceEngineCallbac
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Promise&lt;[EnrollIntelligentVoiceEngineCallbackInfo](#enrollintelligentvoiceenginecallbackinfo)&gt; | 初始化回调信息。 | | Promise&lt;void&gt; | 返回初始化结果。 |
**错误码：** **错误码：**
...@@ -579,7 +574,8 @@ init(config: EnrollEngineConfig): Promise&lt;EnrollIntelligentVoiceEngineCallbac ...@@ -579,7 +574,8 @@ init(config: EnrollEngineConfig): Promise&lt;EnrollIntelligentVoiceEngineCallbac
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
| 22700103 | Init failed. |
**示例：** **示例：**
...@@ -588,20 +584,18 @@ let config = { ...@@ -588,20 +584,18 @@ let config = {
language: "zh", language: "zh",
area: "CN", area: "CN",
} }
let callbackInfo; enrollIntelligentVoiceEngine.init(config).then(() => {
enrollIntelligentVoiceEngine.init(config).then((data) => {
callbackInfo = data;
console.info('Init EnrollIntelligentVoice Engine finish'); console.info('Init EnrollIntelligentVoice Engine finish');
}).catch((err) => { }).catch((err) => {
console.info('Init EnrollIntelligentVoice Engine failed, err: '+ err.message); console.info('Init EnrollIntelligentVoice Engine failed, err: '+ err.message);
}); });
``` ```
### start ### enrollForResult
start(isLast: boolean, callback: AsyncCallback&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt;): void enrollForResult(isLast: boolean, callback: AsyncCallback&lt;EnrollCallbackInfo&gt;): void
启动引擎，使用callback异步回调。 获取注册结果，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -611,28 +605,29 @@ start(isLast: boolean, callback: AsyncCallback&lt;EnrollIntelligentVoiceEngineCa ...@@ -611,28 +605,29 @@ start(isLast: boolean, callback: AsyncCallback&lt;EnrollIntelligentVoiceEngineCa
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| isLast | boolean | 是 | isLast表示是否为最后一次启动。 | | isLast | boolean | 是 | isLast表示是否为最后一次注册，false为非最后一次，true为最后一次。 |
| callback | AsyncCallback&lt;[EnrollIntelligentVoiceEngineCallbackInfo](#enrollintelligentvoiceenginecallbackinfo)&gt; | 是 | 启动结果返回。 | | callback | AsyncCallback&lt;[EnrollCallbackInfo](#enrollcallbackinfo)&gt; | 是 | 返回注册结果。 |
**示例：** **示例：**
```js ```js
let isLast = true; let isLast = true;
enrollIntelligentVoiceEngine.start(isLast,(err, data) => { let callbackInfo = nullptr;
enrollIntelligentVoiceEngine.enrollForResult(isLast, (err, data) => {
if (err) { if (err) {
console.error(`Start enrollment failed, error: ${err}`); console.error(`Start enrollment failed, error: ${err}`);
} else { } else {
console.info('Start enrollment finish'); console.info('Start enrollment finish');
let callbackInfo = data; callbackInfo = data;
} }
}); });
``` ```
### start ### enrollForResult
start(isLast: boolean): Promise&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt; enrollForResult(isLast: boolean): Promise&lt;EnrollCallbackInfo&gt;
启动引擎，使用Promise异步回调。 获取注册结果，使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -642,20 +637,20 @@ start(isLast: boolean): Promise&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt; ...@@ -642,20 +637,20 @@ start(isLast: boolean): Promise&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| isLast | boolean | 是 | isLast表示是否为最后一次启动。 | | isLast | boolean | 是 | isLast表示是否为最后一次注册，false为非最后一次，true为最后一次。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Promise&lt;[EnrollIntelligentVoiceEngineCallbackInfo](#enrollintelligentvoiceenginecallbackinfo)&gt; | 启动结果回调信息。 | | Promise&lt;[EnrollCallbackInfo](#enrollcallbackinfo)&gt; | 返回注册结果。 |
**示例：** **示例：**
```js ```js
let isLast = true; let isLast = true;
let callbackInfo; let callbackInfo = nullptr;
enrollIntelligentVoiceEngine.start(isLast).then((data) => { enrollIntelligentVoiceEngine.enrollForResult(isLast).then((data) => {
callbackInfo = data; callbackInfo = data;
console.info('Start enrollment finish'); console.info('Start enrollment finish');
}).catch((err) => { }).catch((err) => {
...@@ -675,7 +670,7 @@ stop(callback: AsyncCallback&lt;void&gt;): void ...@@ -675,7 +670,7 @@ stop(callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 停止结果返回。 | | callback | AsyncCallback&lt;void&gt; | 是 | 返回停止结果。 |
**示例：** **示例：**
...@@ -699,6 +694,12 @@ stop(): Promise&lt;void&gt; ...@@ -699,6 +694,12 @@ stop(): Promise&lt;void&gt;
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- |
| Promise&lt;void&gt; | 返回停止结果。 |
**示例：** **示例：**
```js ```js
...@@ -709,7 +710,7 @@ enrollIntelligentVoiceEngine.stop().then(() => { ...@@ -709,7 +710,7 @@ enrollIntelligentVoiceEngine.stop().then(() => {
### commit ### commit
commit(callback: AsyncCallback&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt;): void commit(callback: AsyncCallback&lt;void&gt;): void
提交注册，使用callback异步回调。 提交注册，使用callback异步回调。
...@@ -717,26 +718,35 @@ commit(callback: AsyncCallback&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt;): ...@@ -717,26 +718,35 @@ commit(callback: AsyncCallback&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt;):
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| callback | AsyncCallback&lt;[EnrollIntelligentVoiceEngineCallbackInfo](#enrollintelligentvoiceenginecallbackinfo)&gt; | 是 | 提交注册结果返回。 | | callback | AsyncCallback&lt;void&gt; | 是 | 返回确认注册结果。 |
**错误码：**
以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 22700104 | Commit enroll failed. |
**示例：** **示例：**
```js ```js
enrollIntelligentVoiceEngine.commit((err, data) => { enrollIntelligentVoiceEngine.commit((err) => {
if (err) { if (err) {
console.error(`Commit enroll result failed, err: ${err}`); console.error(`Commit enroll result failed, err: ${err}`);
} else { } else {
console.info('Commit enroll result finish'); console.info('Commit enroll result finish');
let callbackInfo = data;
} }
}); });
``` ```
### commit ### commit
commit(): Promise&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt; commit(): Promise&lt;void&gt;
提交注册，使用Promise异步回调。 提交注册，使用Promise异步回调。
...@@ -748,14 +758,20 @@ commit(): Promise&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt; ...@@ -748,14 +758,20 @@ commit(): Promise&lt;EnrollIntelligentVoiceEngineCallbackInfo&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Promise&lt;[EnrollIntelligentVoiceEngineCallbackInfo](#enrollintelligentvoiceenginecallbackinfo)&gt; | 提交注册回调信息。 | | Promise&lt;void&gt; | 返回确认注册结果。 |
**错误码：**
以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 22700104 | Commit enroll failed. |
**示例：** **示例：**
```js ```js
let callbackInfo; enrollIntelligentVoiceEngine.commit().then(() => {
enrollIntelligentVoiceEngine.commit().then((data) => {
callbackInfo = data;
console.info('Commit enroll result finish'); console.info('Commit enroll result finish');
}).catch((err) => { }).catch((err) => {
console.info('Commit enroll result failed, err: '+ err.message); console.info('Commit enroll result failed, err: '+ err.message);
...@@ -777,7 +793,7 @@ setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void ...@@ -777,7 +793,7 @@ setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| info | [WakeupHapInfo](#wakeuphapinfo) | 是 | 唤醒hap信息。 | | info | [WakeupHapInfo](#wakeuphapinfo) | 是 | 唤醒hap信息。 |
| callback | AsyncCallback\<void> | 是 | 返回结果。 | | callback | AsyncCallback\<void\> | 是 | 返回设置唤醒hap信息的结果。 |
**错误码：** **错误码：**
...@@ -785,16 +801,16 @@ setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void ...@@ -785,16 +801,16 @@ setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
let info = { let info = {
bundleName: "demo", bundleName: "com.huawei.hmos.wakeup",
abilityName: "demo", abilityName: "WakeUpExtAbility",
} }
enrollIntelligentVoiceEngine.setWakeupHapInfo(info,(err) => { enrollIntelligentVoiceEngine.setWakeupHapInfo(info, (err) => {
if (err) { if (err) {
console.error(`Set wakeup hap info failed, err: ${err}`); console.error(`Set wakeup hap info failed, err: ${err}`);
} else { } else {
...@@ -805,7 +821,7 @@ enrollIntelligentVoiceEngine.setWakeupHapInfo(info,(err) => { ...@@ -805,7 +821,7 @@ enrollIntelligentVoiceEngine.setWakeupHapInfo(info,(err) => {
### setWakeupHapInfo ### setWakeupHapInfo
setWakeupHapInfo(info: WakeupHapInfo): Promise\<void> setWakeupHapInfo(info: WakeupHapInfo): Promise\<void\>
设置唤醒hap信息，使用Promise异步回调。 设置唤醒hap信息，使用Promise异步回调。
...@@ -813,11 +829,11 @@ setWakeupHapInfo(info: WakeupHapInfo): Promise\<void> ...@@ -813,11 +829,11 @@ setWakeupHapInfo(info: WakeupHapInfo): Promise\<void>
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
**参数：** **返回值：**
| 参数名 | 类型 | 必填 | 说明 | | 类型 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | ----------------------------------------------- | ---------------------------- |
| info | [WakeupHapInfo](#wakeuphapinfo) | 是 | 唤醒hap信息。 | | Promise&lt;void&gt; | 返回设置唤醒hap信息的结果。 |
**错误码：** **错误码：**
...@@ -825,14 +841,14 @@ setWakeupHapInfo(info: WakeupHapInfo): Promise\<void> ...@@ -825,14 +841,14 @@ setWakeupHapInfo(info: WakeupHapInfo): Promise\<void>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
let info = { let info = {
bundleName: "demo", bundleName: "com.huawei.hmos.wakeup",
abilityName: "demo", abilityName: "WakeUpExtAbility",
} }
enrollIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => { enrollIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => {
console.info('Set wakeup hap info finish'); console.info('Set wakeup hap info finish');
...@@ -843,9 +859,9 @@ enrollIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => { ...@@ -843,9 +859,9 @@ enrollIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => {
### setSensibility ### setSensibility
setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): void setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void\>): void
设置灵敏度，使用callback异步回调。 设置唤醒灵敏度，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -856,7 +872,7 @@ setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): vo ...@@ -856,7 +872,7 @@ setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): vo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| sensibility | [SensibilityType](#sensibilitytype) | 是 | 灵敏度类型。 | | sensibility | [SensibilityType](#sensibilitytype) | 是 | 灵敏度类型。 |
| callback | AsyncCallback\<void> | 是 | 返回结果。 | | callback | AsyncCallback\<void\> | 是 | 返回设置灵敏度的结果。 |
**错误码：** **错误码：**
...@@ -864,12 +880,12 @@ setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): vo ...@@ -864,12 +880,12 @@ setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): vo
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
enrollIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY,(err) => { enrollIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY, (err) => {
if (err) { if (err) {
console.error(`setSensibility: Error: ${err}`); console.error(`setSensibility: Error: ${err}`);
} else { } else {
...@@ -880,9 +896,9 @@ enrollIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW ...@@ -880,9 +896,9 @@ enrollIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW
### setSensibility ### setSensibility
setSensibility(sensibility: SensibilityType): Promise\<void> setSensibility(sensibility: SensibilityType): Promise\<void\>
设置灵敏度，使用Promise异步回调。 设置唤醒灵敏度，使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -894,13 +910,19 @@ setSensibility(sensibility: SensibilityType): Promise\<void> ...@@ -894,13 +910,19 @@ setSensibility(sensibility: SensibilityType): Promise\<void>
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| sensibility | [SensibilityType](#sensibilitytype) | 是 | 灵敏度类型。 | | sensibility | [SensibilityType](#sensibilitytype) | 是 | 灵敏度类型。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- |
| Promise&lt;void&gt; | 返回设置灵敏度的结果。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。 以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
...@@ -914,9 +936,9 @@ enrollIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW ...@@ -914,9 +936,9 @@ enrollIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW
### setParameter ### setParameter
setParameter(key: string, value: string, callback: AsyncCallback\<void>): void setParameter(key: string, value: string, callback: AsyncCallback\<void\>): void
设置参数，使用callback异步回调。 设置智能语音参数，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -928,7 +950,7 @@ setParameter(key: string, value: string, callback: AsyncCallback\<void>): void ...@@ -928,7 +950,7 @@ setParameter(key: string, value: string, callback: AsyncCallback\<void>): void
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| key | string | 是 | 键。 | | key | string | 是 | 键。 |
| value | string | 是 | 值。 | | value | string | 是 | 值。 |
| callback | AsyncCallback\<void> | 是 | 返回结果。 | | callback | AsyncCallback\<void\> | 是 | 返回设置智能语音参数的结果。 |
**错误码：** **错误码：**
...@@ -936,12 +958,12 @@ setParameter(key: string, value: string, callback: AsyncCallback\<void>): void ...@@ -936,12 +958,12 @@ setParameter(key: string, value: string, callback: AsyncCallback\<void>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
enrollIntelligentVoiceEngine.setParameter('scene', '0' ,(err) => { enrollIntelligentVoiceEngine.setParameter('scene', '0', (err) => {
if (err) { if (err) {
console.error(`setParameter: Error: ${err}`); console.error(`setParameter: Error: ${err}`);
} else { } else {
...@@ -952,9 +974,9 @@ enrollIntelligentVoiceEngine.setParameter('scene', '0' ,(err) => { ...@@ -952,9 +974,9 @@ enrollIntelligentVoiceEngine.setParameter('scene', '0' ,(err) => {
### setParameter ### setParameter
setParameter(key: string, value: string): Promise\<void> setParameter(key: string, value: string): Promise\<void\>
设置参数，使用Promise异步回调。 设置智能语音参数，使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -967,13 +989,19 @@ setParameter(key: string, value: string): Promise\<void> ...@@ -967,13 +989,19 @@ setParameter(key: string, value: string): Promise\<void>
| key | string | 是 | 键。 | | key | string | 是 | 键。 |
| value | string | 是 | 值。 | | value | string | 是 | 值。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- |
| Promise&lt;void&gt; | 返回设置智能语音参数的结果。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。 以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
...@@ -987,9 +1015,9 @@ enrollIntelligentVoiceEngine.setSensibility('scene', '0').then(() => { ...@@ -987,9 +1015,9 @@ enrollIntelligentVoiceEngine.setSensibility('scene', '0').then(() => {
### getParameter ### getParameter
getParameter(key: string, callback: AsyncCallback\<string>): void getParameter(key: string, callback: AsyncCallback\<string\>): void
获取参数，使用callback异步回调。 获取智能语音参数，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1000,7 +1028,7 @@ getParameter(key: string, callback: AsyncCallback\<string>): void ...@@ -1000,7 +1028,7 @@ getParameter(key: string, callback: AsyncCallback\<string>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| key | string | 是 | 键。 | | key | string | 是 | 键。 |
| callback | AsyncCallback\<string> | 是 | 返回的值。 | | callback | AsyncCallback\<string\> | 是 | 返回智能语音参数。 |
**错误码：** **错误码：**
...@@ -1008,12 +1036,12 @@ getParameter(key: string, callback: AsyncCallback\<string>): void ...@@ -1008,12 +1036,12 @@ getParameter(key: string, callback: AsyncCallback\<string>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
enrollIntelligentVoiceEngine.getParameter('key' ,(err,data) => { enrollIntelligentVoiceEngine.getParameter('key', (err,data) => {
if (err) { if (err) {
console.error(`getParameter: Error: ${err}`); console.error(`getParameter: Error: ${err}`);
} else { } else {
...@@ -1025,9 +1053,9 @@ enrollIntelligentVoiceEngine.getParameter('key' ,(err,data) => { ...@@ -1025,9 +1053,9 @@ enrollIntelligentVoiceEngine.getParameter('key' ,(err,data) => {
### getParameter ### getParameter
getParameter(key: string): Promise\<string> getParameter(key: string): Promise\<string\>
获取参数，使用Promise异步回调。 获取智能语音参数，使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1043,7 +1071,7 @@ getParameter(key: string): Promise\<string> ...@@ -1043,7 +1071,7 @@ getParameter(key: string): Promise\<string>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Promise\<string> | 返回的信息。 | | Promise\<string\> | 返回智能语音参数。 |
**错误码：** **错误码：**
...@@ -1051,7 +1079,7 @@ getParameter(key: string): Promise\<string> ...@@ -1051,7 +1079,7 @@ getParameter(key: string): Promise\<string>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
...@@ -1069,15 +1097,17 @@ enrollIntelligentVoiceEngine.getParameter('key').then((data) => { ...@@ -1069,15 +1097,17 @@ enrollIntelligentVoiceEngine.getParameter('key').then((data) => {
release(callback: AsyncCallback&lt;void&gt;): void release(callback: AsyncCallback&lt;void&gt;): void
释放引擎，使用callback异步回调。 释放注册智能语音引擎，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| callback | AsyncCallback\<void> | 是 | 返回的结果。 | | callback | AsyncCallback\<void\> | 是 | 返回释放注册引擎的结果。 |
**示例：** **示例：**
...@@ -1095,12 +1125,18 @@ enrollIntelligentVoiceEngine.release((err) => { ...@@ -1095,12 +1125,18 @@ enrollIntelligentVoiceEngine.release((err) => {
release(): Promise&lt;void&gt; release(): Promise&lt;void&gt;
通过Promise释放引擎，使用Promise异步回调。 释放注册智能语音引擎，使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- |
| Promise&lt;void&gt; | 返回释放注册引擎的结果。 |
**示例：** **示例：**
```js ```js
...@@ -1113,11 +1149,11 @@ enrollIntelligentVoiceEngine.release().then(() => { ...@@ -1113,11 +1149,11 @@ enrollIntelligentVoiceEngine.release().then(() => {
## WakeupIntelligentVoiceEngine ## WakeupIntelligentVoiceEngine
实现唤醒智能语音引擎。 实现唤醒智能语音引擎，通过[createWakeupIntelligentVoiceEngine()](#intelligentvoicecreatewakeupintelligentvoiceengine)获取唤醒智能语音引擎。
### getSupportedRegions ### getSupportedRegions
getSupportedRegions(callback: AsyncCallback\<Array\<string>>): void getSupportedRegions(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
获取支持的区域，使用callback异步回调。 获取支持的区域，使用callback异步回调。
...@@ -1127,24 +1163,25 @@ getSupportedRegions(callback: AsyncCallback\<Array\<string>>): void ...@@ -1127,24 +1163,25 @@ getSupportedRegions(callback: AsyncCallback\<Array\<string>>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| callback | AsyncCallback\<void> | 是 | 返回的结果。 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 返回支持区域的数组。 |
**示例：** **示例：**
```js ```js
let regions = nullptr;
wkeupIntelligentVoiceEngine.getSupportedRegions((err, data) => { wkeupIntelligentVoiceEngine.getSupportedRegions((err, data) => {
if (err) { if (err) {
console.error(`Failed to getSupportedRegions, ${err}`); console.error(`Failed to getSupportedRegions, ${err}`);
} else { } else {
console.info('getSupportedRegions success.'); console.info('getSupportedRegions success.');
let regions = data; regions = data;
} }
}); });
``` ```
### getSupportedRegions ### getSupportedRegions
getSupportedRegions(): Promise\<Array\<string>> getSupportedRegions(): Promise&lt;Array&lt;string&gt;&gt;
获取支持的区域，使用Promise异步回调。 获取支持的区域，使用Promise异步回调。
...@@ -1156,12 +1193,12 @@ getSupportedRegions(): Promise\<Array\<string>> ...@@ -1156,12 +1193,12 @@ getSupportedRegions(): Promise\<Array\<string>>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Array\<string> | 返回受支持区域。 | | Promise&lt;Array&lt;string&gt;&gt; | 返回支持区域的数组。 |
**示例：** **示例：**
```js ```js
let regions; let regions = nullptr;
wkeupIntelligentVoiceEngine.getSupportedRegions().then((data) => { wkeupIntelligentVoiceEngine.getSupportedRegions().then((data) => {
regions = data; regions = data;
console.info('getSupportedRegions success'); console.info('getSupportedRegions success');
...@@ -1172,7 +1209,7 @@ wkeupIntelligentVoiceEngine.getSupportedRegions().then((data) => { ...@@ -1172,7 +1209,7 @@ wkeupIntelligentVoiceEngine.getSupportedRegions().then((data) => {
### setWakeupHapInfo ### setWakeupHapInfo
setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void\>): void
设置唤醒hap信息，使用callback异步回调。 设置唤醒hap信息，使用callback异步回调。
...@@ -1185,7 +1222,7 @@ setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void ...@@ -1185,7 +1222,7 @@ setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| info | [WakeupHapInfo](#wakeuphapinfo) | 是 | 唤醒hap信息。 | | info | [WakeupHapInfo](#wakeuphapinfo) | 是 | 唤醒hap信息。 |
| callback | AsyncCallback\<void> | 是 | 返回的结果。 | | callback | AsyncCallback\<void\> | 是 | 返回设置唤醒hap信息的结果。 |
**错误码：** **错误码：**
...@@ -1193,16 +1230,16 @@ setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void ...@@ -1193,16 +1230,16 @@ setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback\<void>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
let info = { let info = {
bundleName: "demo", bundleName: "com.huawei.hmos.wakeup",
abilityName: "demo", abilityName: "WakeUpExtAbility",
} }
wkeupIntelligentVoiceEngine.setWakeupHapInfo(info,(err) => { wkeupIntelligentVoiceEngine.setWakeupHapInfo(info, (err) => {
if (err) { if (err) {
console.error(`Set wakeup hap info failed, err: ${err}`); console.error(`Set wakeup hap info failed, err: ${err}`);
} else { } else {
...@@ -1213,7 +1250,7 @@ wkeupIntelligentVoiceEngine.setWakeupHapInfo(info,(err) => { ...@@ -1213,7 +1250,7 @@ wkeupIntelligentVoiceEngine.setWakeupHapInfo(info,(err) => {
### setWakeupHapInfo ### setWakeupHapInfo
setWakeupHapInfo(info: WakeupHapInfo): Promise\<void> setWakeupHapInfo(info: WakeupHapInfo): Promise\<void\>
设置唤醒hap信息，使用promise异步回调。 设置唤醒hap信息，使用promise异步回调。
...@@ -1227,20 +1264,26 @@ setWakeupHapInfo(info: WakeupHapInfo): Promise\<void> ...@@ -1227,20 +1264,26 @@ setWakeupHapInfo(info: WakeupHapInfo): Promise\<void>
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| info | [WakeupHapInfo](#wakeuphapinfo) | 是 | 唤醒hap信息。 | | info | [WakeupHapInfo](#wakeuphapinfo) | 是 | 唤醒hap信息。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- |
| Promise&lt;void&gt; | 返回设置唤醒hap信息的结果。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。 以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
let info = { let info = {
bundleName: "demo", bundleName: "com.huawei.hmos.wakeup",
abilityName: "demo", abilityName: "WakeUpExtAbility",
} }
wkeupIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => { wkeupIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => {
console.info('Set wakeup hap info finish'); console.info('Set wakeup hap info finish');
...@@ -1251,9 +1294,9 @@ wkeupIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => { ...@@ -1251,9 +1294,9 @@ wkeupIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => {
### setSensibility ### setSensibility
setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): void setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void\>): void
设置灵敏度，使用callback异步回调。 设置唤醒灵敏度，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1264,7 +1307,7 @@ setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): vo ...@@ -1264,7 +1307,7 @@ setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): vo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| sensibility | [SensibilityType](#sensibilitytype) | 是 | 灵敏度类型。 | | sensibility | [SensibilityType](#sensibilitytype) | 是 | 灵敏度类型。 |
| callback | AsyncCallback\<void> | 是 | 返回的结果。 | | callback | AsyncCallback\<void\> | 是 | 返回设置灵敏度的结果。 |
**错误码：** **错误码：**
...@@ -1272,12 +1315,12 @@ setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): vo ...@@ -1272,12 +1315,12 @@ setSensibility(sensibility: SensibilityType, callback: AsyncCallback\<void>): vo
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
wkeupIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY,(err) => { wkeupIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY, (err) => {
if (err) { if (err) {
console.error(`setSensibility: Error: ${err}`); console.error(`setSensibility: Error: ${err}`);
} else { } else {
...@@ -1286,12 +1329,11 @@ wkeupIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_ ...@@ -1286,12 +1329,11 @@ wkeupIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_
}); });
``` ```
### setSensibility ### setSensibility
setSensibility(sensibility: SensibilityType): Promise\<void> setSensibility(sensibility: SensibilityType): Promise\<void\>
设置灵敏度，使用Promise异步回调。 设置唤醒灵敏度，使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1303,13 +1345,19 @@ setSensibility(sensibility: SensibilityType): Promise\<void> ...@@ -1303,13 +1345,19 @@ setSensibility(sensibility: SensibilityType): Promise\<void>
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| sensibility | [SensibilityType](#sensibilitytype) | 是 | 灵敏度类型。 | | sensibility | [SensibilityType](#sensibilitytype) | 是 | 灵敏度类型。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- |
| Promise&lt;void&gt; | 返回设置灵敏度的结果。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。 以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
...@@ -1323,9 +1371,9 @@ wkeupIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_ ...@@ -1323,9 +1371,9 @@ wkeupIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_
### setParameter ### setParameter
setParameter(key: string, value: string, callback: AsyncCallback\<void>): void setParameter(key: string, value: string, callback: AsyncCallback\<void\>): void
设置参数，使用callback异步回调。 设置智能语音参数，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1337,7 +1385,7 @@ setParameter(key: string, value: string, callback: AsyncCallback\<void>): void ...@@ -1337,7 +1385,7 @@ setParameter(key: string, value: string, callback: AsyncCallback\<void>): void
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| key | string | 是 | 键。 | | key | string | 是 | 键。 |
| value | string | 是 | 值。 | | value | string | 是 | 值。 |
| callback | AsyncCallback\<void> | 是 | 返回的结果。 | | callback | AsyncCallback\<void\> | 是 | 返回设置智能语音参数的结果。 |
**错误码：** **错误码：**
...@@ -1345,12 +1393,12 @@ setParameter(key: string, value: string, callback: AsyncCallback\<void>): void ...@@ -1345,12 +1393,12 @@ setParameter(key: string, value: string, callback: AsyncCallback\<void>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
wkeupIntelligentVoiceEngine.setParameter('scene', '0' ,(err) => { wkeupIntelligentVoiceEngine.setParameter('scene', '0', (err) => {
if (err) { if (err) {
console.error(`setParameter: Error: ${err}`); console.error(`setParameter: Error: ${err}`);
} else { } else {
...@@ -1361,9 +1409,9 @@ wkeupIntelligentVoiceEngine.setParameter('scene', '0' ,(err) => { ...@@ -1361,9 +1409,9 @@ wkeupIntelligentVoiceEngine.setParameter('scene', '0' ,(err) => {
### setParameter ### setParameter
setParameter(key: string, value: string): Promise\<void> setParameter(key: string, value: string): Promise\<void\>
设置参数，使用Promise异步回调。 设置智能语音参数，使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1376,13 +1424,19 @@ setParameter(key: string, value: string): Promise\<void> ...@@ -1376,13 +1424,19 @@ setParameter(key: string, value: string): Promise\<void>
| key | string | 是 | 键。 | | key | string | 是 | 键。 |
| value | string | 是 | 值。 | | value | string | 是 | 值。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- |
| Promise&lt;void&gt; | 返回设置智能语音参数的结果。 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。 以下错误码的详细介绍请参见[智能语音错误码](../errorcodes/errorcode-intelligentVoice.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
...@@ -1396,9 +1450,9 @@ wkeupIntelligentVoiceEngine.setSensibility('scene', '0').then(() => { ...@@ -1396,9 +1450,9 @@ wkeupIntelligentVoiceEngine.setSensibility('scene', '0').then(() => {
### getParameter ### getParameter
getParameter(key: string, callback: AsyncCallback\<string>): void getParameter(key: string, callback: AsyncCallback\<string\>): void
获取参数，使用callback异步回调。 获取智能语音参数，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1409,7 +1463,7 @@ getParameter(key: string, callback: AsyncCallback\<string>): void ...@@ -1409,7 +1463,7 @@ getParameter(key: string, callback: AsyncCallback\<string>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| key | string | 是 | 键。 | | key | string | 是 | 键。 |
| callback | AsyncCallback\<string> | 是 | 返回的结果。 | | callback | AsyncCallback\<string\> | 是 | 返回智能语音参数。 |
**错误码：** **错误码：**
...@@ -1417,12 +1471,12 @@ getParameter(key: string, callback: AsyncCallback\<string>): void ...@@ -1417,12 +1471,12 @@ getParameter(key: string, callback: AsyncCallback\<string>): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
```js ```js
wkeupIntelligentVoiceEngine.getParameter('key' ,(err,data) => { wkeupIntelligentVoiceEngine.getParameter('key', (err, data) => {
if (err) { if (err) {
console.error(`getParameter: Error: ${err}`); console.error(`getParameter: Error: ${err}`);
} else { } else {
...@@ -1434,7 +1488,7 @@ wkeupIntelligentVoiceEngine.getParameter('key' ,(err,data) => { ...@@ -1434,7 +1488,7 @@ wkeupIntelligentVoiceEngine.getParameter('key' ,(err,data) => {
### getParameter ### getParameter
getParameter(key: string): Promise\<string> getParameter(key: string): Promise\<string\>
获取参数，使用Promise异步回调。 获取参数，使用Promise异步回调。
...@@ -1452,7 +1506,7 @@ getParameter(key: string): Promise\<string> ...@@ -1452,7 +1506,7 @@ getParameter(key: string): Promise\<string>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- | | ----------------------------------------------- | ---------------------------- |
| Promise\<string> | 返回的信息。 | | Promise\<string\> | 返回智能语音参数。 |
**错误码：** **错误码：**
...@@ -1460,7 +1514,7 @@ getParameter(key: string): Promise\<string> ...@@ -1460,7 +1514,7 @@ getParameter(key: string): Promise\<string>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 22700102 | if input parameter value error. | | 22700102 | Input parameter value error. |
**示例：** **示例：**
...@@ -1468,7 +1522,7 @@ getParameter(key: string): Promise\<string> ...@@ -1468,7 +1522,7 @@ getParameter(key: string): Promise\<string>
let param; let param;
wkeupIntelligentVoiceEngine.getParameter('key').then((data) => { wkeupIntelligentVoiceEngine.getParameter('key').then((data) => {
param = data; param = data;
console.info('getParameter: Success : Stream Type: SUCCESS'); console.info('getParameter: Success');
}).catch((err) => { }).catch((err) => {
console.error(`getParameter: ERROR : ${err}`); console.error(`getParameter: ERROR : ${err}`);
}); });
...@@ -1476,14 +1530,20 @@ wkeupIntelligentVoiceEngine.getParameter('key').then((data) => { ...@@ -1476,14 +1530,20 @@ wkeupIntelligentVoiceEngine.getParameter('key').then((data) => {
### release ### release
release(callback: AsyncCallback\<void>): void release(callback: AsyncCallback\<void\>): void
释放引擎，使用callback异步回调。 释放唤醒智能语音引擎，使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| callback | AsyncCallback\<void\> | 是 | 返回释放唤醒引擎的结果。 |
**示例：** **示例：**
```js ```js
...@@ -1498,14 +1558,20 @@ wkeupIntelligentVoiceEngine.release((err) => { ...@@ -1498,14 +1558,20 @@ wkeupIntelligentVoiceEngine.release((err) => {
### release ### release
release(): Promise\<void> release(): Promise\<void\>
释放引擎，使用Promise异步回调。 释放唤醒智能语音引擎，使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
**系统能力：** SystemCapability.AI.IntelligentVoice.Core **系统能力：** SystemCapability.AI.IntelligentVoice.Core
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ---------------------------- |
| Promise&lt;void&gt; | 返回释放唤醒引擎的结果。 |
**示例：** **示例：**
```js ```js
...@@ -1520,7 +1586,7 @@ wkeupIntelligentVoiceEngine.release().then(() => { ...@@ -1520,7 +1586,7 @@ wkeupIntelligentVoiceEngine.release().then(() => {
on(type: 'wakeupIntelligentVoiceEvent', callback: Callback\<WakeupIntelligentVoiceEngineCallbackInfo\>): void on(type: 'wakeupIntelligentVoiceEvent', callback: Callback\<WakeupIntelligentVoiceEngineCallbackInfo\>): void
订阅唤醒智能语音事件。当唤醒智能语音事件到达时，调用回调。 订阅唤醒事件。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1531,24 +1597,24 @@ on(type: 'wakeupIntelligentVoiceEvent', callback: Callback\<WakeupIntelligentVoi ...@@ -1531,24 +1597,24 @@ on(type: 'wakeupIntelligentVoiceEvent', callback: Callback\<WakeupIntelligentVoi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| type | string | 是 | 唤醒智能语音事件，固定取为'wakeupIntelligentVoiceEvent'，表示智能语音唤醒事件。 | | type | string | 是 | 唤醒智能语音事件，固定取为'wakeupIntelligentVoiceEvent'，表示智能语音唤醒事件。 |
| callback | Callback\<[WakeupIntelligentVoiceEngineCallbackInfo](#wakeupintelligentvoiceenginecallbackinfo)\> | 是 | 唤醒智能语音引擎回调信息。 | | callback | Callback\<[WakeupIntelligentVoiceEngineCallbackInfo](#wakeupintelligentvoiceengineCallbackInfo)\> | 是 | 唤醒事件回调接口。 |
**示例：** **示例：**
```js ```js
wkeupIntelligentVoiceEngine.on('wakeupIntelligentVoiceEvent', (callback) => { wkeupIntelligentVoiceEngine.on('wakeupIntelligentVoiceEvent', (callback) => {
console.info(`${tag}: wakeup intelligentvoice event`); console.info(`wakeup intelligentvoice event`);
for (let prop in callback) { for (let prop in callback) {
console.info(`${tag}: intelligentvoice prop: ${prop}`); console.info(`intelligentvoice prop: ${prop}`);
} }
}); });
``` ```
### off ### off
off(type: 'wakeupIntelligentVoiceEvent') off(type: 'wakeupIntelligentVoiceEvent', callback?: Callback\<WakeupIntelligentVoiceEngineCallbackInfo\>): void;
取消订阅唤醒智能语音事件。 取消订阅唤醒事件。
**需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE **需要权限：** ohos.permission.MANAGE_INTELLIGENT_VOICE
...@@ -1559,6 +1625,7 @@ off(type: 'wakeupIntelligentVoiceEvent') ...@@ -1559,6 +1625,7 @@ off(type: 'wakeupIntelligentVoiceEvent')
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | --- | ------------------------------------------- | | -------- | -------------------------------- | --- | ------------------------------------------- |
| type |string | 是 | 唤醒智能语音事件，固定取为'wakeupIntelligentVoiceEvent'。 | | type |string | 是 | 唤醒智能语音事件，固定取为'wakeupIntelligentVoiceEvent'。 |
| callback | Callback\<[WakeupIntelligentVoiceEngineCallbackInfo](#wakeupintelligentvoiceengineCallbackInfo)\> | 否 | 唤醒事件回调接口。 |
**示例：** **示例：**
......
zh-cn/application-dev/reference/errorcodes/errorcode-intelligentVoice.md
浏览文件 @ ef3ebac0
...@@ -62,27 +62,7 @@ Init failed. ...@@ -62,27 +62,7 @@ Init failed.
1、不要重复初始化。 1、不要重复初始化。
2、确认初始化资源已经预置 2、确认初始化资源已经预置
## 22700104 注册失败 ## 22700104 确认注册结果失败
**错误信息**
Enroll failed.
**错误描述**
调用注册引擎的注册接口时，返回注册失败。
**可能原因**
1、创建录音流失败。
2、用户没有准确说出唤醒词。
**处理步骤**
1、确认录音流失败的原因后再重新发起注册。
2、按照界面提示的唤醒词进行注册。
## 22700105 确认注册完成失败
**错误信息** **错误信息**
...@@ -90,7 +70,7 @@ Commit enroll failed. ...@@ -90,7 +70,7 @@ Commit enroll failed.
**错误描述** **错误描述**
调用注册引擎的确认注册完成接口时，返回失败。 调用注册引擎的确认注册结果接口时，返回失败。
**可能原因** **可能原因**
...@@ -99,21 +79,3 @@ Commit enroll failed. ...@@ -99,21 +79,3 @@ Commit enroll failed.
**处理步骤** **处理步骤**
根据界面上要求的注册次数注册完成后再确认注册结果。 根据界面上要求的注册次数注册完成后再确认注册结果。
\ No newline at end of file
## 22700106 唤醒失败
**错误信息**
Recognize failed.
**错误描述**
注册唤醒引擎的唤醒事件监听后，接收到唤醒事件时，返回唤醒失败。
**可能原因**
误唤醒或者用户未准确说出注册的唤醒词
**处理步骤**
不处理该次唤醒事件
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或