@ohos.ai.intelligentVoice (智能语音)(系统接口)

智能语音主要提供了语音注册及语音唤醒相关功能。

该模块提供以下智能语音相关的常用功能：

• IntelligentVoiceManager：智能语音管理类，明确当前智能语音提供的相关功能，当前支持语音注册、语音唤醒。在进行智能语音相关开发前，需先调用getIntelligentVoiceManager()确认当前支持智能语音的相关功能，再进行语音注册和语音唤醒的相关开发。
• EnrollIntelligentVoiceEngine：实现语音注册。开发者需要先进行智能语音的注册，然后才能进行唤醒。
• WakeupIntelligentVoiceEngine：实现语音唤醒。开发者需要先进行智能语音的注册，然后才能进行唤醒。

说明：

• 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

• 本模块接口为系统接口。

导入模块

import intelligentVoice from '@ohos.ai.intelligentVoice';

intelligentVoice.getIntelligentVoiceManager

getIntelligentVoiceManager(): IntelligentVoiceManager

获取智能语音管理类。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let intelligentVoiceManager: intelligentVoice.IntelligentVoiceManager | null = null;
try {
  intelligentVoiceManager = intelligentVoice.getIntelligentVoiceManager();
} catch (err) {
  let error = err as BusinessError;
  console.error(`Get IntelligentVoiceManager failed. Code:${error.code}, message:${error.message}`);
}

intelligentVoice.createEnrollIntelligentVoiceEngine

createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescriptor, callback: AsyncCallback<EnrollIntelligentVoiceEngine>): void

