From 32d4a157e110f4df7a50f0ca2586393e4e954b8f Mon Sep 17 00:00:00 2001 From: wangzx0705 Date: Thu, 20 Jul 2023 05:36:17 +0000 Subject: [PATCH] fix for error code and some api doc problem Signed-off-by: wangzx0705 --- .../reference/apis/js-apis-audio.md | 42 +++++++++---------- 1 file changed, 19 insertions(+), 23 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-audio.md b/zh-cn/application-dev/reference/apis/js-apis-audio.md index edeb6d8a90..8d3ee397da 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-audio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-audio.md @@ -839,8 +839,8 @@ async function createTonePlayerBefore(){ | 名称 | 值 | 说明 | | :--------------------- | :----- | :-------------------------------------------- | -| VOLUME_UP | 0 | 向上调节音量。 | -| VOLUME_DOWN | 1 | 向下调节音量。 | +| VOLUME_UP | 0 | 向上调节音量。
此接口为系统接口。 | +| VOLUME_DOWN | 1 | 向下调节音量。
此接口为系统接口。 | ## AudioManager @@ -3031,8 +3031,8 @@ adjustVolumeByStep(adjustType: VolumeAdjustType, callback: AsyncCallback<void | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | Invalid parameter error | -| 6800301 | System error | +| 6800101 | Invalid parameter error. Return by callback. | +| 6800301 | System error. Return by callback. | **示例：** @@ -3078,8 +3078,8 @@ adjustVolumeByStep(adjustType: VolumeAdjustType): Promise<void> | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | Invalid parameter error | -| 6800301 | System error | +| 6800101 | Invalid parameter error. Return by promise. | +| 6800301 | System error. Return by promise. | **示例：** @@ -3119,8 +3119,8 @@ adjustSystemVolumeByStep(volumeType: AudioVolumeType, adjustType: VolumeAdjustTy | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | Invalid parameter error | -| 6800301 | System error | +| 6800101 | Invalid parameter error. Return by callback. | +| 6800301 | System error. Return by callback. | **示例：** @@ -3166,8 +3166,8 @@ adjustSystemVolumeByStep(volumeType: AudioVolumeType, adjustType: VolumeAdjustTy | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | Invalid parameter error | -| 6800301 | System error | +| 6800101 | Invalid parameter error. Return by promise. | +| 6800301 | System error. Return by promise. | **示例：** @@ -3185,8 +3185,6 @@ getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: De 获取音量增益dB值，使用callback方式异步返回结果。 -**系统接口：** 该接口为系统接口 - **系统能力：** SystemCapability.Multimedia.Audio.Volume **参数：** @@ -3204,8 +3202,8 @@ getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: De | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | Invalid parameter error | -| 6800301 | System error | +| 6800101 | Invalid parameter error. Return by callback. | +| 6800301 | System error. Return by callback. | **示例：** @@ -3224,8 +3222,6 @@ getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: De 获取音量增益dB值，使用Promise方式异步返回结果。 -**系统接口：** 该接口为系统接口 - **系统能力：** SystemCapability.Multimedia.Audio.Volume **参数：** @@ -3248,8 +3244,8 @@ getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: De | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | Invalid parameter error | -| 6800301 | System error | +| 6800101 | Invalid parameter error. Return by promise. | +| 6800301 | System error. Return by promise. | **示例：** @@ -5962,7 +5958,7 @@ audioRenderer.on('stateChange', (state) => { ### on('outputDeviceChange') 10+ -on(type: 'outputDeviceChange', callback: Callback): void +on(type: 'outputDeviceChange', callback: Callback\): void; 订阅监听音频输出设备变化。 @@ -5979,7 +5975,7 @@ on(type: 'outputDeviceChange', callback: Callback): voi | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | if input parameter value error | +| 6800101 | if input parameter value error. | **示例：** @@ -5994,7 +5990,7 @@ audioRenderer.on('outputDeviceChange', (deviceChangeInfo) => { ``` ### off('outputDeviceChange') 10+ -off(type: 'outputDeviceChange', callback?: Callback): void +off(type: 'outputDeviceChange', callback?: Callback\): void; 取消订阅监听音频输出设备变化。 @@ -6005,13 +6001,13 @@ off(type: 'outputDeviceChange', callback?: Callback): v | 参数名 | 类型 | 必填 | 说明 | | :------- | :------------------------- | :--- | :------------------------------------------ | | type | string | 是 | 事件回调类型，支持的事件为：'outputDeviceChange'。 | -| callback | Callback\<[AudioDeviceDescriptors](#audiodevicedescriptors)> | 是 | 取消监听的音频设备变化。 | +| callback | Callback\<[AudioDeviceDescriptors](#audiodevicedescriptors)> | 否 | 取消监听的音频设备变化。 | **错误码：** | 错误码ID | 错误信息 | | ------- | --------------------------------------------| -| 6800101 | if input parameter value error | +| 6800101 | if input parameter value error. | **示例：** -- GitLab