未验证 提交 c081b441 编写于 作者: O openharmony_ci 提交者: Gitee

!5921 增加模块描述部分,以及接口完整性、正确性问题修改

Merge pull request !5921 from 一杯丞丞汁儿/master
# 音频管理 # 音频管理
> **说明:** 音频管理提供管理音频的一些基础能力,包括对音频音量、音频设备的管理,以及对音频数据的采集和渲染等。
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该模块提供以下音频相关的常用功能: 该模块提供以下音频相关的常用功能:
...@@ -9,6 +8,9 @@ ...@@ -9,6 +8,9 @@
- [AudioRenderer](#audiorenderer8):音频渲染,用于播放PCM(Pulse Code Modulation)音频数据。 - [AudioRenderer](#audiorenderer8):音频渲染,用于播放PCM(Pulse Code Modulation)音频数据。
- [AudioCapturer](#audiocapturer8):音频采集,用于录制PCM音频数据。 - [AudioCapturer](#audiocapturer8):音频采集,用于录制PCM音频数据。
> **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```
...@@ -560,7 +562,7 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => { ...@@ -560,7 +562,7 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => {
音量改变时,应用接收的事件。 音量改变时,应用接收的事件。
此接口为系统接口,三方应用不支持。 此接口为系统接口,三方应用不支持调用
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Volume **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Volume
...@@ -635,8 +637,8 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => { ...@@ -635,8 +637,8 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => {
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| :--------------------- | :----- | :-------------------------------------------- | | :--------------------- | :----- | :-------------------------------------------- |
| AUDIO_SCENE_DEFAULT | 0 | 默认音频场景。 | | AUDIO_SCENE_DEFAULT | 0 | 默认音频场景。 |
| AUDIO_SCENE_RINGING | 1 | 响铃模式。<br/>系统接口,三方应用不支持调用。 | | AUDIO_SCENE_RINGING | 1 | 响铃模式。<br/>此接口为系统接口,三方应用不支持调用。 |
| AUDIO_SCENE_PHONE_CALL | 2 | 电话模式。<br/>系统接口,三方应用不支持调用。 | | AUDIO_SCENE_PHONE_CALL | 2 | 电话模式。<br/>此接口为系统接口,三方应用不支持调用。 |
| AUDIO_SCENE_VOICE_CHAT | 3 | 语音聊天模式。 | | AUDIO_SCENE_VOICE_CHAT | 3 | 语音聊天模式。 |
## AudioManager ## AudioManager
...@@ -649,6 +651,8 @@ setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback&l ...@@ -649,6 +651,8 @@ setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback&l
设置指定流的音量,使用callback方式异步返回结果。 设置指定流的音量,使用callback方式异步返回结果。
**需要权限:** ohos.permission.ACCESS_NOTIFICATION_POLICY
**系统能力:** SystemCapability.Multimedia.Audio.Volume **系统能力:** SystemCapability.Multimedia.Audio.Volume
**参数:** **参数:**
...@@ -677,6 +681,8 @@ setVolume(volumeType: AudioVolumeType, volume: number): Promise&lt;void&gt; ...@@ -677,6 +681,8 @@ setVolume(volumeType: AudioVolumeType, volume: number): Promise&lt;void&gt;
设置指定流的音量,使用Promise方式异步返回结果。 设置指定流的音量,使用Promise方式异步返回结果。
**需要权限:** ohos.permission.ACCESS_NOTIFICATION_POLICY
**系统能力:** SystemCapability.Multimedia.Audio.Volume **系统能力:** SystemCapability.Multimedia.Audio.Volume
**参数:** **参数:**
...@@ -1041,6 +1047,8 @@ setRingerMode(mode: AudioRingMode, callback: AsyncCallback&lt;void&gt;): void ...@@ -1041,6 +1047,8 @@ setRingerMode(mode: AudioRingMode, callback: AsyncCallback&lt;void&gt;): void
设置铃声模式,使用callback方式异步返回结果。 设置铃声模式,使用callback方式异步返回结果。
**需要权限:** ohos.permission.ACCESS_NOTIFICATION_POLICY
**系统能力:** SystemCapability.Multimedia.Audio.Communication **系统能力:** SystemCapability.Multimedia.Audio.Communication
**参数:** **参数:**
...@@ -1068,6 +1076,8 @@ setRingerMode(mode: AudioRingMode): Promise&lt;void&gt; ...@@ -1068,6 +1076,8 @@ setRingerMode(mode: AudioRingMode): Promise&lt;void&gt;
设置铃声模式,使用Promise方式异步返回结果。 设置铃声模式,使用Promise方式异步返回结果。
**需要权限:** ohos.permission.ACCESS_NOTIFICATION_POLICY
**系统能力:** SystemCapability.Multimedia.Audio.Communication **系统能力:** SystemCapability.Multimedia.Audio.Communication
**参数:** **参数:**
...@@ -1148,6 +1158,8 @@ setAudioParameter(key: string, value: string, callback: AsyncCallback&lt;void&gt ...@@ -1148,6 +1158,8 @@ setAudioParameter(key: string, value: string, callback: AsyncCallback&lt;void&gt
本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上,所支持的音频参数会存在差异。示例代码内使用样例参数,实际支持的音频配置参数见具体设备平台的资料描述。 本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上,所支持的音频参数会存在差异。示例代码内使用样例参数,实际支持的音频配置参数见具体设备平台的资料描述。
**需要权限:** ohos.permission.MODIFY_AUDIO_SETTINGS
**系统能力:** SystemCapability.Multimedia.Audio.Core **系统能力:** SystemCapability.Multimedia.Audio.Core
**参数:** **参数:**
...@@ -1178,6 +1190,8 @@ setAudioParameter(key: string, value: string): Promise&lt;void&gt; ...@@ -1178,6 +1190,8 @@ setAudioParameter(key: string, value: string): Promise&lt;void&gt;
本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上,所支持的音频参数会存在差异。示例代码内使用样例参数,实际支持的音频配置参数见具体设备平台的资料描述。 本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上,所支持的音频参数会存在差异。示例代码内使用样例参数,实际支持的音频配置参数见具体设备平台的资料描述。
**需要权限:** ohos.permission.MODIFY_AUDIO_SETTINGS
**系统能力:** SystemCapability.Multimedia.Audio.Core **系统能力:** SystemCapability.Multimedia.Audio.Core
**参数:** **参数:**
...@@ -1434,6 +1448,8 @@ setMicrophoneMute(mute: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -1434,6 +1448,8 @@ setMicrophoneMute(mute: boolean, callback: AsyncCallback&lt;void&gt;): void
设置麦克风静音状态,使用callback方式异步返回结果。 设置麦克风静音状态,使用callback方式异步返回结果。
**需要权限:** ohos.permission.MICROPHONE
**系统能力:** SystemCapability.Multimedia.Audio.Device **系统能力:** SystemCapability.Multimedia.Audio.Device
**参数:** **参数:**
...@@ -1461,6 +1477,8 @@ setMicrophoneMute(mute: boolean): Promise&lt;void&gt; ...@@ -1461,6 +1477,8 @@ setMicrophoneMute(mute: boolean): Promise&lt;void&gt;
设置麦克风静音状态,使用Promise方式异步返回结果。 设置麦克风静音状态,使用Promise方式异步返回结果。
**需要权限:** ohos.permission.MICROPHONE
**系统能力:** SystemCapability.Multimedia.Audio.Device **系统能力:** SystemCapability.Multimedia.Audio.Device
**参数:** **参数:**
...@@ -1489,6 +1507,8 @@ isMicrophoneMute(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1489,6 +1507,8 @@ isMicrophoneMute(callback: AsyncCallback&lt;boolean&gt;): void
获取麦克风静音状态,使用callback方式异步返回结果。 获取麦克风静音状态,使用callback方式异步返回结果。
**需要权限:** ohos.permission.MICROPHONE
**系统能力:** SystemCapability.Multimedia.Audio.Device **系统能力:** SystemCapability.Multimedia.Audio.Device
**参数:** **参数:**
...@@ -1515,6 +1535,8 @@ isMicrophoneMute(): Promise&lt;boolean&gt; ...@@ -1515,6 +1535,8 @@ isMicrophoneMute(): Promise&lt;boolean&gt;
获取麦克风静音状态,使用Promise方式异步返回结果。 获取麦克风静音状态,使用Promise方式异步返回结果。
**需要权限:** ohos.permission.MICROPHONE
**系统能力:** SystemCapability.Multimedia.Audio.Device **系统能力:** SystemCapability.Multimedia.Audio.Device
**返回值:** **返回值:**
...@@ -1538,7 +1560,7 @@ on(type: 'volumeChange', callback: Callback\<VolumeEvent>): void ...@@ -1538,7 +1560,7 @@ on(type: 'volumeChange', callback: Callback\<VolumeEvent>): void
监听系统音量变化事件。 监听系统音量变化事件。
此接口为系统接口,三方应用不支持。 此接口为系统接口,三方应用不支持调用
**系统能力:** SystemCapability.Multimedia.Audio.Volume **系统能力:** SystemCapability.Multimedia.Audio.Volume
...@@ -1565,7 +1587,7 @@ on(type: 'ringerModeChange', callback: Callback\<AudioRingMode>): void ...@@ -1565,7 +1587,7 @@ on(type: 'ringerModeChange', callback: Callback\<AudioRingMode>): void
监听铃声模式变化事件。 监听铃声模式变化事件。
此接口为系统接口,三方应用不支持。 此接口为系统接口,三方应用不支持调用
**系统能力:** SystemCapability.Multimedia.Audio.Communication **系统能力:** SystemCapability.Multimedia.Audio.Communication
...@@ -1590,6 +1612,8 @@ on(type: 'deviceChange', callback: Callback<DeviceChangeAction\>): void ...@@ -1590,6 +1612,8 @@ on(type: 'deviceChange', callback: Callback<DeviceChangeAction\>): void
设备更改。音频设备连接状态变化。 设备更改。音频设备连接状态变化。
此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.Multimedia.Audio.Device **系统能力:** SystemCapability.Multimedia.Audio.Device
**参数:** **参数:**
...@@ -1639,6 +1663,8 @@ on(type: 'interrupt', interrupt: AudioInterrupt, callback: Callback\<InterruptAc ...@@ -1639,6 +1663,8 @@ on(type: 'interrupt', interrupt: AudioInterrupt, callback: Callback\<InterruptAc
请求焦点并开始监听音频打断事件(当应用程序的音频被另一个播放事件中断,回调通知此应用程序) 请求焦点并开始监听音频打断事件(当应用程序的音频被另一个播放事件中断,回调通知此应用程序)
此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.Multimedia.Audio.Renderer **系统能力:** SystemCapability.Multimedia.Audio.Renderer
**参数:** **参数:**
...@@ -1707,7 +1733,7 @@ setAudioScene\(scene: AudioScene, callback: AsyncCallback<void\>\): void ...@@ -1707,7 +1733,7 @@ setAudioScene\(scene: AudioScene, callback: AsyncCallback<void\>\): void
设置音频场景模式,使用callback方式异步返回结果。 设置音频场景模式,使用callback方式异步返回结果。
此接口为系统接口,三方应用不支持。 此接口为系统接口,三方应用不支持调用
**系统能力:** SystemCapability.Multimedia.Audio.Communication **系统能力:** SystemCapability.Multimedia.Audio.Communication
...@@ -1736,7 +1762,7 @@ setAudioScene\(scene: AudioScene\): Promise<void\> ...@@ -1736,7 +1762,7 @@ setAudioScene\(scene: AudioScene\): Promise<void\>
设置音频场景模式,使用Promise方式返回异步结果。 设置音频场景模式,使用Promise方式返回异步结果。
此接口为系统接口,三方应用不支持。 此接口为系统接口,三方应用不支持调用
**系统能力:** SystemCapability.Multimedia.Audio.Communication **系统能力:** SystemCapability.Multimedia.Audio.Communication
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册