创建智能语音注册引擎实例，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let engineDescriptor: intelligentVoice.EnrollIntelligentVoiceEngineDescriptor = {
  wakeupPhrase: '小华小华',
}
let enrollIntelligentVoiceEngine: intelligentVoice.EnrollIntelligentVoiceEngine | null = null;
intelligentVoice.createEnrollIntelligentVoiceEngine(engineDescriptor, (err: BusinessError, data: intelligentVoice.EnrollIntelligentVoiceEngine) => {
  if (err) {
    console.error(`Failed to create enrollIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
  } else {
    console.info(`Succeeded in creating enrollIntelligentVoice engine.`);
    enrollIntelligentVoiceEngine = data;
  }
});

intelligentVoice.createEnrollIntelligentVoiceEngine

createEnrollIntelligentVoiceEngine(descriptor: EnrollIntelligentVoiceEngineDescriptor): Promise<EnrollIntelligentVoiceEngine>

创建智能语音注册引擎实例，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let engineDescriptor: intelligentVoice.EnrollIntelligentVoiceEngineDescriptor = {
  wakeupPhrase: '小华小华',
}
let enrollIntelligentVoiceEngine: intelligentVoice.EnrollIntelligentVoiceEngine | null = null;
intelligentVoice.createEnrollIntelligentVoiceEngine(engineDescriptor).then((data: intelligentVoice.EnrollIntelligentVoiceEngine) => {
  enrollIntelligentVoiceEngine = data;
  console.info(`Succeeded in creating enrollIntelligentVoice engine.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to create enrollIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
});

intelligentVoice.createWakeupIntelligentVoiceEngine

createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescriptor, callback: AsyncCallback<WakeupIntelligentVoiceEngine>): void

创建智能语音唤醒引擎实例，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let wakeupEngineDescriptor: intelligentVoice.WakeupIntelligentVoiceEngineDescriptor = {
  needReconfirm: true,
  wakeupPhrase: '小华小华',
}
let wakeupIntelligentVoiceEngine: intelligentVoice.WakeupIntelligentVoiceEngine | null = null;
intelligentVoice.createWakeupIntelligentVoiceEngine(wakeupEngineDescriptor, (err: BusinessError, data: intelligentVoice.WakeupIntelligentVoiceEngine) => {
  if (err) {
    console.error(`Failed to create wakeupIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
  } else {
    console.info(`Succeeded in creating wakeupIntelligentVoice engine.`);
    wakeupIntelligentVoiceEngine = data;
  }
});

intelligentVoice.createWakeupIntelligentVoiceEngine

createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescriptor): Promise<WakeupIntelligentVoiceEngine>

创建智能语音唤醒引擎实例，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let wakeupEngineDescriptor: intelligentVoice.WakeupIntelligentVoiceEngineDescriptor = {
  needReconfirm: true,
  wakeupPhrase: '小华小华',
}
let wakeupIntelligentVoiceEngine: intelligentVoice.WakeupIntelligentVoiceEngine | null = null;
intelligentVoice.createWakeupIntelligentVoiceEngine(wakeupEngineDescriptor).then((data: intelligentVoice.WakeupIntelligentVoiceEngine) => {
  wakeupIntelligentVoiceEngine = data;
  console.info(`Succeeded in creating wakeupIntelligentVoice engine.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to create wakeupIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
});

IntelligentVoiceManager

智能语音管理类，使用前需要通过getIntelligentVoiceManager()获取智能语音管理实例。

getCapabilityInfo

getCapabilityInfo(): Array<IntelligentVoiceEngineType>

获取支持的智能语音引擎列表信息。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

示例：

if (intelligentVoiceManager != null) {
  let info = intelligentVoiceManager.getCapabilityInfo();
}

on('serviceChange')

on(type: 'serviceChange', callback: Callback<ServiceChangeType>): void

订阅服务变更事件。当智能语音业务状态发生变化时，调用回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

示例：

if (intelligentVoiceManager != null) {
  intelligentVoiceManager.on('serviceChange', (serviceChangeType: intelligentVoice.ServiceChangeType) => {});
}

off('serviceChange')

off(type: 'serviceChange', callback?: Callback<ServiceChangeType>): void

取消订阅服务变更事件。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

示例：

if (intelligentVoiceManager != null) {
  intelligentVoiceManager.off('serviceChange');
}

ServiceChangeType

枚举，服务状态变更类型。

系统能力： SystemCapability.AI.IntelligentVoice.Core

IntelligentVoiceEngineType

枚举，智能语音引擎类型。

系统能力： SystemCapability.AI.IntelligentVoice.Core

EnrollIntelligentVoiceEngineDescriptor

注册智能语音引擎描述符。

系统能力： SystemCapability.AI.IntelligentVoice.Core

WakeupIntelligentVoiceEngineDescriptor

唤醒智能语音引擎描述符。

系统能力： SystemCapability.AI.IntelligentVoice.Core

EnrollEngineConfig

描述注册引擎配置。

系统能力： SystemCapability.AI.IntelligentVoice.Core

SensibilityType

枚举，唤醒灵敏度类型。 灵敏度用于调整唤醒的门限，灵敏度越高，门限越低，就越容易唤醒。

系统能力： SystemCapability.AI.IntelligentVoice.Core

WakeupHapInfo

描述唤醒应用的hap信息。

系统能力： SystemCapability.AI.IntelligentVoice.Core

WakeupIntelligentVoiceEventType

枚举，唤醒智能语音事件类型。

系统能力： SystemCapability.AI.IntelligentVoice.Core

IntelligentVoiceErrorCode

枚举，智能语音错误码。

系统能力： SystemCapability.AI.IntelligentVoice.Core

EnrollResult

枚举，注册结果。

系统能力： SystemCapability.AI.IntelligentVoice.Core

EnrollCallbackInfo

注册回调信息。

系统能力： SystemCapability.AI.IntelligentVoice.Core

WakeupIntelligentVoiceEngineCallbackInfo

描述唤醒智能语音引擎回调信息。

系统能力： SystemCapability.AI.IntelligentVoice.Core

EnrollIntelligentVoiceEngine

实现注册智能语音引擎，通过createEnrollIntelligentVoiceEngine()获取注册智能语音引擎。

getSupportedRegions

getSupportedRegions(callback: AsyncCallback<Array<string>>): void

获取支持的区域，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

let regions: Array<string> | null = null;
if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).getSupportedRegions((err: BusinessError, data: Array<string>) => {
    if (err) {
      console.error(`Failed to get supported regions, Code:${err.code}, message:${err.message}`);
    } else {
      regions = data;
      console.info(`Succeeded in getting supported regions, regions:${regions}.`);
    }
  });
}

getSupportedRegions

getSupportedRegions(): Promise<Array<string>>

获取支持的区域，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

示例：

import { BusinessError } from '@ohos.base';

let regions: Array<string> | null = null;
if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).getSupportedRegions().then((data: Array<string>) => {
    regions = data;
    console.info('Succeeded in getting supported regions, regions:${regions}.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to get supported regions, Code:${err.code}, message:${err.message}`);
  });
}

