# @ohos.ai.intelligentVoice (Intelligent Voice)

The **intelligentVoice** module provides the intelligent voice enrollment and voice wakeup functions.

Its functions are implemented by:

- [IntelligentVoiceManager](#intelligentvoicemanager): intelligent voice manager class, which declares the functions provided by the module. Currently, voice enrollment and voice wakeup are supported. Before developing intelligent voice functions, call [getIntelligentVoiceManager()](#intelligentvoicegetintelligentvoicemanager) to check whether they are supported.
- [EnrollIntelligentVoiceEngine](#enrollintelligentvoiceengine): class that implements voice enrollment. You need to perform voice enrollment before using voice wakeup.
- [WakeupIntelligentVoiceEngine](#wakeupintelligentvoiceengine): class that implements voice wakeup. You need to perform voice enrollment before using voice wakeup.

> **NOTE**
>
> - The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
> - The APIs provided by this module are system APIs.

## Modules to Import
```js
import intelligentVoice from '@ohos.ai.intelligentVoice';
```

## intelligentVoice.getIntelligentVoiceManager

getIntelligentVoiceManager(): IntelligentVoiceManager

Obtains an instance of the intelligent voice manager.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                         | Description        |
| ----------------------------- | ------------ |
| [IntelligentVoiceManager](#intelligentvoicemanager)| Instance of the intelligent voice manager.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700101 | No memory.                              |

**Example**

```js
var intelligentVoiceManager = null;
try {
    intelligentVoiceManager = intelligentVoice.getIntelligentVoiceManager();
} catch (err) {
    console.error('Get IntelligentVoiceManager failed. Code:${err.code}, message:${err.message}');
}
```

## intelligentVoice.createEnrollIntelligentVoiceEngine

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

Creates an instance of the intelligent voice enrollment engine. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name  | Type                               | Mandatory| Description                  |
| -------- | ----------------------------------- | ---- | ---------------------- |
| descriptor    | [EnrollIntelligentVoiceEngineDescriptor](#enrollintelligentvoiceenginedescriptor)                              | Yes  | Descriptor of the intelligent voice enrollment engine.  |
| callback    | AsyncCallback\<[EnrollIntelligentVoiceEngine](#enrollintelligentvoiceengine)\>         | Yes  | Callback used to return the result.  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700101 | No memory.                           |
| 22700102 | Input parameter value error.                            |

**Example**

```js
let engineDescriptor = {
  wakeupPhrase:'Xiaohua Xiaohua',
}
var enrollIntelligentVoiceEngine = null;
intelligentVoice.createEnrollIntelligentVoiceEngine(engineDescriptor, (err, data) => {
  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&lt;EnrollIntelligentVoiceEngine&gt;


Creates an instance of the intelligent voice enrollment engine. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name  | Type                               | Mandatory| Description                  |
| -------- | ----------------------------------- | ---- | ---------------------- |
| descriptor    | [EnrollIntelligentVoiceEngineDescriptor](#enrollintelligentvoiceenginedescriptor)                              | Yes  | Descriptor of the intelligent voice enrollment engine.  |

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
| Promise\<[EnrollIntelligentVoiceEngine](#enrollintelligentvoiceengine)\>           | Promise used to return the result.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700101 | No memory.                           |
| 22700102 | Input parameter value error.                            |

**Example**

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

## intelligentVoice.createWakeupIntelligentVoiceEngine

createWakeupIntelligentVoiceEngine(descriptor: WakeupIntelligentVoiceEngineDescriptor, callback: AsyncCallback&lt;WakeupIntelligentVoiceEngine&gt;): void


Creates an instance of the intelligent voice wakeup engine. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name  | Type                               | Mandatory| Description                  |
| -------- | ----------------------------------- | ---- | ---------------------- |
| descriptor    | [WakeupIntelligentVoiceEngineDescriptor](#wakeupintelligentvoiceenginedescriptor)                              | Yes  | Descriptor of the intelligent voice wakeup engine.  |
| callback    | AsyncCallback\<[WakeupIntelligentVoiceEngine](#wakeupintelligentvoiceengine)\>         | Yes  | Callback used to return the result.  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700101 | No memory.                           |
| 22700102 | Input parameter value error.                            |

**Example**

```js
let engineDescriptor = {
  needReconfirm: true,
  wakeupPhrase:'Xiaohua Xiaohua',
}
var wakeupIntelligentVoiceEngine = null;
intelligentVoice.createWakeupIntelligentVoiceEngine(engineDescriptor, (err, data) => {
  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&lt;WakeupIntelligentVoiceEngine&gt;

Creates an instance of the intelligent voice wakeup engine. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name  | Type                               | Mandatory| Description                  |
| -------- | ----------------------------------- | ---- | ---------------------- |
| descriptor    | [WakeupIntelligentVoiceEngineDescriptor](#wakeupintelligentvoiceenginedescriptor)                              | Yes  | Descriptor of the intelligent voice wakeup engine.  |

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
| Promise\<[WakeupIntelligentVoiceEngine](#wakeupintelligentvoiceengine)>           | Promise used to return the result.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700101 | No memory.                           |
| 22700102 | Input parameter value error.                            |

**Example**

```js
let engineDescriptor = {
  needReconfirm: true,
  wakeupPhrase:'Xiaohua Xiaohua',
}
var wakeupIntelligentVoiceEngine = null;
intelligentVoice.createWakeupIntelligentVoiceEngine(engineDescriptor).then((data) => {
  wakeupIntelligentVoiceEngine = data;
  console.info('Succeeded in creating wakeupIntelligentVoice engine.');
}).catch((err) => {
  console.error('Failed to create wakeupIntelligentVoice engine, Code:${err.code}, message:${err.message});
});
```

## IntelligentVoiceManager

Class that implements intelligent voice management. Before use, you need to call [getIntelligentVoiceManager()](#intelligentvoicegetintelligentvoicemanager) to obtain an **IntelligentVoiceManager** object.

### getCapabilityInfo

getCapabilityInfo(): Array&lt;IntelligentVoiceEngineType&gt;

Obtains the list of supported intelligent voice engine types.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Array\<[IntelligentVoiceEngineType](#intelligentvoiceenginetype)\>            | Array of supported intelligent voice engine types.             |

**Example**

```js
let info = intelligentVoiceManager.getCapabilityInfo();
```

### on('serviceChange')

on(type: 'serviceChange', callback: Callback&lt;ServiceChangeType&gt;): void

Subscribes to service change events. A callback is invoked when the status of the intelligent voice service changes.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| type     | string                           | Yes  | Event type. This field has a fixed value of **serviceChange**.|
| callback | Callback\<[ServiceChangeType](#servicechangetype)\> | Yes  | Callback for the service status change.|

**Example**

```js
intelligentVoiceManager.on('serviceChange', (serviceChangeType) => {});
```

### off('serviceChange')

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

Unsubscribes from service change events.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| type     | string                           | Yes  | Event type. This field has a fixed value of **serviceChange**.|
| callback | Callback\<[ServiceChangeType](#servicechangetype)\> | No  | Callback for processing of the service status change event. If this parameter is specified, only the specified callback will be unsubscribed. Otherwise, all callbacks will be unsubscribed. |

**Example**

```js
intelligentVoiceManager.off('serviceChange');
```

## ServiceChangeType

Enumerates service status change types.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name                      | Value  | Description           |
| ------------------------- | ---- | ------------    |
| SERVICE_UNAVAILABLE      | 0    | The service is unavailable.  |

## IntelligentVoiceEngineType

Enumerates intelligent voice engine types.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name                      | Value  | Description           |
| ------------------------- | ---- | ------------    |
| ENROLL_ENGINE_TYPE      | 0    | Voice enrollment engine.  |
| WAKEUP_ENGINE_TYPE      | 1    | Voice wakeup engine.  |
| UPDATE_ENGINE_TYPE      | 2    | Silent update engine.  |

## EnrollIntelligentVoiceEngineDescriptor

Defines the descriptor of an intelligent voice enrollment engine.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name  | Type                           |     Mandatory    | Description      |
| ------ | ----------------------------- | -------------- | ---------- |
| wakeupPhrase | string |        Yes      | Wakeup phrase.|

## WakeupIntelligentVoiceEngineDescriptor

Defines the descriptor of an intelligent voice wakeup engine.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name  | Type                           |     Mandatory    | Description      |
| ------ | ----------------------------- | -------------- | ---------- |
| needReconfirm | boolean |        Yes      | Whether re-confirmation of the wakeup result is needed. The value **true** indicates that re-confirmation is needed, and the value **false** indicates the opposite.|
| wakeupPhrase | string |        Yes      | Wakeup phrase.|

## EnrollEngineConfig

Defines the enrollment engine configuration.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name  | Type                           |     Mandatory    | Description      |
| ------ | ----------------------------- | -------------- | ---------- |
| language | string |        Yes      | Language supported by the enrollment engine. Only Chinese is supported currently, and the value is **zh**.|
| region | string |        Yes      | Country/region supported by the enrollment engine. Only China is supported currently, and the value is **CN**.|

## SensibilityType

Enumerates wakeup sensibility types.
A sensibility type maps to a wakeup threshold. A higher sensibility indicates a lower threshold and a higher wakeup probability.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name                      | Value  | Description           |
| ------------------------- | ---- | ------------    |
| LOW_SENSIBILITY      | 1    | Low sensibility.  |
| MIDDLE_SENSIBILITY      | 2    | Medium sensibility.  |
| HIGH_SENSIBILITY      | 3    | High sensibility.  |

## WakeupHapInfo

Defines the HAP information for an wakeup application.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name  | Type                           |     Mandatory    | Description      |
| ------ | ----------------------------- | -------------- | ---------- |
| bundleName | string |        Yes      | Bundle name of the wakeup application.|
| abilityName | string |        Yes      | Ability name of the wakeup application.|

## WakeupIntelligentVoiceEventType

Enumerates types of intelligent voice wakeup events.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name                      | Value  | Description           |
| ------------------------- | ---- | ------------    |
| INTELLIGENT_VOICE_EVENT_WAKEUP_NONE      | 0    | No wakeup.  |
| INTELLIGENT_VOICE_EVENT_RECOGNIZE_COMPLETE      | 1    | Wakeup recognition completed.  |

## IntelligentVoiceErrorCode

Enumerates error codes of intelligent voice wakeup.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name                      | Value  | Description           |
| ------------------------- | ---- | ------------    |
| INTELLIGENT_VOICE_NO_MEMORY      | 22700101    | Insufficient memory.  |
| INTELLIGENT_VOICE_INVALID_PARAM      | 22700102    | Invalid parameter. |
| INTELLIGENT_VOICE_INIT_FAILED      | 22700103    | Enrollment failed.  |
| INTELLIGENT_VOICE_COMMIT_ENROLL_FAILED      | 22700104    | Enrollment commit failed.  |

## EnrollResult

Enumerates enrollment results.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name                      | Value  | Description           |
| ------------------------- | ---- | ------------    |
| SUCCESS      | 0    | Enrollment succeeded.  |
| VPR_TRAIN_FAILED      | -1    | Voiceprint training failed. |
| WAKEUP_PHRASE_NOT_MATCH      | -2    | Wakeup phrase mismatched.  |
| TOO_NOISY      | -3    | Environment too noisy.  |
| TOO_LOUD      | -4    | Voice too loud.  |
| INTERVAL_LARGE      | -5    | Interval between wakeup phrases too long.  |
| DIFFERENT_PERSON      | -6    | Wakeup phrases enrolled by different persons.  |
| UNKNOWN_ERROR      | -100    | Unknown error.  |

## EnrollCallbackInfo

Defines the enrollment callback information.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name  | Type                           |     Mandatory    | Description      |
| ------ | ----------------------------- | -------------- | ---------- |
| result | [EnrollResult](#enrollresult) |        Yes      | Enrollment result.|
| context | string |        Yes      | Context of the enrollment event.|

## WakeupIntelligentVoiceEngineCallbackInfo

Defines the callback information for the intelligent voice wakeup engine.

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name  | Type                           |     Mandatory    | Description      |
| ------ | ----------------------------- | -------------- | ---------- |
| eventId | [WakeupIntelligentVoiceEventType](#wakeupintelligentvoiceeventtype) |        Yes      | Event type of the intelligent voice wakeup engine.|
| isSuccess | boolean |        Yes      | Wakeup result. The value **true** indicates that the wakeup is successful, and the value **false** indicates the opposite.|
| context | string |        Yes      | Context of the wakeup event.|

## EnrollIntelligentVoiceEngine

Class that implements the intelligent voice enrollment engine. Before use, you need to call [createEnrollIntelligentVoiceEngine()](#intelligentvoicecreateenrollintelligentvoiceengine) to obtain an instance of the intelligent voice enrollment engine.

### getSupportedRegions

getSupportedRegions(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void

Obtains the list of supported countries/regions. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| callback     | AsyncCallback&lt;Array&lt;string&gt;&gt;         | Yes  | Callback used to return the result, which is an array of supported countries/regions. Only China is supported currently, and the value is **CN**.|

**Example**

```js
let regions = null;
enrollIntelligentVoiceEngine.getSupportedRegions((err, data) => {
  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&lt;Array&lt;string&gt;&gt;

Obtains the list of supported countries/regions. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;Array&lt;string&gt;&gt;            | Promise used to return the result, which is an array of supported countries/regions. Only China is supported currently, and the value is **CN**.                  |

**Example**

```js
let regions = null;
enrollIntelligentVoiceEngine.getSupportedRegions().then((data) => {
  regions = data;
  console.info('Succeeded in getting supported regions, regions:${regions}.');
}).catch((err) => {
  console.error(`Failed to get supported regions, Code:${err.code}, message:${err.message}`);
});
```

### init

init(config: EnrollEngineConfig, callback: AsyncCallback&lt;void&gt;): void

Initializes the intelligent voice enrollment engine. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| config     | [EnrollEngineConfig](#enrollengineconfig)                           | Yes  | Configuration of the intelligent voice enrollment engine.|
| callback     |AsyncCallback&lt;void&gt;                           | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |
| 22700103 | Init failed.                           |

**Example**

```js
let config = {
  language: "zh",
  area: "CN",
}
enrollIntelligentVoiceEngine.init(config, (err) => {
  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&lt;void&gt;

Initializes the intelligent voice enrollment engine. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| config     | [EnrollEngineConfig](#enrollengineconfig)                           | Yes  | Configuration of the intelligent voice enrollment engine.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;           | Promise that returns no value.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |
| 22700103 | Init failed.                           |

**Example**

```js
let config = {
  language: "zh",
  area: "CN",
}
enrollIntelligentVoiceEngine.init(config).then(() => {
  console.info('Succeeded in initializing enrollIntelligentVoice engine.');
}).catch((err) => {
  console.error(`Failed to initialize enrollIntelligentVoice engine. Code:${err.code}, message:${err.message}`);
});
```

### enrollForResult

enrollForResult(isLast: boolean, callback: AsyncCallback&lt;EnrollCallbackInfo&gt;): void

Obtains the enrollment result. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| isLast     | boolean                           | Yes  | Whether this is the last enrollment. The value **value** indicates the last enrollment, and the value **false** indicates the opposite.|
| callback     | AsyncCallback&lt;[EnrollCallbackInfo](#enrollcallbackinfo)&gt;                           | Yes  | Callback used to return the result.|

**Example**

```js
let isLast = true;
let callbackInfo = null;
enrollIntelligentVoiceEngine.enrollForResult(isLast, (err, data) => {
  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&lt;EnrollCallbackInfo&gt;

Obtains the enrollment result. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| isLast     | boolean                           | Yes  | Whether this is the last enrollment. The value **value** indicates the last enrollment, and the value **false** indicates the opposite.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;[EnrollCallbackInfo](#enrollcallbackinfo)&gt;            | Promise used to return the result.                  |

**Example**

```js
let isLast = true;
let callbackInfo = null;
enrollIntelligentVoiceEngine.enrollForResult(isLast).then((data) => {
  callbackInfo = data;
  console.info('Succeeded in enrolling for result, info:${callbackInfo}.');
}).catch((err) => {
  console.error(`Failed to enroll for result, Code:${err.code}, message:${err.message}`);
});
```

### stop

stop(callback: AsyncCallback&lt;void&gt;): void

Stops the enrollment. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| callback     |  AsyncCallback&lt;void&gt;                           | Yes  | Callback used to return the result.|

**Example**

```js
enrollIntelligentVoiceEngine.stop((err) => {
  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&lt;void&gt;

Stops the enrollment. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                  |

**Example**

```js
enrollIntelligentVoiceEngine.stop().then(() => {
  console.info('Succeeded in stopping enrollIntelligentVoice engine.');
}).catch((err) => {
  console.error(`Failed to stop enrollIntelligentVoice engine, Code:${err.code}, message:${err.message}`);
});
```

### commit

commit(callback: AsyncCallback&lt;void&gt;): void

Commits the enrollment. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| callback     | AsyncCallback&lt;void&gt;                           | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700104 | Commit enroll failed.                           |

**Example**

```js
enrollIntelligentVoiceEngine.commit((err) => {
  if (err) {
    console.error(`Failed to commit enroll, Code:${err.code}, message:${err.message}`);
  } else {
    console.info('Succeeded in committing enroll.');
  }
});
```

### commit

commit(): Promise&lt;void&gt;

Commits the enrollment. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;           | Promise that returns no value.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700104 | Commit enroll failed.                           |

**Example**

```js
enrollIntelligentVoiceEngine.commit().then(() => {
  console.info('Succeeded in committing enroll.');
}).catch((err) => {
  console.error(`Failed to commit enroll, Code:${err.code}, message:${err.message}`);
});
```

### setWakeupHapInfo

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

Sets the HAP information for the wakeup application. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| info     | [WakeupHapInfo](#wakeuphapinfo)                           | Yes  | HAP information for the wakeup application.|
| callback     | AsyncCallback\<void\>                          | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
let info = {
  bundleName: "com.wakeup",
  abilityName: "WakeUpExtAbility",
}
enrollIntelligentVoiceEngine.setWakeupHapInfo(info, (err) => {
  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\>

Sets the HAP information for the wakeup application. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
let info = {
  bundleName: "com.wakeup",
  abilityName: "WakeUpExtAbility",
}
enrollIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => {
  console.info('Succeeded in setting wakeup hap info.');
}).catch((err) => {
  console.error('Failed to set wakeup hap info, Code:${err.code},
});
```

### setSensibility

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

Sets the wakeup sensibility. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| sensibility     | [SensibilityType](#sensibilitytype)                           | Yes  | Sensibility type.|
| callback     | AsyncCallback\<void\>                         | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
enrollIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY, (err) => {
  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\>

Sets the wakeup sensibility. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| sensibility     | [SensibilityType](#sensibilitytype)                           | Yes  | Sensibility type.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

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

### setParameter

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

Sets specified intelligent voice parameters. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| key     | string                           | Yes  | Key.|
| value     | string                           | Yes  | Value.|
| callback     | AsyncCallback\<void\>                           | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
enrollIntelligentVoiceEngine.setParameter('scene', '0', (err) => {
  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\>

Sets specified intelligent voice parameters. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| key     | string                           | Yes  | Key.|
| value     | string                           | Yes  | Value.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

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

### getParameter

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

Obtains specified intelligent voice parameters. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| key     | string                           | Yes  | Key.|
| callback     | AsyncCallback\<string\>                           | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

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

### getParameter

getParameter(key: string): Promise\<string\>

Obtains specified intelligent voice parameters. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| key     | string                           | Yes  | Key.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise\<string\>            | Promise used to return the result.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

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

### release

release(callback: AsyncCallback&lt;void&gt;): void

Releases the intelligent voice enrollment engine. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| callback     | AsyncCallback\<void\>                           | Yes  | Callback used to return the result.|

**Example**

```js
enrollIntelligentVoiceEngine.release((err) => {
  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&lt;void&gt;

Releases the intelligent voice enrollment engine. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                 |

**Example**

```js
enrollIntelligentVoiceEngine.release().then(() => {
  console.info('Succeeded in releasing enrollIntelligentVoice engine.');
}).catch((err) => {
  console.error('Failed to release enrollIntelligentVoice engine, Code:${err.code}, message:${err.message}');
});
```

## WakeupIntelligentVoiceEngine

Class that implements the intelligent voice wakeup engine. Before use, you need to call [createWakeupIntelligentVoiceEngine()](#intelligentvoicecreatewakeupintelligentvoiceengine) to obtain an instance of the intelligent voice wakeup engine.

### getSupportedRegions

getSupportedRegions(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void

Obtains the list of supported countries/regions. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| callback     | AsyncCallback&lt;Array&lt;string&gt;&gt;                           | Yes  | Callback used to return the result, which is an array of supported countries/regions. Only China is supported currently, and the value is **CN**.|

**Example**

```js
let regions = null;
wakeupIntelligentVoiceEngine.getSupportedRegions((err, data) => {
  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&lt;Array&lt;string&gt;&gt;

Obtains the list of supported countries/regions. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;Array&lt;string&gt;&gt;            | Promise used to return the result, which is an array of supported countries/regions. Only China is supported currently, and the value is **CN**.                  |

**Example**

```js
let regions = null;
wakeupIntelligentVoiceEngine.getSupportedRegions().then((data) => {
  regions = data;
  console.info('Succeeded in getting supported regions, regions:${regions}.');
}).catch((err) => {
  console.error(`Failed to get supported regions, Code:${err.code}, message:${err.message}`);
});
```

### setWakeupHapInfo

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

Sets the HAP information for the wakeup application. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| info     | [WakeupHapInfo](#wakeuphapinfo)                           | Yes  | HAP information for the wakeup application.|
| callback     | AsyncCallback\<void\>                           | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
let info = {
  bundleName: "com.wakeup",
  abilityName: "WakeUpExtAbility",
}
wakeupIntelligentVoiceEngine.setWakeupHapInfo(info, (err) => {
  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\>

Sets the HAP information for the wakeup application. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| info     | [WakeupHapInfo](#wakeuphapinfo)                           | Yes  | HAP information for the wakeup application.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
let info = {
  bundleName: "com.wakeup",
  abilityName: "WakeUpExtAbility",
}
wakeupIntelligentVoiceEngine.setWakeupHapInfo(info).then(() => {
  console.info('Succeeded in setting wakeup hap info.');
}).catch((err) => {
  console.error('Failed to set wakeup hap info, Code:${err.code}, message:${err.message}');
});
```

### setSensibility

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

Sets the wakeup sensibility. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| sensibility     | [SensibilityType](#sensibilitytype)                           | Yes  | Sensibility type.|
| callback     | AsyncCallback\<void\>                           | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
wakeupIntelligentVoiceEngine.setSensibility(intelligentVoice.SensibilityType.LOW_SENSIBILITY, (err) => {
  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\>

Sets the wakeup sensibility. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| sensibility     | [SensibilityType](#sensibilitytype)                           | Yes  | Sensibility type.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

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

### setParameter

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

Sets specified intelligent voice parameters. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| key     | string                           | Yes  | Key.|
| value     | string                           | Yes  | Value.|
| callback     | AsyncCallback\<void\>                           | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
wakeupIntelligentVoiceEngine.setParameter('scene', '0', (err) => {
  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\>

Sets specified intelligent voice parameters. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| key     | string                           | Yes  | Key.|
| value     | string                           | Yes  | Value.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

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

### getParameter

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

Obtains specified intelligent voice parameters. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| key     | string                           | Yes  | Key.|
| callback     | AsyncCallback\<string\>                           | Yes  | Callback used to return the result.|

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

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

### getParameter

getParameter(key: string): Promise\<string\>

Obtains specified intelligent voice parameters. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| key     | string                           | Yes  | Key.|

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise\<string\>            | Promise used to return the result.                  |

**Error codes**

For details about the error codes, see [Intelligent Voice Error Codes](../errorcodes/errorcode-intelligentVoice.md).

| ID| Error Message|
| ------- | --------------------------------------------|
| 22700102 | Input parameter value error.                            |

**Example**

```js
let param;
wakeupIntelligentVoiceEngine.getParameter('key').then((data) => {
  param = data;
  console.info('Succeeded in getting parameter, param:${param}');
}).catch((err) => {
  console.error(`Failed to get parameter, Code:${err.code}, message:${err.message}`);
});
```

### release

release(callback: AsyncCallback\<void\>): void

Releases the intelligent voice wakeup engine. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| callback     | AsyncCallback\<void\>                           | Yes  | Callback used to return the result.|

**Example**

```js
wakeupIntelligentVoiceEngine.release((err) => {
  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\>

Releases the intelligent voice wakeup engine. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Return value**

| Type                                            | Description                          |
| ----------------------------------------------- | ---------------------------- |
|  Promise&lt;void&gt;            | Promise that returns no value.                  |

**Example**

```js
wakeupIntelligentVoiceEngine.release().then(() => {
  console.info('Succeeded in releasing wakeupIntelligentVoice engine.');
}).catch((err) => {
  console.error('Failed to release wakeupIntelligentVoice engine, Code:${err.code}, message:${err.message}');
});
```

### on

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

Subscribes to wakeup events.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| type     | string          | Yes  | Event type. This field has a fixed value of **wakeupIntelligentVoiceEvent**.|
| callback     | Callback\<[WakeupIntelligentVoiceEngineCallbackInfo](#wakeupintelligentvoiceenginecallbackinfo)\>                           | Yes  | Processing of the wakeup event.|

**Example**

```js
wakeupIntelligentVoiceEngine.on('wakeupIntelligentVoiceEvent', (callback) => {
  console.info(`wakeup intelligentvoice event`);
  for (let prop in callback) {
    console.info(`intelligentvoice prop: ${prop}`);
  }
});
```

### off

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

Unsubscribes from wakeup events.

**Required permissions**: ohos.permission.MANAGE_INTELLIGENT_VOICE

**System capability**: SystemCapability.AI.IntelligentVoice.Core

**Parameters**

| Name    | Type                             | Mandatory| Description                                         |
| -------- | -------------------------------- | --- | ------------------------------------------- |
| type     |string           | Yes  | Event type. This field has a fixed value of **wakeupIntelligentVoiceEvent**.|
| callback     | Callback\<[WakeupIntelligentVoiceEngineCallbackInfo](#wakeupintelligentvoiceenginecallbackinfo)\>                           | No  | Callback for processing of the wakeup event. If this parameter is specified, only the specified callback will be unsubscribed. Otherwise, all callbacks will be unsubscribed. |

**Example**

```js
wakeupIntelligentVoiceEngine.off('wakeupIntelligentVoiceEvent');
```