diff --git a/en/application-dev/js-reference/apis/js-apis-audio.md b/en/application-dev/js-reference/apis/js-apis-audio.md index abc1283676a2e42b24a2828995224317e7f7ec01..facaa2410ce43a3d3b3858097fc660fe62eb10a4 100644 --- a/en/application-dev/js-reference/apis/js-apis-audio.md +++ b/en/application-dev/js-reference/apis/js-apis-audio.md @@ -103,7 +103,7 @@ Sets the volume for a stream. This method uses an asynchronous callback to retur | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | volume | number | Yes | Volume to set. The value range can be obtained by calling **getMinVolume** and **getMaxVolume**. | | callback | AsyncCallback | Yes | Callback used to return the execution result. | @@ -131,7 +131,7 @@ Sets the volume for a stream. This method uses a promise to return the execution | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | volume | number | Yes | Volume to set. The value range can be obtained by calling **getMinVolume** and **getMaxVolume**. | **Return values** @@ -156,7 +156,7 @@ Obtains the volume of a stream. This method uses an asynchronous callback to ret | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the volume. | **Return values** @@ -183,7 +183,7 @@ Obtains the volume of a stream. This method uses a promise to return the query r | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | **Return values** @@ -207,7 +207,7 @@ Obtains the minimum volume allowed for a stream. This method uses an asynchronou | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the minimum volume. | **Return values** @@ -234,7 +234,7 @@ Obtains the minimum volume allowed for a stream. This method uses a promise to r | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | **Return values** @@ -259,7 +259,7 @@ Obtains the maximum volume allowed for a stream. This method uses an asynchronou | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the maximum volume. | **Return values** @@ -286,7 +286,7 @@ Obtains the maximum volume allowed for a stream. This method uses a promise to r | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | **Return values** @@ -311,7 +311,7 @@ Mutes a stream. This method uses an asynchronous callback to return the executio | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | mute | boolean | Yes | Mute status to set. The value **true** means to mute the stream, and **false** means the opposite. | | callback | AsyncCallback | Yes | Callback used to return the execution result. | @@ -339,7 +339,7 @@ Mutes a stream. This method uses a promise to return the execution result. | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | mute | boolean | Yes | Mute status to set. The value **true** means to mute the stream, and **false** means the opposite. | **Return values** @@ -364,7 +364,7 @@ Checks whether a stream is muted. This method uses an asynchronous callback to r | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the mute status of the stream. The value **true** means that the stream is muted, and **false** means the opposite. | **Return values** @@ -391,7 +391,7 @@ Checks whether a stream is muted. This method uses a promise to return the execu | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | **Return values** @@ -416,7 +416,7 @@ Checks whether a stream is active. This method uses an asynchronous callback to | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the active status of the stream. The value **true** means that the stream is active, and **false** means the opposite. | **Return values** @@ -443,7 +443,7 @@ Checks whether a stream is active. This method uses a promise to return the quer | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| volumeType | AudioVolumeType | Yes | Audio stream type. | +| volumeType | AudioVolumeType | Yes | Audio stream type. | **Return values** @@ -468,7 +468,7 @@ Sets the ringer mode. This method uses an asynchronous callback to return the ex | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| mode | AudioRingMode | Yes | Ringer mode. | +| mode | AudioRingMode | Yes | Ringer mode. | | callback | AsyncCallback | Yes | Callback used to return the execution result. | **Return values** @@ -495,7 +495,7 @@ Sets the ringer mode. This method uses a promise to return the execution result. | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| mode | AudioRingMode | Yes | Ringer mode. | +| mode | AudioRingMode | Yes | Ringer mode. | **Return values** @@ -520,7 +520,7 @@ Obtains the ringer mode. This method uses an asynchronous callback to return the | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| callback | AsyncCallback<AudioRingMode> | Yes | Callback used to return the ringer mode. | +| callback | AsyncCallback<AudioRingMode> | Yes | Callback used to return the ringer mode. | **Return values** @@ -550,7 +550,7 @@ None | Name | Description | | ------------- | -------------------------------------------------------- | -| Promise<AudioRingMode> | Promise used to return the ringer mode. | +| Promise<AudioRingMode> | Promise used to return the ringer mode. | **Example** @@ -672,8 +672,8 @@ Obtains the audio devices with a specific flag. This method uses an asynchronous | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| deviceFlag | DeviceFlag | Yes | Audio device flag. | -| callback | AsyncCallback<AudioDeviceDescriptors> | Yes | Callback used to return the device list. | +| deviceFlag | DeviceFlag | Yes | Audio device flag. | +| callback | AsyncCallback<AudioDeviceDescriptors> | Yes | Callback used to return the device list. | **Return values** @@ -699,13 +699,13 @@ Obtains the audio devices with a specific flag. This method uses a promise to re | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| deviceFlag | DeviceFlag | Yes | Audio device flag. | +| deviceFlag | DeviceFlag | Yes | Audio device flag. | **Return values** | Name | Description | | ------------- | -------------------------------------------------------- | -| Promise<AudioDeviceDescriptors> | Promise used to return the device list. | +| Promise<AudioDeviceDescriptors> | Promise used to return the device list. | **Example** @@ -723,7 +723,7 @@ Sets a device to the active state. This method uses an asynchronous callback to | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| deviceType | ActiveDeviceType | Yes | Audio device type. | +| deviceType | ActiveDeviceType | Yes | Audio device type. | | active | boolean | Yes | Active status to set. The value **true** means to set the device to the active status, and **false** means the opposite. | | callback | AsyncCallback | Yes | Callback used to return the execution result. | @@ -751,7 +751,7 @@ Sets a device to the active state. This method uses a promise to return the exec | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| deviceType | ActiveDeviceType | Yes | Audio device type. | +| deviceType | ActiveDeviceType | Yes | Audio device type. | | active | boolean | Yes | Active status to set. The value **true** means to set the device to the active status, and **false** means the opposite. | **Return values** @@ -776,7 +776,7 @@ Checks whether a device is active. This method uses an asynchronous callback to | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| deviceType | ActiveDeviceType | Yes | Audio device type. | +| deviceType | ActiveDeviceType | Yes | Audio device type. | | callback | AsyncCallback | Yes | Callback used to return the active status of the device. | **Return values** @@ -803,7 +803,7 @@ Checks whether a device is active. This method uses a promise to return the quer | Name | Type | Mandatory | Description | | ------------- | ------------- | ---------------|------------------------------------------------------ | -| deviceType | ActiveDeviceType | Yes | Audio device type. | +| deviceType | ActiveDeviceType | Yes | Audio device type. | **Return values** @@ -927,8 +927,8 @@ Describes an audio device. | Name | Type | Readable | Writable | Description | | ------------- | ------------- | ---------------|--------------------------------|------------------------ | -| deviceRole | DeviceRole | Yes | No | Audio device role. | -| deviceType | DeviceType | Yes | No | Audio device type. | +| deviceRole | DeviceRole | Yes | No | Audio device role. | +| deviceType | DeviceType | Yes | No | Audio device type. | ## AudioDeviceDescriptors