init

init(config: EnrollEngineConfig, callback: AsyncCallback<void>): void

初始化注册智能语音引擎，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let config: intelligentVoice.EnrollEngineConfig = {
  language: 'zh',
  region: 'CN',
}
if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).init(config, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to initialize enrollIntelligentVoice engine. Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in initialzing enrollIntelligentVoice engine.`);
    }
  });
}

init

init(config: EnrollEngineConfig): Promise<void>

初始化注册智能语音引擎，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let config: intelligentVoice.EnrollEngineConfig = {
  language: 'zh',
  region: 'CN',
}
if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).init(config).then(() => {
    console.info(`Succeeded in initializing enrollIntelligentVoice engine.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to initialize enrollIntelligentVoice engine. Code:${err.code}, message:${err.message}`);
  });
}

enrollForResult

enrollForResult(isLast: boolean, callback: AsyncCallback<EnrollCallbackInfo>): void

获取注册结果，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

let callbackInfo: intelligentVoice.EnrollCallbackInfo | null = null;
if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).enrollForResult(true, (err: BusinessError, data: intelligentVoice.EnrollCallbackInfo) => {
    if (err) {
      console.error(`Failed to enroll for result, Code:${err.code}, message:${err.message}`);
    } else {
      callbackInfo = data;
      console.info(`Succeeded in enrolling for result, info:${callbackInfo}.`);
    }
  });
}

enrollForResult

enrollForResult(isLast: boolean): Promise<EnrollCallbackInfo>

获取注册结果，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';

let callbackInfo: intelligentVoice.EnrollCallbackInfo | null = null;
if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).enrollForResult(true).then((data: intelligentVoice.EnrollCallbackInfo) => {
    callbackInfo = data;
    console.info(`Succeeded in enrolling for result, info:${callbackInfo}.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to enroll for result, Code:${err.code}, message:${err.message}`);
  });
}

stop

stop(callback: AsyncCallback<void>): void

停止注册，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).stop((err: BusinessError) => {
    if (err) {
      console.error(`Failed to stop enrollIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in stopping enrollIntelligentVoice engine.`);
    }
  });
}

stop

stop(): Promise<void>

停止注册，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).stop().then(() => {
    console.info(`Succeeded in stopping enrollIntelligentVoice engine.`);
  }).catch((err:BusinessError) => {
    console.error(`Failed to stop enrollIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
  });
}

commit

commit(callback: AsyncCallback<void>): void

提交注册，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).commit((err: BusinessError) => {
    if (err) {
      console.error(`Failed to commit enroll, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in committing enroll.`);
    }
  });
}

commit

commit(): Promise<void>

提交注册，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).commit().then(() => {
    console.info(`Succeeded in committing enroll.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to commit enroll, Code:${err.code}, message:${err.message}`);
  });
}

setWakeupHapInfo

setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback<void>): void

