diff --git a/zh-cn/application-dev/media/audio-management.md b/zh-cn/application-dev/media/audio-management.md index 8e084efb8116238ae125bd09e231b304420b03e1..380e6639d9226693a8c2816ce05ebd88f86c619d 100644 --- a/zh-cn/application-dev/media/audio-management.md +++ b/zh-cn/application-dev/media/audio-management.md @@ -18,62 +18,82 @@ | DeviceFlag | 表示可获取的设备种类的枚举。 | | DeviceRole | 表示设备角色的枚举。 | | DeviceType | 表示设备类型的枚举。 | +| AudioScene | 表示音频场景的枚举。 | **表2** 音频管理相关的interface **AudioManager** -| 接口名 | 描述 | +| 接口名 | 描述 | | -------- | -------- | -| setVolume(audioType: AudioVolumeType,volume: number,callback: AsyncCallback<void>): void | 改变某个流的音量。 | -| setVolume(audioType: AudioVolumeType,volume: number): Promise<void> | 改变某个流的音量。 | -| getVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的音量。 | -| getVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的音量。 | -| getMinVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的最小音量。 | -| getMinVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的最小音量。 | -| getMaxVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的最大音量。 | -| getMaxVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的最大音量。 | -| getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors>): void | 获得设备列表。 | -| getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors> | 获得设备列表。 | +| setVolume(audioType: AudioVolumeType,volume: number,callback: AsyncCallback<void>): void | 改变某个流的音量。 | +| setVolume(audioType: AudioVolumeType,volume: number): Promise<void> | 改变某个流的音量。 | +| getVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的音量。 | +| getVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的音量。 | +| getMinVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的最小音量。 | +| getMinVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的最小音量。 | +| getMaxVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的最大音量。 | +| getMaxVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的最大音量。 | +| getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors>): void | 获得设备列表。 | +| getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors> | 获得设备列表。 | +| setDeviceActive(deviceType: ActiveDeviceType, active: boolean, callback: AsyncCallback): void | 激活设备，使用callback返回异步结果 | +| setDeviceActive(deviceType: ActiveDeviceType, active: boolean): Promise | 激活设备，使用Promise返回异步结果。 | +| isDeviceActive(deviceType: ActiveDeviceType, callback: AsyncCallback): void | 检查设备是否激活，使用callback返回异步结果。 | +| isDeviceActive(deviceType: ActiveDeviceType): Promise | 检查设备是否激活，使用Promise返回异步结果。 | +| on(type: 'deviceChange', callback: AsyncCallback): void | 订阅设备更改事件。 当设备连接或断开时，注册的客户端将收到回调。 | +| setAudioScene(scene: AudioScene, callback: AsyncCallback): void | 设置音频场景模式，使用callback返回异步结果。 | +| setAudioScene(scene: AudioScene): Promise | 设置音频场景模式，使用Promise返回异步结果。 | +| getAudioScene(callback: AsyncCallback): void | 获取音频场景模式，使用callback返回异步结果。 | +| getAudioScene(): Promise | 获取音频场景模式，使用Promise返回异步结果。 | **表3** 表示音频设备的interface **AudioDeviceDescriptor** -| 属性 | 描述 | +| 属性 | 描述 | | -------- | -------- | -| deviceRole: DeviceRole | 设备角色。 | -| deviceType: DeviceType | 设备类型。 | +| deviceRole: DeviceRole | 设备角色。 | +| deviceType: DeviceType | 设备类型。 | **表4** 表示音频流类型的枚举**AudioVolumeType** -| 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| MEDIA = 1 | 媒体声音。 | -| RINGTONE = 2 | 铃声。 | +| VOICE_CALL = 0 | 语音通话。 | +| MEDIA = 1 | 媒体声音。 | +| RINGTONE = 2 | 铃声。 | +| VOICE_ASSISTANT = 9 | 语音助手。 | **表5** 表示可获取的设备种类的枚举**DeviceFlag** -| 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| OUTPUT_DEVICES_FLAG = 1 | 输出设备。 | -| INPUT_DEVICES_FLAG = 2 | 输入设备。 | -| ALL_DEVICES_FLAG = 3 | 所有设备。 | +| OUTPUT_DEVICES_FLAG = 1 | 输出设备。 | +| INPUT_DEVICES_FLAG = 2 | 输入设备。 | +| ALL_DEVICES_FLAG = 3 | 所有设备。 | **表6** 表示设备角色的枚举**DeviceRole** -| 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| INPUT_DEVICE = 1 | 输入设备。 | -| OUTPUT_DEVICE = 2 | 输出设备。 | +| INPUT_DEVICE = 1 | 输入设备。 | +| OUTPUT_DEVICE = 2 | 输出设备。 | **表7** 表示设备类型的枚举**DeviceType** -| 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| INVALID = 0 | 无效。 | -| SPEAKER = 1 | 扬声器。 | -| WIRED_HEADSET = 2 | 有线耳机。 | -| BLUETOOTH_SCO = 3 | 蓝牙设备。 | -| BLUETOOTH_A2DP = 4 | 支持A2DP的蓝牙设备。 | -| MIC = 5 | 麦克风。 | - +| INVALID = 0 | 无效。 | +| SPEAKER = 2 | 扬声器。 | +| WIRED_HEADSET = 3 | 有线耳机。 | +| BLUETOOTH_SCO = 7 | 蓝牙设备。 | +| BLUETOOTH_A2DP = 8 | 支持A2DP的蓝牙设备。 | +| MIC = 15 | 麦克风。 | + +**表8** 表示音频模式的枚举** **AudioScene ** + +| Name | Description | +| :------------------------- | :----------------------- | +| AUDIO_SCENE_DEFAULT = 0 | 默认的音频。
| +| AUDIO_SCENE_RINGING = 1 | 响铃音频场景。
| +| AUDIO_SCENE_PHONE_CALL = 2 | 电话音频场景。
| +| AUDIO_SCENE_VOICE_CHAT = 3 | 语音聊天音频场景。
| ## 开发步骤 @@ -92,3 +112,27 @@ console.log(`Media getVolume ${value}`); }); ``` + +## 使用方法 + +**setAudioScene** + +**示例** + +1. 获取音频管理器。 + + ``` + const audioManager = audio.getAudioManager(); + ``` + +2. 获取当前的音频场景。 + + ``` + audioManager.getAudioScene((err, value) => { + if (err) { + console.error('Failed to obtain the audio scene mode.​ ${err.message}'); + return; + } + console.log('Audio scene mode ${value)'); + }) + ``` \ No newline at end of file