设置唤醒应用的hap信息，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let info: intelligentVoice.WakeupHapInfo = {
  bundleName: 'com.wakeup',
  abilityName: 'WakeUpExtAbility',
}
if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).setWakeupHapInfo(info, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to set wakeup hap info, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in setting wakeup hap info.`);
    }
  });
}

setWakeupHapInfo

setWakeupHapInfo(info: WakeupHapInfo): Promise<void>

设置唤醒应用的hap信息，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let info: intelligentVoice.WakeupHapInfo = {
  bundleName: 'com.wakeup',
  abilityName: 'WakeUpExtAbility',
}
if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).setWakeupHapInfo(info).then(() => {
    console.info(`Succeeded in setting wakeup hap info.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to set wakeup hap info, Code:${err.code}, message:${err.message}`);
  });
}

setSensibility

setSensibility(sensibility: SensibilityType, callback: AsyncCallback<void>): void

设置唤醒灵敏度，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to set sensibility, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in setting sensibility.`);
    }
  });
}

setSensibility

setSensibility(sensibility: SensibilityType): Promise<void>

设置唤醒灵敏度，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY).then(() => {
    console.info(`Succeeded in setting sensibility.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to set sensibility, Code:${err.code}, message:${err.message}`);
  });
}

setParameter

setParameter(key: string, value: string, callback: AsyncCallback<void>): void

设置指定的智能语音参数，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).setParameter('scene', '0', (err: BusinessError) => {
    if (err) {
      console.error(`Failed to set parameter, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in setting parameter`);
    }
  });
}

setParameter

setParameter(key: string, value: string): Promise<void>

设置指定的智能语音参数，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).setParameter('scene', '0').then(() => {
    console.info(`Succeeded in setting parameter`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to set parameter, Code:${err.code}, message:${err.message}`);
  });
}

getParameter

getParameter(key: string, callback: AsyncCallback<string>): void

获取指定的智能语音参数，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).getParameter('key', (err: BusinessError, data: string) => {
    if (err) {
      console.error(`Failed to get parameter, Code:${err.code}, message:${err.message}`);
    } else {
      let param: string = data;
      console.info(`Succeeded in getting parameter, param:${param}`);
    }
  });
}

getParameter

getParameter(key: string): Promise<string>

获取指定的智能语音参数，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).getParameter('key').then((data: string) => {
    let param: string = data;
    console.info(`Succeeded in getting parameter, param:${param}`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to get parameter, Code:${err.code}, message:${err.message}`);
  });
}

release

release(callback: AsyncCallback<void>): void

释放注册智能语音引擎，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).release((err: BusinessError) => {
    if (err) {
      console.error(`Failed to release enrollIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in releasing enrollIntelligentVoice engine.`);
    }
  });
}

release

release(): Promise<void>

释放注册智能语音引擎，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

示例：

import { BusinessError } from '@ohos.base';

if (enrollIntelligentVoiceEngine != null) {
  (enrollIntelligentVoiceEngine as intelligentVoice.EnrollIntelligentVoiceEngine).release().then(() => {
    console.info(`Succeeded in releasing enrollIntelligentVoice engine.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to release enrollIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
  });
}

WakeupIntelligentVoiceEngine

实现唤醒智能语音引擎，通过createWakeupIntelligentVoiceEngine()获取唤醒智能语音引擎。

getSupportedRegions

getSupportedRegions(callback: AsyncCallback<Array<string>>): void

获取支持的区域，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).getSupportedRegions((err: BusinessError, data: Array<string>) => {
    if (err) {
      console.error(`Failed to get supported regions, Code:${err.code}, message:${err.message}`);
    } else {
      let regions: Array<string> = data;
      console.info(`Succeeded in getting supported regions, regions:${regions}.`);
    }
  });
}

getSupportedRegions

getSupportedRegions(): Promise<Array<string>>

获取支持的区域，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).getSupportedRegions().then((data: Array<string>) => {
    let regions: Array<string> = data;
    console.info(`Succeeded in getting supported regions, regions:${regions}.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to get supported regions, Code:${err.code}, message:${err.message}`);
  });
}

setWakeupHapInfo

setWakeupHapInfo(info: WakeupHapInfo, callback: AsyncCallback<void>): void

设置唤醒应用的hap信息，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let hapInfo: intelligentVoice.WakeupHapInfo = {
  bundleName: 'com.wakeup',
  abilityName: 'WakeUpExtAbility',
}

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).setWakeupHapInfo(hapInfo, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to set wakeup hap info, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in setting wakeup hap info.`);
    }
  });
}

setWakeupHapInfo

setWakeupHapInfo(info: WakeupHapInfo): Promise<void>

设置唤醒应用的hap信息，使用promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

let hapInfo: intelligentVoice.WakeupHapInfo = {
  bundleName: 'com.wakeup',
  abilityName: 'WakeUpExtAbility',
}
if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).setWakeupHapInfo(hapInfo).then(() => {
    console.info(`Succeeded in setting wakeup hap info.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to set wakeup hap info, Code:${err.code}, message:${err.message}`);
  });
}

setSensibility

setSensibility(sensibility: SensibilityType, callback: AsyncCallback<void>): void

设置唤醒灵敏度，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to set sensibility, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in setting sensibility.`);
    }
  });
}

setSensibility

setSensibility(sensibility: SensibilityType): Promise<void>

设置唤醒灵敏度，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY).then(() => {
    console.info(`Succeeded in setting sensibility.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to set sensibility, Code:${err.code}, message:${err.message}`);
  });
}

setParameter

setParameter(key: string, value: string, callback: AsyncCallback<void>): void

设置指定的智能语音参数，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).setParameter('scene', '0', (err: BusinessError) => {
    if (err) {
      console.error(`Failed to set parameter, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in setting parameter`);
    }
  });
}

setParameter

setParameter(key: string, value: string): Promise<void>

设置指定的智能语音参数，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).setParameter('scene', '0').then(() => {
    console.info(`Succeeded in setting parameter`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to set parameter, Code:${err.code}, message:${err.message}`);
  });
}

getParameter

getParameter(key: string, callback: AsyncCallback<string>): void

获取指定的智能语音参数，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).getParameter('key', (err: BusinessError, data: string) => {
    if (err) {
      console.error(`Failed to get parameter, Code:${err.code}, message:${err.message}`);
    } else {
      let param: string = data;
      console.info(`Succeeded in getting parameter, param:${param}`);
    }
  });
}

getParameter

getParameter(key: string): Promise<string>

获取指定的智能语音参数，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见智能语音错误码。

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).getParameter('key').then((data: string) => {
    let param: string = data;
    console.info(`Succeeded in getting parameter, param:${param}`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to get parameter, Code:${err.code}, message:${err.message}`);
  });
}

release

release(callback: AsyncCallback<void>): void

释放唤醒智能语音引擎，使用callback异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).release((err: BusinessError) => {
    if (err) {
      console.error(`Failed to release wakeupIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
    } else {
      console.info(`Succeeded in releasing wakeupIntelligentVoice engine.`);
    }
  });
}

release

release(): Promise<void>

释放唤醒智能语音引擎，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

返回值：

示例：

import { BusinessError } from '@ohos.base';

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).release().then(() => {
    console.info(`Succeeded in releasing wakeupIntelligentVoice engine.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to release wakeupIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
  });
}

on

on(type: 'wakeupIntelligentVoiceEvent', callback: Callback<WakeupIntelligentVoiceEngineCallbackInfo>): void

订阅唤醒事件。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

示例：

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).on('wakeupIntelligentVoiceEvent',
    (info: intelligentVoice.WakeupIntelligentVoiceEngineCallbackInfo) => {
    let callbackInfo: intelligentVoice.WakeupIntelligentVoiceEngineCallbackInfo = info;
    console.info(`wakeup intelligentvoice event, info:${callbackInfo}`);
  });
}

off

off(type: 'wakeupIntelligentVoiceEvent', callback?: Callback<WakeupIntelligentVoiceEngineCallbackInfo>): void;

取消订阅唤醒事件。

需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE

系统能力： SystemCapability.AI.IntelligentVoice.Core

参数：

示例：

if (wakeupIntelligentVoiceEngine != null) {
  (wakeupIntelligentVoiceEngine as intelligentVoice.WakeupIntelligentVoiceEngine).off('wakeupIntelligentVoiceEvent');
}