harmony 鸿蒙@ohos.multimedia.audio (音频管理)

2022-08-09
浏览 (981)

@ohos.multimedia.audio (音频管理)

音频管理提供管理音频的一些基础能力，包括对音频音量、音频设备的管理，以及对音频数据的采集和渲染等。

该模块提供以下音频相关的常用功能：

AudioManager：音频管理。
AudioRenderer：音频渲染，用于播放PCM（Pulse Code Modulation）音频数据。
AudioCapturer：音频采集，用于录制PCM音频数据。
TonePlayer：用于管理和播放DTMF（Dual Tone Multi Frequency，双音多频）音调，如拨号音、通话回铃音等。

说明： 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import audio from '@ohos.multimedia.audio';

常量

名称	类型	可读	可写	说明
LOCAL_NETWORK_ID⁹⁺	string	是	否	本地设备网络id。此接口为系统接口。系统能力： SystemCapability.Multimedia.Audio.Device
DEFAULT_VOLUME_GROUP_ID⁹⁺	number	是	否	默认音量组id。系统能力： SystemCapability.Multimedia.Audio.Volume
DEFAULT_INTERRUPT_GROUP_ID⁹⁺	number	是	否	默认音频中断组id。系统能力： SystemCapability.Multimedia.Audio.Interrupt

示例：

import audio from '@ohos.multimedia.audio';

const localNetworkId = audio.LOCAL_NETWORK_ID;
const defaultVolumeGroupId = audio.DEFAULT_VOLUME_GROUP_ID;
const defaultInterruptGroupId = audio.DEFAULT_INTERRUPT_GROUP_ID;

audio.getAudioManager

getAudioManager(): AudioManager

获取音频管理器。

系统能力： SystemCapability.Multimedia.Audio.Core

返回值：

类型	说明
AudioManager	音频管理类。

示例：

import audio from '@ohos.multimedia.audio';
let audioManager = audio.getAudioManager();

audio.createAudioRenderer⁸⁺

createAudioRenderer(options: AudioRendererOptions, callback: AsyncCallback<AudioRenderer>): void

获取音频渲染器。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
options	AudioRendererOptions	是	配置渲染器。
callback	AsyncCallback<AudioRenderer>	是	音频渲染器对象。

示例：

import fs from '@ohos.file.fs';
import audio from '@ohos.multimedia.audio';

let audioStreamInfo: audio.AudioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
  channels: audio.AudioChannel.CHANNEL_1,
  sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
  encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
}

let audioRendererInfo: audio.AudioRendererInfo = {
  content: audio.ContentType.CONTENT_TYPE_SPEECH,
  usage: audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION,
  rendererFlags: 0
}

let audioRendererOptions: audio.AudioRendererOptions = {
  streamInfo: audioStreamInfo,
  rendererInfo: audioRendererInfo
}

audio.createAudioRenderer(audioRendererOptions,(err, data) => {
  if (err) {
    console.error(`AudioRenderer Created: Error: ${err}`);
  } else {
    console.info('AudioRenderer Created: Success: SUCCESS');
    let audioRenderer = data;
  }
});

audio.createAudioRenderer⁸⁺

createAudioRenderer(options: AudioRendererOptions): Promise

获取音频渲染器。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
options	AudioRendererOptions	是	配置渲染器。

返回值：

类型	说明
Promise<AudioRenderer>	音频渲染器对象。

示例：

import fs from '@ohos.file.fs';
import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';

let audioStreamInfo: audio.AudioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
  channels: audio.AudioChannel.CHANNEL_1,
  sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
  encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
}

let audioRendererInfo: audio.AudioRendererInfo = {
  content: audio.ContentType.CONTENT_TYPE_SPEECH,
  usage: audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION,
  rendererFlags: 0
}

let audioRendererOptions: audio.AudioRendererOptions = {
  streamInfo: audioStreamInfo,
  rendererInfo: audioRendererInfo
}

let audioRenderer: audio.AudioRenderer;
audio.createAudioRenderer(audioRendererOptions).then((data) => {
  audioRenderer = data;
  console.info('AudioFrameworkRenderLog: AudioRenderer Created : Success : Stream Type: SUCCESS');
}).catch((err: BusinessError) => {
  console.error(`AudioFrameworkRenderLog: AudioRenderer Created : ERROR : ${err}`);
});

audio.createAudioCapturer⁸⁺

createAudioCapturer(options: AudioCapturerOptions, callback: AsyncCallback): void

获取音频采集器。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

需要权限： ohos.permission.MICROPHONE

参数：

参数名	类型	必填	说明
options	AudioCapturerOptions	是	配置音频采集器。
callback	AsyncCallback<AudioCapturer>	是	音频采集器对象。

示例：

import audio from '@ohos.multimedia.audio';
let audioStreamInfo: audio.AudioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
  channels: audio.AudioChannel.CHANNEL_2,
  sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
  encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
}

let audioCapturerInfo: audio.AudioCapturerInfo = {
  source: audio.SourceType.SOURCE_TYPE_MIC,
  capturerFlags: 0
}

let audioCapturerOptions: audio.AudioCapturerOptions = {
  streamInfo: audioStreamInfo,
  capturerInfo: audioCapturerInfo
}

audio.createAudioCapturer(audioCapturerOptions, (err, data) => {
  if (err) {
    console.error(`AudioCapturer Created : Error: ${err}`);
  } else {
    console.info('AudioCapturer Created : Success : SUCCESS');
    let audioCapturer = data;
  }
});

audio.createAudioCapturer⁸⁺

createAudioCapturer(options: AudioCapturerOptions): Promise

获取音频采集器。使用promise 方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

需要权限： ohos.permission.MICROPHONE

参数：

参数名	类型	必填	说明
options	AudioCapturerOptions	是	配置音频采集器。

返回值：

类型	说明
Promise<AudioCapturer>	音频采集器对象

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';

let audioStreamInfo: audio.AudioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
  channels: audio.AudioChannel.CHANNEL_2,
  sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
  encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
}

let audioCapturerInfo: audio.AudioCapturerInfo = {
  source: audio.SourceType.SOURCE_TYPE_MIC,
  capturerFlags: 0
}

let audioCapturerOptions:audio.AudioCapturerOptions = {
  streamInfo: audioStreamInfo,
  capturerInfo: audioCapturerInfo
}

let audioCapturer: audio.AudioCapturer;
audio.createAudioCapturer(audioCapturerOptions).then((data) => {
  audioCapturer = data;
  console.info('AudioCapturer Created : Success : Stream Type: SUCCESS');
}).catch((err: BusinessError) => {
  console.error(`AudioCapturer Created : ERROR : ${err}`);
});

audio.createTonePlayer⁹⁺

createTonePlayer(options: AudioRendererInfo, callback: AsyncCallback<TonePlayer>): void

创建DTMF播放器。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Tone

系统接口： 该接口为系统接口

参数：

参数名	类型	必填	说明
options	AudioRendererInfo	是	配置音频渲染器信息。
callback	AsyncCallback<TonePlayer>	是	回调函数，回调返回音频渲染器对象。

示例：

import audio from '@ohos.multimedia.audio';

let audioRendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_DTMF,
  rendererFlags : 0
}
let tonePlayer: audio.TonePlayer;

audio.createTonePlayer(audioRendererInfo, (err, data) => {
  console.info(`callback call createTonePlayer: audioRendererInfo: ${audioRendererInfo}`);
  if (err) {
    console.error(`callback call createTonePlayer return error: ${err.message}`);
  } else {
    console.info(`callback call createTonePlayer return data: ${data}`);
    tonePlayer = data;
  }
});

audio.createTonePlayer⁹⁺

createTonePlayer(options: AudioRendererInfo): Promise<TonePlayer>

创建DTMF播放器。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Tone

系统接口： 该接口为系统接口

参数：

参数名	类型	必填	说明
options	AudioRendererInfo	是	配置音频渲染器信息。

返回值：

类型	说明
Promise<TonePlayer>	Promise对象，返回音频渲染器对象。

示例：

import audio from '@ohos.multimedia.audio';
let tonePlayer: audio.TonePlayer;
async function createTonePlayerBefore(){
  let audioRendererInfo: audio.AudioRendererInfo = {
    usage : audio.StreamUsage.STREAM_USAGE_DTMF,
    rendererFlags : 0
  }
  tonePlayer = await audio.createTonePlayer(audioRendererInfo);
}

AudioVolumeType

枚举，音频流类型。

系统能力： SystemCapability.Multimedia.Audio.Volume

名称	值	说明
VOICE_CALL⁸⁺	0	语音电话。
RINGTONE	2	铃声。
MEDIA	3	媒体。
ALARM¹⁰⁺	4	闹钟。
ACCESSIBILITY¹⁰⁺	5	无障碍。
VOICE_ASSISTANT⁸⁺	9	语音助手。
ULTRASONIC¹⁰⁺	10	超声波。此接口为系统接口。
ALL⁹⁺	100	所有公共音频流。此接口为系统接口。

InterruptRequestResultType⁹⁺

枚举，音频中断请求结果类型。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

系统接口： 该接口为系统接口

名称	值	说明
INTERRUPT_REQUEST_GRANT	0	请求音频中断成功。
INTERRUPT_REQUEST_REJECT	1	请求音频中断失败，可能具有较高优先级类型。

InterruptMode⁹⁺

枚举，焦点模型。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

名称	值	说明
SHARE_MODE	0	共享焦点模式。
INDEPENDENT_MODE	1	独立焦点模式。

DeviceFlag

枚举，可获取的设备种类。

系统能力： SystemCapability.Multimedia.Audio.Device

名称	值	说明
NONE_DEVICES_FLAG⁹⁺	0	无此接口为系统接口。
OUTPUT_DEVICES_FLAG	1	输出设备。
INPUT_DEVICES_FLAG	2	输入设备。
ALL_DEVICES_FLAG	3	所有设备。
DISTRIBUTED_OUTPUT_DEVICES_FLAG⁹⁺	4	分布式输出设备。此接口为系统接口。
DISTRIBUTED_INPUT_DEVICES_FLAG⁹⁺	8	分布式输入设备。此接口为系统接口。
ALL_DISTRIBUTED_DEVICES_FLAG⁹⁺	12	分布式输入和输出设备。此接口为系统接口。

DeviceRole

枚举，设备角色。

系统能力： SystemCapability.Multimedia.Audio.Device

名称	值	说明
INPUT_DEVICE	1	输入设备角色。
OUTPUT_DEVICE	2	输出设备角色。

DeviceType

枚举，设备类型。

系统能力： SystemCapability.Multimedia.Audio.Device

名称	值	说明
INVALID	0	无效设备。
EARPIECE	1	听筒。
SPEAKER	2	扬声器。
WIRED_HEADSET	3	有线耳机，带麦克风。
WIRED_HEADPHONES	4	有线耳机，无麦克风。
BLUETOOTH_SCO	7	蓝牙设备SCO（Synchronous Connection Oriented）连接。
BLUETOOTH_A2DP	8	蓝牙设备A2DP（Advanced Audio Distribution Profile）连接。
MIC	15	麦克风。
USB_HEADSET	22	USB耳机，带麦克风。
DEFAULT⁹⁺	1000	默认设备类型。

CommunicationDeviceType⁹⁺

枚举，用于通信的可用设备类型。

系统能力： SystemCapability.Multimedia.Audio.Communication

名称	值	说明
SPEAKER	2	扬声器。

AudioRingMode

枚举，铃声模式。

系统能力： SystemCapability.Multimedia.Audio.Communication

名称	值	说明
RINGER_MODE_SILENT	0	静音模式。
RINGER_MODE_VIBRATE	1	震动模式。
RINGER_MODE_NORMAL	2	响铃模式。

AudioSampleFormat⁸⁺

枚举，音频采样格式。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
SAMPLE_FORMAT_INVALID	-1	无效格式。
SAMPLE_FORMAT_U8	0	无符号8位整数。
SAMPLE_FORMAT_S16LE	1	带符号的16位整数，小尾数。
SAMPLE_FORMAT_S24LE	2	带符号的24位整数，小尾数。由于系统限制，该采样格式仅部分设备支持，请根据实际情况使用。
SAMPLE_FORMAT_S32LE	3	带符号的32位整数，小尾数。由于系统限制，该采样格式仅部分设备支持，请根据实际情况使用。
SAMPLE_FORMAT_F32LE⁹⁺	4	带符号的32位浮点数，小尾数。由于系统限制，该采样格式仅部分设备支持，请根据实际情况使用。

AudioErrors⁹⁺

枚举，音频错误码。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
ERROR_INVALID_PARAM	6800101	无效入参。
ERROR_NO_MEMORY	6800102	分配内存失败。
ERROR_ILLEGAL_STATE	6800103	状态不支持。
ERROR_UNSUPPORTED	6800104	参数选项不支持。
ERROR_TIMEOUT	6800105	处理超时。
ERROR_STREAM_LIMIT	6800201	音频流数量达到限制。
ERROR_SYSTEM	6800301	系统处理异常。

AudioChannel⁸⁺

枚举，音频声道。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
CHANNEL_1	0x1 << 0	第一声道。
CHANNEL_2	0x1 << 1	第二声道。

AudioSamplingRate⁸⁺

枚举，音频采样率，具体设备支持的采样率规格会存在差异。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
SAMPLE_RATE_8000	8000	采样率为8000。
SAMPLE_RATE_11025	11025	采样率为11025。
SAMPLE_RATE_12000	12000	采样率为12000。
SAMPLE_RATE_16000	16000	采样率为16000。
SAMPLE_RATE_22050	22050	采样率为22050。
SAMPLE_RATE_24000	24000	采样率为24000。
SAMPLE_RATE_32000	32000	采样率为32000。
SAMPLE_RATE_44100	44100	采样率为44100。
SAMPLE_RATE_48000	48000	采样率为48000。
SAMPLE_RATE_64000	64000	采样率为64000。
SAMPLE_RATE_96000	96000	采样率为96000。

AudioEncodingType⁸⁺

枚举，音频编码类型。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
ENCODING_TYPE_INVALID	-1	无效。
ENCODING_TYPE_RAW	0	PCM编码。

ContentType

枚举，音频内容类型。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
CONTENT_TYPE_UNKNOWN	0	未知类型。
CONTENT_TYPE_SPEECH	1	语音。
CONTENT_TYPE_MUSIC	2	音乐。
CONTENT_TYPE_MOVIE	3	电影。
CONTENT_TYPE_SONIFICATION	4	通知音。
CONTENT_TYPE_RINGTONE⁸⁺	5	铃声。

StreamUsage

枚举，音频流使用类型。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
STREAM_USAGE_UNKNOWN	0	未知类型。
STREAM_USAGE_MEDIA	1	媒体。
STREAM_USAGE_MUSIC¹⁰⁺	1	音乐。
STREAM_USAGE_VOICE_COMMUNICATION	2	语音通信。
STREAM_USAGE_VOICE_ASSISTANT⁹⁺	3	语音播报。
STREAM_USAGE_ALARM¹⁰⁺	4	闹钟。
STREAM_USAGE_VOICE_MESSAGE¹⁰⁺	5	语音消息。
STREAM_USAGE_NOTIFICATION_RINGTONE	6	通知铃声。
STREAM_USAGE_RINGTONE¹⁰⁺	6	铃声。
STREAM_USAGE_NOTIFICATION¹⁰⁺	7	通知。
STREAM_USAGE_ACCESSIBILITY¹⁰⁺	8	无障碍。
STREAM_USAGE_SYSTEM¹⁰⁺	9	系统音(如屏幕锁定或按键音)。此接口为系统接口。
STREAM_USAGE_MOVIE¹⁰⁺	10	电影或视频。
STREAM_USAGE_GAME¹⁰⁺	11	游戏音效。
STREAM_USAGE_AUDIOBOOK¹⁰⁺	12	有声读物。
STREAM_USAGE_NAVIGATION¹⁰⁺	13	导航。
STREAM_USAGE_DTMF¹⁰⁺	14	拨号音。此接口为系统接口。
STREAM_USAGE_ENFORCED_TONE¹⁰⁺	15	强制音(如相机快门音)。此接口为系统接口。
STREAM_USAGE_ULTRASONIC¹⁰⁺	16	超声波。此接口为系统接口。

InterruptRequestType⁹⁺

枚举，音频中断请求类型。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Interrupt

名称	值	说明
INTERRUPT_REQUEST_TYPE_DEFAULT	0	默认类型，可中断音频请求。

AudioState⁸⁺

枚举，音频状态。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
STATE_INVALID	-1	无效状态。
STATE_NEW	0	创建新实例状态。
STATE_PREPARED	1	准备状态。
STATE_RUNNING	2	可运行状态。
STATE_STOPPED	3	停止状态。
STATE_RELEASED	4	释放状态。
STATE_PAUSED	5	暂停状态。

AudioEffectMode¹⁰⁺

枚举，音效模式。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	值	说明
EFFECT_NONE	0	关闭音效。
EFFECT_DEFAULT	1	默认音效。

AudioRendererRate⁸⁺

枚举，音频渲染速度。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	值	说明
RENDER_RATE_NORMAL	0	正常速度。
RENDER_RATE_DOUBLE	1	2倍速。
RENDER_RATE_HALF	2	0.5倍数。

InterruptType

枚举，中断类型。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	值	说明
INTERRUPT_TYPE_BEGIN	1	音频播放中断事件开始。
INTERRUPT_TYPE_END	2	音频播放中断事件结束。

InterruptForceType⁹⁺

枚举，强制打断类型。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	值	说明
INTERRUPT_FORCE	0	由系统进行操作，强制打断音频播放。
INTERRUPT_SHARE	1	由应用进行操作，可以选择打断或忽略。

InterruptHint

枚举，中断提示。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	值	说明
INTERRUPT_HINT_NONE⁸⁺	0	无提示。
INTERRUPT_HINT_RESUME	1	提示音频恢复。
INTERRUPT_HINT_PAUSE	2	提示音频暂停。
INTERRUPT_HINT_STOP	3	提示音频停止。
INTERRUPT_HINT_DUCK	4	提示音频躲避。（躲避：音量减弱，而不会停止）
INTERRUPT_HINT_UNDUCK⁸⁺	5	提示音量恢复。

AudioStreamInfo⁸⁺

音频流信息。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	类型	必填	说明
samplingRate	AudioSamplingRate	是	音频文件的采样率。
channels	AudioChannel	是	音频文件的通道数。
sampleFormat	AudioSampleFormat	是	音频采样格式。
encodingType	AudioEncodingType	是	音频编码格式。

AudioRendererInfo⁸⁺

音频渲染器信息。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	类型	必填	说明
content	ContentType	否	媒体类型。 API version 8、9为必填参数，从API version 10开始，变更为可选参数。
usage	StreamUsage	是	音频流使用类型。
rendererFlags	number	是	音频渲染器标志。 0代表普通音频渲染器，1代表低时延音频渲染器。js接口暂不支持低时延音频渲染器。

InterruptResult⁹⁺

音频中断结果。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

系统接口： 该接口为系统接口

名称	类型	必填	说明
requestResult	InterruptRequestResultType	是	表示音频请求中断类型。
interruptNode	number	是	音频请求中断的节点。

AudioRendererOptions⁸⁺

音频渲染器选项信息。

名称	类型	必填	说明
streamInfo	AudioStreamInfo	是	表示音频流信息。系统能力： SystemCapability.Multimedia.Audio.Renderer
rendererInfo	AudioRendererInfo	是	表示渲染器信息。系统能力： SystemCapability.Multimedia.Audio.Renderer
privacyType¹⁰⁺	AudioPrivacyType	否	表示音频流是否可以被其他应用录制，默认值为0。系统能力： SystemCapability.Multimedia.Audio.PlaybackCapture

AudioPrivacyType¹⁰⁺

枚举类型，用于标识对应播放音频流是否支持被其他应用录制。

系统能力： SystemCapability.Multimedia.Audio.PlaybackCapture

名称	值	说明
PRIVACY_TYPE_PUBLIC	0	表示音频流可以被其他应用录制。
PRIVACY_TYPE_PRIVATE	1	表示音频流不可以被其他应用录制。

InterruptEvent⁹⁺

播放中断时，应用接收的中断事件。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	类型	必填	说明
eventType	InterruptType	是	中断事件类型，开始或是结束。
forceType	InterruptForceType	是	操作是由系统执行或是由应用程序执行。
hintType	InterruptHint	是	中断提示。

VolumeEvent⁹⁺

音量改变时，应用接收的事件。

系统能力： SystemCapability.Multimedia.Audio.Volume

名称	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volume	number	是	音量等级，可设置范围通过getMinVolume和getMaxVolume获取。
updateUi	boolean	是	在UI中显示音量变化。
volumeGroupId	number	是	音量组id。可用于getGroupManager入参。此接口为系统接口。
networkId	string	是	网络id。此接口为系统接口。

MicStateChangeEvent⁹⁺

麦克风状态变化时，应用接收的事件。

系统能力： SystemCapability.Multimedia.Audio.Device

名称	类型	必填	说明
mute	boolean	是	回调返回系统麦克风静音状态，true为静音，false为非静音。

ConnectType⁹⁺

枚举，设备连接类型。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

名称	值	说明
CONNECT_TYPE_LOCAL	1	本地设备。
CONNECT_TYPE_DISTRIBUTED	2	分布式设备。

VolumeGroupInfos⁹⁺

音量组信息，数组类型，为VolumeGroupInfo的数组，只读。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

VolumeGroupInfo⁹⁺

音量组信息。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

名称	类型	可读	可写	说明
networkId⁹⁺	string	是	否	组网络id。
groupId⁹⁺	number	是	否	组设备组id。
mappingId⁹⁺	number	是	否	组映射id。
groupName⁹⁺	string	是	否	组名。
type⁹⁺	ConnectType	是	否	连接设备类型。

DeviceChangeAction

描述设备连接状态变化和设备信息。

系统能力： SystemCapability.Multimedia.Audio.Device

名称	类型	必填	说明
type	DeviceChangeType	是	设备连接状态变化。
deviceDescriptors	AudioDeviceDescriptors	是	设备信息。

ChannelBlendMode¹¹⁺

枚举，声道混合模式类型。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	值	说明
MODE_DEFAULT¹¹⁺	0	无声道混合。
MODE_BLEND_LR¹¹⁺	1	混合左右声道。
MODE_ALL_LEFT¹¹⁺	2	从左声道拷贝覆盖到右声道混合。
MODE_ALL_RIGHT¹¹⁺	3	从右声道拷贝覆盖到左声道混合。

DeviceChangeType

枚举，设备连接状态变化。

系统能力： SystemCapability.Multimedia.Audio.Device

名称	值	说明
CONNECT	0	设备连接。
DISCONNECT	1	断开设备连接。

AudioCapturerOptions⁸⁺

音频采集器选项信息。

名称	类型	必填	说明
streamInfo	AudioStreamInfo	是	表示音频流信息。系统能力： SystemCapability.Multimedia.Audio.Capturer
capturerInfo	AudioCapturerInfo	是	表示采集器信息。系统能力： SystemCapability.Multimedia.Audio.Capturer
playbackCaptureConfig¹⁰⁺	AudioPlaybackCaptureConfig	否	音频内录的配置信息。系统能力： SystemCapability.Multimedia.Audio.PlaybackCapture

AudioCapturerInfo⁸⁺

描述音频采集器信息。

系统能力： SystemCapability.Multimedia.Audio.Core

名称	类型	必填	说明
source	SourceType	是	音源类型。
capturerFlags	number	是	音频采集器标志。

SourceType⁸⁺

枚举，音源类型。

名称	值	说明
SOURCE_TYPE_INVALID	-1	无效的音频源。系统能力： SystemCapability.Multimedia.Audio.Core
SOURCE_TYPE_MIC	0	Mic音频源。系统能力： SystemCapability.Multimedia.Audio.Core
SOURCE_TYPE_VOICE_RECOGNITION⁹⁺	1	语音识别源。系统能力： SystemCapability.Multimedia.Audio.Core
SOURCE_TYPE_PLAYBACK_CAPTURE¹⁰⁺	2	播放音频流（内录）录制音频源。系统能力： SystemCapability.Multimedia.Audio.PlaybackCapture
SOURCE_TYPE_WAKEUP ¹⁰⁺	3	语音唤醒音频流录制音频源。系统能力： SystemCapability.Multimedia.Audio.Core 需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE 此接口为系统接口
SOURCE_TYPE_VOICE_COMMUNICATION	7	语音通话场景的音频源。系统能力： SystemCapability.Multimedia.Audio.Core

AudioPlaybackCaptureConfig¹⁰⁺

播放音频流录制（内录）的配置信息。

系统能力： SystemCapability.Multimedia.Audio.PlaybackCapture

名称	类型	必填	说明
filterOptions	CaptureFilterOptions	是	需要录制的播放音频流的筛选信息。

CaptureFilterOptions¹⁰⁺

待录制的播放音频流的筛选信息。

需要权限： ohos.permission.CAPTURE_VOICE_DOWNLINK_AUDIO

当应用指定录制的StreamUsage值中包含SOURCE_TYPE_VOICE_COMMUNICATION的播放音频流时，需要校验应用是否拥有该权限。

系统能力： SystemCapability.Multimedia.Audio.PlaybackCapture

名称	类型	必填	说明
usages	Array<StreamUsage>	是	指定需要录制的播放音频流的StreamUsage类型。可同时指定0个或多个StreamUsage。Array为空时，默认录制StreamUsage为STREAM_USAGE_MEDIA的播放音频流。

AudioScene⁸⁺

枚举，音频场景。

系统能力： SystemCapability.Multimedia.Audio.Communication

名称	值	说明
AUDIO_SCENE_DEFAULT	0	默认音频场景。
AUDIO_SCENE_RINGING	1	响铃模式。此接口为系统接口。
AUDIO_SCENE_PHONE_CALL	2	电话模式。此接口为系统接口。
AUDIO_SCENE_VOICE_CHAT	3	语音聊天模式。

VolumeAdjustType¹⁰⁺

枚举，音量调节类型。

系统能力： SystemCapability.Multimedia.Audio.Volume

名称	值	说明
VOLUME_UP	0	向上调节音量。此接口为系统接口。
VOLUME_DOWN	1	向下调节音量。此接口为系统接口。

AudioManager

管理音频音量和音频设备。在调用AudioManager的接口前，需要先通过getAudioManager创建实例。

setAudioParameter

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

音频参数设置，使用callback方式异步返回结果。

本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上，所支持的音频参数会存在差异。示例代码内使用样例参数，实际支持的音频配置参数见具体设备平台的资料描述。

需要权限： ohos.permission.MODIFY_AUDIO_SETTINGS

系统能力： SystemCapability.Multimedia.Audio.Core

参数：

参数名	类型	必填	说明
key	string	是	被设置的音频参数的键。
value	string	是	被设置的音频参数的值。
callback	AsyncCallback<void>	是	回调返回设置成功或失败。

示例：

import { BusinessError } from '@ohos.base';
audioManager.setAudioParameter('key_example', 'value_example', (err: BusinessError) => {
  if (err) {
    console.error(`Failed to set the audio parameter. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful setting of the audio parameter.');
});

setAudioParameter

setAudioParameter(key: string, value: string): Promise<void>

音频参数设置，使用Promise方式异步返回结果。

需要权限： ohos.permission.MODIFY_AUDIO_SETTINGS

系统能力： SystemCapability.Multimedia.Audio.Core

参数：

参数名	类型	必填	说明
key	string	是	被设置的音频参数的键。
value	string	是	被设置的音频参数的值。

返回值：

类型	说明
Promise<void>	Promise回调返回设置成功或失败。

示例：

audioManager.setAudioParameter('key_example', 'value_example').then(() => {
  console.info('Promise returned to indicate a successful setting of the audio parameter.');
});

getAudioParameter

getAudioParameter(key: string, callback: AsyncCallback<string>): void

获取指定音频参数值，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Core

参数：

参数名	类型	必填	说明
key	string	是	待获取的音频参数的键。
callback	AsyncCallback<string>	是	回调返回获取的音频参数的值。

示例：

import { BusinessError } from '@ohos.base';
audioManager.getAudioParameter('key_example', (err: BusinessError, value: string) => {
  if (err) {
    console.error(`Failed to obtain the value of the audio parameter. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the value of the audio parameter is obtained ${value}.`);
});

getAudioParameter

getAudioParameter(key: string): Promise<string>

获取指定音频参数值，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Core

参数：

参数名	类型	必填	说明
key	string	是	待获取的音频参数的键。

返回值：

类型	说明
Promise<string>	Promise回调返回获取的音频参数的值。

示例：

audioManager.getAudioParameter('key_example').then((value: string) => {
  console.info(`Promise returned to indicate that the value of the audio parameter is obtained ${value}.`);
});

setAudioScene⁸⁺

setAudioScene(scene: AudioScene, callback: AsyncCallback): void

设置音频场景模式，使用callback方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
scene	AudioScene	是	音频场景模式。
callback	AsyncCallback	是	用于返回结果的回调。

示例：

import { BusinessError } from '@ohos.base';
audioManager.setAudioScene(audio.AudioScene.AUDIO_SCENE_PHONE_CALL, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to set the audio scene mode. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful setting of the audio scene mode.');
});

setAudioScene⁸⁺

setAudioScene(scene: AudioScene): Promise

设置音频场景模式，使用Promise方式返回异步结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
scene	AudioScene	是	音频场景模式。

返回值：

类型	说明
Promise	用于返回结果的回调。

示例：

import { BusinessError } from '@ohos.base';
audioManager.setAudioScene(audio.AudioScene.AUDIO_SCENE_PHONE_CALL).then(() => {
  console.info('Promise returned to indicate a successful setting of the audio scene mode.');
}).catch ((err: BusinessError) => {
  console.error(`Failed to set the audio scene mode ${err}`);
});

getAudioScene⁸⁺

getAudioScene(callback: AsyncCallback): void

获取音频场景模式，使用callback方式返回异步结果。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioScene>	是	用于返回音频场景模式的回调。

示例：

import { BusinessError } from '@ohos.base';
audioManager.getAudioScene((err: BusinessError, value: audio.AudioScene) => {
  if (err) {
    console.error(`Failed to obtain the audio scene mode. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the audio scene mode is obtained ${value}.`);
});

getAudioScene⁸⁺

getAudioScene(): Promise

获取音频场景模式，使用Promise方式返回异步结果。

系统能力： SystemCapability.Multimedia.Audio.Communication

返回值：

类型	说明
Promise<AudioScene>	用于返回音频场景模式的回调。

示例：

import { BusinessError } from '@ohos.base';
audioManager.getAudioScene().then((value: audio.AudioScene) => {
  console.info(`Promise returned to indicate that the audio scene mode is obtained ${value}.`);
}).catch ((err: BusinessError) => {
  console.error(`Failed to obtain the audio scene mode ${err}`);
});

getAudioSceneSync¹⁰⁺

getAudioSceneSync(): AudioScene

获取音频场景模式，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Communication

返回值：

类型	说明
AudioScene	返回音频场景模式。

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: audio.AudioScene = audioManager.getAudioSceneSync();
  console.info(`indicate that the audio scene mode is obtained ${value}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the audio scene mode ${error}`);
}

getVolumeManager⁹⁺

getVolumeManager(): AudioVolumeManager

获取音频音量管理器。

系统能力： SystemCapability.Multimedia.Audio.Volume

示例：

import audio from '@ohos.multimedia.audio';
let audioVolumeManager: audio.AudioVolumeManager = audioManager.getVolumeManager();

getStreamManager⁹⁺

getStreamManager(): AudioStreamManager

获取音频流管理器。

系统能力： SystemCapability.Multimedia.Audio.Core

示例：

import audio from '@ohos.multimedia.audio';
let audioStreamManager: audio.AudioStreamManager = audioManager.getStreamManager();

getRoutingManager⁹⁺

getRoutingManager(): AudioRoutingManager

获取音频路由设备管理器。

系统能力： SystemCapability.Multimedia.Audio.Device

示例：

import audio from '@ohos.multimedia.audio';
let audioRoutingManager: audio.AudioRoutingManager = audioManager.getRoutingManager();

setVolume^(deprecated)

setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback<void>): void

设置指定流的音量，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃。建议使用AudioVolumeGroupManager中的setVolume替代，替代接口能力仅对系统应用开放。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volume	number	是	音量等级，可设置范围通过getMinVolume和getMaxVolume获取。
callback	AsyncCallback<void>	是	回调表示成功还是失败。

示例：

import { BusinessError } from '@ohos.base';
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to set the volume. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful volume setting.');
});

setVolume^(deprecated)

setVolume(volumeType: AudioVolumeType, volume: number): Promise<void>

设置指定流的音量，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃。建议使用AudioVolumeGroupManager中的setVolume替代，替代接口能力仅对系统应用开放。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volume	number	是	音量等级，可设置范围通过getMinVolume和getMaxVolume获取。

返回值：

类型	说明
Promise<void>	Promise回调表示成功还是失败。

示例：

audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10).then(() => {
  console.info('Promise returned to indicate a successful volume setting.');
});

getVolume^(deprecated)

getVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

获取指定流的音量，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的getVolume替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<number>	是	回调返回音量大小。

示例：

import { BusinessError } from '@ohos.base';
audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: number) => {
  if (err) {
    console.error(`Failed to obtain the volume. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the volume is obtained.');
});

getVolume^(deprecated)

getVolume(volumeType: AudioVolumeType): Promise<number>

获取指定流的音量，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的getVolume替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<number>	Promise回调返回音量大小。

示例：

audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((value: number) => {
  console.info(`Promise returned to indicate that the volume is obtained ${value} .`);
});

getMinVolume^(deprecated)

getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

获取指定流的最小音量，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的getMinVolume替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<number>	是	回调返回最小音量。

示例：

import { BusinessError } from '@ohos.base';
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: number) => {
  if (err) {
    console.error(`Failed to obtain the minimum volume. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the minimum volume is obtained. ${value}`);
});

getMinVolume^(deprecated)

getMinVolume(volumeType: AudioVolumeType): Promise<number>

获取指定流的最小音量，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的getMinVolume替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<number>	Promise回调返回最小音量。

示例：

audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value: number) => {
  console.info(`Promised returned to indicate that the minimum volume is obtained. ${value}`);
});

getMaxVolume^(deprecated)

getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

获取指定流的最大音量，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的getMaxVolume替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<number>	是	回调返回最大音量大小。

示例：

import { BusinessError } from '@ohos.base';
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: number) => {
  if (err) {
    console.error(`Failed to obtain the maximum volume. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the maximum volume is obtained. ${value}`);
});

getMaxVolume^(deprecated)

getMaxVolume(volumeType: AudioVolumeType): Promise<number>

获取指定流的最大音量，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的getMaxVolume替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<number>	Promise回调返回最大音量大小。

示例：

audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data: number) => {
  console.info('Promised returned to indicate that the maximum volume is obtained.');
});

mute^(deprecated)

mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void>): void

设置指定音量流静音，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃。建议使用AudioVolumeGroupManager中的mute替代，替代接口能力仅对系统应用开放。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
mute	boolean	是	静音状态，true为静音，false为非静音。
callback	AsyncCallback<void>	是	回调表示成功还是失败。

示例：

import { BusinessError } from '@ohos.base';
audioManager.mute(audio.AudioVolumeType.MEDIA, true, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to mute the stream. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the stream is muted.');
});

mute^(deprecated)

mute(volumeType: AudioVolumeType, mute: boolean): Promise<void>

设置指定音量流静音，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃。建议使用AudioVolumeGroupManager中的mute替代，替代接口能力仅对系统应用开放。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
mute	boolean	是	静音状态，true为静音，false为非静音。

返回值：

类型	说明
Promise<void>	Promise回调表示成功还是失败。

示例：

audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() => {
  console.info('Promise returned to indicate that the stream is muted.');
});

isMute^(deprecated)

isMute(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): void

获取指定音量流是否被静音，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的isMute替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<boolean>	是	回调返回流静音状态，true为静音，false为非静音。

示例：

import { BusinessError } from '@ohos.base';
audioManager.isMute(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: boolean) => {
  if (err) {
    console.error(`Failed to obtain the mute status. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the mute status of the stream is obtained. ${value}`);
});

isMute^(deprecated)

isMute(volumeType: AudioVolumeType): Promise<boolean>

获取指定音量流是否被静音，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的isMute替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<boolean>	Promise回调返回流静音状态，true为静音，false为非静音。

示例：

audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value: boolean) => {
  console.info(`Promise returned to indicate that the mute status of the stream is obtained ${value}.`);
});

isActive^(deprecated)

isActive(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): void

获取指定音量流是否为活跃状态，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioStreamManager中的isActive替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<boolean>	是	回调返回流的活跃状态，true为活跃，false为不活跃。

示例：

import { BusinessError } from '@ohos.base';
audioManager.isActive(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: boolean) => {
  if (err) {
    console.error(`Failed to obtain the active status of the stream. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the active status of the stream is obtained ${value}.`);
});

isActive^(deprecated)

isActive(volumeType: AudioVolumeType): Promise<boolean>

获取指定音量流是否为活跃状态，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioStreamManager中的isActive替代。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<boolean>	Promise回调返回流的活跃状态，true为活跃，false为不活跃。

示例：

audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value: boolean) => {
  console.info(`Promise returned to indicate that the active status of the stream is obtained ${value}.`);
});

setRingerMode^(deprecated)

setRingerMode(mode: AudioRingMode, callback: AsyncCallback<void>): void

设置铃声模式，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃。建议使用AudioVolumeGroupManager中的setRingerMode替代，替代接口能力仅对系统应用开放。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅在静音和非静音状态切换时需要该权限。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
mode	AudioRingMode	是	音频铃声模式。
callback	AsyncCallback<void>	是	回调返回设置成功或失败。

示例：

import { BusinessError } from '@ohos.base';
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to set the ringer mode. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful setting of the ringer mode.');
});

setRingerMode^(deprecated)

setRingerMode(mode: AudioRingMode): Promise<void>

设置铃声模式，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃。建议使用AudioVolumeGroupManager中的setRingerMode替代，替代接口能力仅对系统应用开放。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅在静音和非静音状态切换时需要该权限。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
mode	AudioRingMode	是	音频铃声模式。

返回值：

类型	说明
Promise<void>	Promise回调返回设置成功或失败。

示例：

audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() => {
  console.info('Promise returned to indicate a successful setting of the ringer mode.');
});

getRingerMode^(deprecated)

getRingerMode(callback: AsyncCallback<AudioRingMode>): void

获取铃声模式，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的getRingerMode替代。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioRingMode>	是	回调返回系统的铃声模式。

示例：

import { BusinessError } from '@ohos.base';
audioManager.getRingerMode((err: BusinessError, value: audio.AudioRingMode) => {
  if (err) {
    console.error(`Failed to obtain the ringer mode. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the ringer mode is obtained ${value}.`);
});

getRingerMode^(deprecated)

getRingerMode(): Promise<AudioRingMode>

获取铃声模式，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的getRingerMode替代。

系统能力： SystemCapability.Multimedia.Audio.Communication

返回值：

类型	说明
Promise<AudioRingMode>	Promise回调返回系统的铃声模式。

示例：

audioManager.getRingerMode().then((value: audio.AudioRingMode) => {
  console.info(`Promise returned to indicate that the ringer mode is obtained ${value}.`);
});

getDevices^(deprecated)

getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors>): void

获取音频设备列表，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioRoutingManager中的getDevices替代。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceFlag	DeviceFlag	是	设备类型的flag。
callback	AsyncCallback<AudioDeviceDescriptors>	是	回调，返回设备列表。

示例：

import { BusinessError } from '@ohos.base';
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err: BusinessError, value: audio.AudioDeviceDescriptors) => {
  if (err) {
    console.error(`Failed to obtain the device list. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the device list is obtained.');
});

getDevices^(deprecated)

getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors>

获取音频设备列表，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioRoutingManager中的getDevices替代。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceFlag	DeviceFlag	是	设备类型的flag。

返回值：

类型	说明
Promise<AudioDeviceDescriptors>	Promise回调返回设备列表。

示例：

audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data: audio.AudioDeviceDescriptors) => {
  console.info('Promise returned to indicate that the device list is obtained.');
});

setDeviceActive^(deprecated)

setDeviceActive(deviceType: ActiveDeviceType, active: boolean, callback: AsyncCallback<void>): void

设置设备激活状态，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioRoutingManager中的setCommunicationDevice替代。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceType	ActiveDeviceType	是	活跃音频设备类型。
active	boolean	是	设备激活状态。
callback	AsyncCallback<void>	是	回调返回设置成功或失败。

示例：

import { BusinessError } from '@ohos.base';
audioManager.setDeviceActive(audio.ActiveDeviceType.SPEAKER, true, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to set the active status of the device. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the device is set to the active status.');
});

setDeviceActive^(deprecated)

setDeviceActive(deviceType: ActiveDeviceType, active: boolean): Promise<void>

设置设备激活状态，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioRoutingManager中的setCommunicationDevice替代。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceType	ActiveDeviceType	是	活跃音频设备类型。
active	boolean	是	设备激活状态。

返回值：

类型	说明
Promise<void>	Promise回调返回设置成功或失败。

示例：

audioManager.setDeviceActive(audio.ActiveDeviceType.SPEAKER, true).then(() => {
  console.info('Promise returned to indicate that the device is set to the active status.');
});

isDeviceActive^(deprecated)

isDeviceActive(deviceType: ActiveDeviceType, callback: AsyncCallback<boolean>): void

获取指定设备的激活状态，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioRoutingManager中的isCommunicationDeviceActive替代。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceType	ActiveDeviceType	是	活跃音频设备类型。
callback	AsyncCallback<boolean>	是	回调返回设备的激活状态。

示例：

import { BusinessError } from '@ohos.base';
audioManager.isDeviceActive(audio.ActiveDeviceType.SPEAKER, (err: BusinessError, value: boolean) => {
  if (err) {
    console.error(`Failed to obtain the active status of the device. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the active status of the device is obtained.');
});

isDeviceActive^(deprecated)

isDeviceActive(deviceType: ActiveDeviceType): Promise<boolean>

获取指定设备的激活状态，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioRoutingManager中的isCommunicationDeviceActive替代。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceType	ActiveDeviceType	是	活跃音频设备类型。

返回值：

Type	Description
Promise<boolean>	Promise回调返回设备的激活状态。

示例：

audioManager.isDeviceActive(audio.ActiveDeviceType.SPEAKER).then((value: boolean) => {
  console.info(`Promise returned to indicate that the active status of the device is obtained ${value}.`);
});

setMicrophoneMute^(deprecated)

setMicrophoneMute(mute: boolean, callback: AsyncCallback<void>): void

设置麦克风静音状态，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的setMicrophoneMute替代。

需要权限： ohos.permission.MICROPHONE

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
mute	boolean	是	待设置的静音状态，true为静音，false为非静音。
callback	AsyncCallback<void>	是	回调返回设置成功或失败。

示例：

import { BusinessError } from '@ohos.base';
audioManager.setMicrophoneMute(true, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to mute the microphone. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the microphone is muted.');
});

setMicrophoneMute^(deprecated)

setMicrophoneMute(mute: boolean): Promise<void>

设置麦克风静音状态，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的setMicrophoneMute替代。

需要权限： ohos.permission.MICROPHONE

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
mute	boolean	是	待设置的静音状态，true为静音，false为非静音。

返回值：

类型	说明
Promise<void>	Promise回调返回设置成功或失败。

示例：

audioManager.setMicrophoneMute(true).then(() => {
  console.info('Promise returned to indicate that the microphone is muted.');
});

isMicrophoneMute^(deprecated)

isMicrophoneMute(callback: AsyncCallback<boolean>): void

获取麦克风静音状态，使用callback方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的isMicrophoneMute替代。

需要权限： ohos.permission.MICROPHONE

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	回调返回系统麦克风静音状态，true为静音，false为非静音。

示例：

import { BusinessError } from '@ohos.base';
audioManager.isMicrophoneMute((err: BusinessError, value: boolean) => {
  if (err) {
    console.error(`Failed to obtain the mute status of the microphone. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the mute status of the microphone is obtained ${value}.`);
});

isMicrophoneMute^(deprecated)

isMicrophoneMute(): Promise<boolean>

获取麦克风静音状态，使用Promise方式异步返回结果。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的isMicrophoneMute替代。

需要权限： ohos.permission.MICROPHONE

系统能力： SystemCapability.Multimedia.Audio.Device

返回值：

类型	说明
Promise<boolean>	Promise回调返回系统麦克风静音状态，true为静音，false为非静音。

示例：

audioManager.isMicrophoneMute().then((value: boolean) => {
  console.info(`Promise returned to indicate that the mute status of the microphone is obtained ${value}.`);
});

on(‘volumeChange’)^(deprecated)

on(type: ‘volumeChange’, callback: Callback<VolumeEvent>): void

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeManager中的on(‘volumeChange’)替代。

监听系统音量变化事件。

系统接口： 该接口为系统接口

目前此订阅接口在单进程多AudioManager实例的使用场景下，仅最后一个实例的订阅生效，其他实例的订阅会被覆盖（即使最后一个实例没有进行订阅），因此推荐使用单一AudioManager实例进行开发。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’volumeChange’（系统音量变化事件，检测到系统音量改变时，触发该事件）。
callback	Callback<VolumeEvent>	是	回调方法。

示例：

audioManager.on('volumeChange', (volumeEvent: audio.VolumeEvent) => {
  console.info(`VolumeType of stream: ${volumeEvent.volumeType} `);
  console.info(`Volume level: ${volumeEvent.volume} `);
  console.info(`Whether to updateUI: ${volumeEvent.updateUi} `);
});

on(‘ringerModeChange’)^(deprecated)

on(type: ‘ringerModeChange’, callback: Callback<AudioRingMode>): void

监听铃声模式变化事件。

说明： 从 API version 8 开始支持，从 API version 9 开始废弃，建议使用AudioVolumeGroupManager中的on(‘ringerModeChange’)替代。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’ringerModeChange’（铃声模式变化事件，检测到铃声模式改变时，触发该事件）。
callback	Callback<AudioRingMode>	是	回调方法。

示例：

audioManager.on('ringerModeChange', (ringerMode: audio.AudioRingMode) => {
  console.info(`Updated ringermode: ${ringerMode}`);
});

on(‘deviceChange’)^(deprecated)

on(type: ‘deviceChange’, callback: Callback): void

设备更改。音频设备连接状态变化。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioRoutingManager中的on(‘deviceChange’)替代。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件的类型。支持事件：’deviceChange’
callback	Callback<DeviceChangeAction>	是	获取设备更新详情。

示例：

audioManager.on('deviceChange', (deviceChanged: audio.DeviceChangeAction) => {
  console.info(`device change type : ${deviceChanged.type} `);
  console.info(`device descriptor size : ${deviceChanged.deviceDescriptors.length} `);
  console.info(`device change descriptor : ${deviceChanged.deviceDescriptors[0].deviceRole} `);
  console.info(`device change descriptor : ${deviceChanged.deviceDescriptors[0].deviceType} `);
});

off(‘deviceChange’)^(deprecated)

off(type: ‘deviceChange’, callback?: Callback): void

取消订阅音频设备连接变化事件。

说明： 从 API version 7 开始支持，从 API version 9 开始废弃，建议使用AudioRoutingManager中的off(‘deviceChange’)替代。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件的类型。支持事件：’deviceChange’
callback	Callback<DeviceChangeAction>	否	获取设备更新详情。

示例：

audioManager.off('deviceChange');

on(‘interrupt’)

on(type: ‘interrupt’, interrupt: AudioInterrupt, callback: Callback<InterruptAction>): void

请求焦点并开始监听音频打断事件（当应用程序的音频被另一个播放事件中断，回调通知此应用程序）。

与on(‘audioInterrupt’)作用一致，均用于监听焦点变化。为无音频流的场景（未曾创建AudioRenderer对象），比如FM、语音唤醒等提供焦点变化监听功能。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	音频打断事件回调类型，支持的事件为：’interrupt’（多应用之间第二个应用会打断第一个应用，触发该事件）。
interrupt	AudioInterrupt	是	音频打断事件类型的参数。
callback	Callback<InterruptAction>	是	音频打断事件回调方法。

示例：

import audio from '@ohos.multimedia.audio';
let interAudioInterrupt: audio.AudioInterrupt = {
  streamUsage:2,
  contentType:0,
  pauseWhenDucked:true
};
audioManager.on('interrupt', interAudioInterrupt, (InterruptAction: audio.InterruptAction) => {
  if (InterruptAction.actionType === 0) {
    console.info('An event to gain the audio focus starts.');
    console.info(`Focus gain event: ${InterruptAction} `);
  }
  if (InterruptAction.actionType === 1) {
    console.info('An audio interruption event starts.');
    console.info(`Audio interruption event: ${InterruptAction} `);
  }
});

off(‘interrupt’)

off(type: ‘interrupt’, interrupt: AudioInterrupt, callback?: Callback<InterruptAction>): void

取消监听音频打断事件（删除监听事件，取消打断）。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	音频打断事件回调类型，支持的事件为：’interrupt’（多应用之间第二个应用会打断第一个应用，触发该事件）。
interrupt	AudioInterrupt	是	音频打断事件类型的参数。
callback	Callback<InterruptAction>	否	音频打断事件回调方法。

示例：

import audio from '@ohos.multimedia.audio';
let interAudioInterrupt: audio.AudioInterrupt = {
  streamUsage:2,
  contentType:0,
  pauseWhenDucked:true
};
audioManager.off('interrupt', interAudioInterrupt, (InterruptAction: audio.InterruptAction) => {
  if (InterruptAction.actionType === 0) {
    console.info('An event to release the audio focus starts.');
    console.info(`Focus release event: ${InterruptAction} `);
  }
});

AudioVolumeManager⁹⁺

音量管理。在使用AudioVolumeManager的接口前，需要使用getVolumeManager获取AudioVolumeManager实例。

getVolumeGroupInfos⁹⁺

getVolumeGroupInfos(networkId: string, callback: AsyncCallback): void

获取音量组信息列表，使用callback方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
networkId	string	是	设备的网络id。本地设备audio.LOCAL_NETWORK_ID。
callback	AsyncCallback<VolumeGroupInfos>	是	回调，返回音量组信息列表。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeManager.getVolumeGroupInfos(audio.LOCAL_NETWORK_ID, (err: BusinessError, value: audio.VolumeGroupInfos) => {
  if (err) {
    console.error(`Failed to obtain the volume group infos list. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the volume group infos list is obtained.');
});

getVolumeGroupInfos⁹⁺

getVolumeGroupInfos(networkId: string): Promise

获取音量组信息列表，使用promise方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
networkId	string	是	设备的网络id。本地设备audio.LOCAL_NETWORK_ID。

返回值：

类型	说明
Promise<VolumeGroupInfos>	音量组信息列表。

示例：

async function getVolumeGroupInfos(){
  let volumegroupinfos: audio.VolumeGroupInfos = await audio.getAudioManager().getVolumeManager().getVolumeGroupInfos(audio.LOCAL_NETWORK_ID);
  console.info('Promise returned to indicate that the volumeGroup list is obtained.'+JSON.stringify(volumegroupinfos))
}

getVolumeGroupInfosSync¹⁰⁺

getVolumeGroupInfosSync(networkId: string): VolumeGroupInfos

获取音量组信息列表，同步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
networkId	string	是	设备的网络id。本地设备audio.LOCAL_NETWORK_ID。

返回值：

类型	说明
VolumeGroupInfos	音量组信息列表。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let volumegroupinfos: audio.VolumeGroupInfos = audioVolumeManager.getVolumeGroupInfosSync(audio.LOCAL_NETWORK_ID);
  console.info(`Indicate that the volumeGroup list is obtained. ${JSON.stringify(volumegroupinfos)}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the volumeGroup list ${error}`);
}

getVolumeGroupManager⁹⁺

getVolumeGroupManager(groupId: number, callback: AsyncCallback): void

获取音频组管理器，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
groupId	number	是	音量组id。
callback	AsyncCallback<AudioVolumeGroupManager>	是	回调，返回一个音量组实例。

示例：

import { BusinessError } from '@ohos.base';
let groupid: number = audio.DEFAULT_VOLUME_GROUP_ID;
audioVolumeManager.getVolumeGroupManager(groupid, (err: BusinessError, value: audio.AudioVolumeGroupManager) => {
  if (err) {
    console.error(`Failed to obtain the volume group infos list. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the volume group infos list is obtained.');
});

getVolumeGroupManager⁹⁺

getVolumeGroupManager(groupId: number): Promise

获取音频组管理器，使用promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
groupId	number	是	音量组id。

返回值：

类型	说明
Promise< AudioVolumeGroupManager >	音量组实例。

示例：

import audio from '@ohos.multimedia.audio';
let groupid: number = audio.DEFAULT_VOLUME_GROUP_ID;
let audioVolumeGroupManager: audio.AudioVolumeGroupManager|undefined = undefined;
async function getVolumeGroupManager(){
  audioVolumeGroupManager = await audioVolumeManager.getVolumeGroupManager(groupid);
  console.info('Callback invoked to indicate that the volume group infos list is obtained.');
}

getVolumeGroupManagerSync¹⁰⁺

getVolumeGroupManagerSync(groupId: number): AudioVolumeGroupManager

获取音频组管理器，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
groupId	number	是	音量组id。

返回值：

类型	说明
AudioVolumeGroupManager	音量组实例。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let audioVolumeGroupManager: audio.AudioVolumeGroupManager = audioVolumeManager.getVolumeGroupManagerSync(audio.DEFAULT_VOLUME_GROUP_ID);
  console.info(`Get audioVolumeGroupManager success.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to get audioVolumeGroupManager, error: ${error}`);
}

on(‘volumeChange’)⁹⁺

on(type: ‘volumeChange’, callback: Callback<VolumeEvent>): void

监听系统音量变化事件，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’volumeChange’。
callback	Callback<VolumeEvent>	是	回调方法。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioVolumeManager.on('volumeChange', (volumeEvent: audio.VolumeEvent) => {
  console.info(`VolumeType of stream: ${volumeEvent.volumeType} `);
  console.info(`Volume level: ${volumeEvent.volume} `);
  console.info(`Whether to updateUI: ${volumeEvent.updateUi} `);
});

AudioVolumeGroupManager⁹⁺

管理音频组音量。在调用AudioVolumeGroupManager的接口前，需要先通过 getVolumeGroupManager 创建实例。

setVolume⁹⁺

setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback<void>): void

设置指定流的音量，使用callback方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volume	number	是	音量等级，可设置范围通过getMinVolume和getMaxVolume获取。
callback	AsyncCallback<void>	是	回调表示成功还是失败。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.setVolume(audio.AudioVolumeType.MEDIA, 10, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to set the volume. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful volume setting.');
});

setVolume⁹⁺

setVolume(volumeType: AudioVolumeType, volume: number): Promise<void>

设置指定流的音量，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volume	number	是	音量等级，可设置范围通过getMinVolume和getMaxVolume获取。

返回值：

类型	说明
Promise<void>	Promise回调表示成功还是失败。

示例：

audioVolumeGroupManager.setVolume(audio.AudioVolumeType.MEDIA, 10).then(() => {
  console.info('Promise returned to indicate a successful volume setting.');
});

getVolume⁹⁺

getVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

获取指定流的音量，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<number>	是	回调返回音量大小。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.getVolume(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: number) => {
  if (err) {
    console.error(`Failed to obtain the volume. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the volume is obtained.');
});

getVolume⁹⁺

getVolume(volumeType: AudioVolumeType): Promise<number>

获取指定流的音量，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<number>	Promise回调返回音量大小。

示例：

audioVolumeGroupManager.getVolume(audio.AudioVolumeType.MEDIA).then((value: number) => {
  console.info(`Promise returned to indicate that the volume is obtained ${value}.`);
});

getVolumeSync¹⁰⁺

getVolumeSync(volumeType: AudioVolumeType): number;

获取指定流的音量，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
number	返回音量大小。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: number = audioVolumeGroupManager.getVolumeSync(audio.AudioVolumeType.MEDIA);
  console.info(`Indicate that the volume is obtained ${value}.`);
} catch (err) {
  let error = err as BusinessError;
  console.info(`Failed to obtain the volume, error ${error}.`);
}

getMinVolume⁹⁺

getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

获取指定流的最小音量，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<number>	是	回调返回最小音量。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: number) => {
  if (err) {
    console.error(`Failed to obtain the minimum volume. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the minimum volume is obtained. ${value}`);
});

getMinVolume⁹⁺

getMinVolume(volumeType: AudioVolumeType): Promise<number>

获取指定流的最小音量，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<number>	Promise回调返回最小音量。

示例：

audioVolumeGroupManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value: number) => {
  console.info(`Promised returned to indicate that the minimum volume is obtained ${value}.`);
});

getMinVolumeSync¹⁰⁺

getMinVolumeSync(volumeType: AudioVolumeType): number;

获取指定流的最小音量，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
number	返回最小音量。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: number = audioVolumeGroupManager.getMinVolumeSync(audio.AudioVolumeType.MEDIA);
  console.info(`Indicate that the minimum volume is obtained ${value}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the minimum volume, error ${error}.`);
}

getMaxVolume⁹⁺

getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

获取指定流的最大音量，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<number>	是	回调返回最大音量大小。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: number) => {
  if (err) {
    console.error(`Failed to obtain the maximum volume. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the maximum volume is obtained. ${value}`);
});

getMaxVolume⁹⁺

getMaxVolume(volumeType: AudioVolumeType): Promise<number>

获取指定流的最大音量，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<number>	Promise回调返回最大音量大小。

示例：

audioVolumeGroupManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data: number) => {
  console.info('Promised returned to indicate that the maximum volume is obtained.');
});

getMaxVolumeSync¹⁰⁺

getMaxVolumeSync(volumeType: AudioVolumeType): number;

获取指定流的最大音量，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
number	返回最大音量大小。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: number = audioVolumeGroupManager.getMaxVolumeSync(audio.AudioVolumeType.MEDIA);
  console.info(`Indicate that the maximum volume is obtained. ${value}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the maximum volume, error ${error}.`);
}

mute⁹⁺

mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void>): void

设置指定音量流静音，使用callback方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
mute	boolean	是	静音状态，true为静音，false为非静音。
callback	AsyncCallback<void>	是	回调表示成功还是失败。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.mute(audio.AudioVolumeType.MEDIA, true, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to mute the stream. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the stream is muted.');
});

mute⁹⁺

mute(volumeType: AudioVolumeType, mute: boolean): Promise<void>

设置指定音量流静音，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
mute	boolean	是	静音状态，true为静音，false为非静音。

返回值：

类型	说明
Promise<void>	Promise回调表示成功还是失败。

示例：

audioVolumeGroupManager.mute(audio.AudioVolumeType.MEDIA, true).then(() => {
  console.info('Promise returned to indicate that the stream is muted.');
});

isMute⁹⁺

isMute(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): void

获取指定音量流是否被静音，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
callback	AsyncCallback<boolean>	是	回调返回流静音状态，true为静音，false为非静音。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.isMute(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: boolean) => {
  if (err) {
    console.error(`Failed to obtain the mute status. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the mute status of the stream is obtained ${value}.`);
});

isMute⁹⁺

isMute(volumeType: AudioVolumeType): Promise<boolean>

获取指定音量流是否被静音，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
Promise<boolean>	Promise回调返回流静音状态，true为静音，false为非静音。

示例：

audioVolumeGroupManager.isMute(audio.AudioVolumeType.MEDIA).then((value: boolean) => {
  console.info(`Promise returned to indicate that the mute status of the stream is obtained ${value}.`);
});

isMuteSync¹⁰⁺

isMuteSync(volumeType: AudioVolumeType): boolean

获取指定音量流是否被静音，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。

返回值：

类型	说明
boolean	返回流静音状态，true为静音，false为非静音。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: boolean = audioVolumeGroupManager.isMuteSync(audio.AudioVolumeType.MEDIA);
  console.info(`Indicate that the mute status of the stream is obtained ${value}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the mute status of the stream, error ${error}.`);
}

setRingerMode⁹⁺

setRingerMode(mode: AudioRingMode, callback: AsyncCallback<void>): void

设置铃声模式，使用callback方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
mode	AudioRingMode	是	音频铃声模式。
callback	AsyncCallback<void>	是	回调返回设置成功或失败。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to set the ringer mode. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful setting of the ringer mode.');
});

setRingerMode⁹⁺

setRingerMode(mode: AudioRingMode): Promise<void>

设置铃声模式，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
mode	AudioRingMode	是	音频铃声模式。

返回值：

类型	说明
Promise<void>	Promise回调返回设置成功或失败。

示例：

audioVolumeGroupManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() => {
  console.info('Promise returned to indicate a successful setting of the ringer mode.');
});

getRingerMode⁹⁺

getRingerMode(callback: AsyncCallback<AudioRingMode>): void

获取铃声模式，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioRingMode>	是	回调返回系统的铃声模式。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.getRingerMode((err: BusinessError, value: audio.AudioRingMode) => {
  if (err) {
    console.error(`Failed to obtain the ringer mode. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the ringer mode is obtained ${value}.`);
});

getRingerMode⁹⁺

getRingerMode(): Promise<AudioRingMode>

获取铃声模式，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

返回值：

类型	说明
Promise<AudioRingMode>	Promise回调返回系统的铃声模式。

示例：

audioVolumeGroupManager.getRingerMode().then((value: audio.AudioRingMode) => {
  console.info(`Promise returned to indicate that the ringer mode is obtained ${value}.`);
});

getRingerModeSync¹⁰⁺

getRingerModeSync(): AudioRingMode

获取铃声模式，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

返回值：

类型	说明
AudioRingMode	返回系统的铃声模式。

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: audio.AudioRingMode = audioVolumeGroupManager.getRingerModeSync();
  console.info(`Indicate that the ringer mode is obtained ${value}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the ringer mode, error ${error}.`);
}

on(‘ringerModeChange’)⁹⁺

on(type: ‘ringerModeChange’, callback: Callback<AudioRingMode>): void

监听铃声模式变化事件。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’ringerModeChange’（铃声模式变化事件，检测到铃声模式改变时，触发该事件）。
callback	Callback<AudioRingMode>	是	回调方法。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioVolumeGroupManager.on('ringerModeChange', (ringerMode: audio.AudioRingMode) => {
  console.info(`Updated ringermode: ${ringerMode}`);
});

setMicrophoneMute⁹⁺

setMicrophoneMute(mute: boolean, callback: AsyncCallback<void>): void

设置麦克风静音状态，使用callback方式异步返回结果。

需要权限： ohos.permission.MANAGE_AUDIO_CONFIG

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
mute	boolean	是	待设置的静音状态，true为静音，false为非静音。
callback	AsyncCallback<void>	是	回调返回设置成功或失败。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.setMicrophoneMute(true, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to mute the microphone. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the microphone is muted.');
});

setMicrophoneMute⁹⁺

setMicrophoneMute(mute: boolean): Promise<void>

设置麦克风静音状态，使用Promise方式异步返回结果。

需要权限： ohos.permission.MANAGE_AUDIO_CONFIG

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
mute	boolean	是	待设置的静音状态，true为静音，false为非静音。

返回值：

类型	说明
Promise<void>	Promise回调返回设置成功或失败。

示例：

audioVolumeGroupManager.setMicrophoneMute(true).then(() => {
  console.info('Promise returned to indicate that the microphone is muted.');
});

isMicrophoneMute⁹⁺

isMicrophoneMute(callback: AsyncCallback<boolean>): void

获取麦克风静音状态，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	回调返回系统麦克风静音状态，true为静音，false为非静音。

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.isMicrophoneMute((err: BusinessError, value: boolean) => {
  if (err) {
    console.error(`Failed to obtain the mute status of the microphone. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the mute status of the microphone is obtained ${value}.`);
});

isMicrophoneMute⁹⁺

isMicrophoneMute(): Promise<boolean>

获取麦克风静音状态，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

返回值：

类型	说明
Promise<boolean>	Promise回调返回系统麦克风静音状态，true为静音，false为非静音。

示例：

audioVolumeGroupManager.isMicrophoneMute().then((value: boolean) => {
  console.info(`Promise returned to indicate that the mute status of the microphone is obtained ${value}.`);
});

isMicrophoneMuteSync¹⁰⁺

isMicrophoneMuteSync(): boolean

获取麦克风静音状态，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

返回值：

类型	说明
boolean	返回系统麦克风静音状态，true为静音，false为非静音。

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: boolean = audioVolumeGroupManager.isMicrophoneMuteSync();
  console.info(`Indicate that the mute status of the microphone is obtained ${value}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the mute status of the microphone, error ${error}.`);
}

on(‘micStateChange’)⁹⁺

on(type: ‘micStateChange’, callback: Callback<MicStateChangeEvent>): void

监听系统麦克风状态更改事件。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’micStateChange’（系统麦克风状态变化事件，检测到系统麦克风状态改变时，触发该事件）。
callback	Callback<MicStateChangeEvent>	是	回调方法，返回变更后的麦克风状态。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioVolumeGroupManager.on('micStateChange', (micStateChange: audio.MicStateChangeEvent) => {
  console.info(`Current microphone status is: ${micStateChange.mute} `);
});

isVolumeUnadjustable¹⁰⁺

isVolumeUnadjustable(): boolean

获取固定音量模式开关状态，打开时进入固定音量模式，此时音量固定无法被调节，使用同步方式返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

返回值：

类型	说明
boolean	同步接口，返回固定音量模式开关状态，true为固定音量模式，false为非固定音量模式。

示例：

let volumeAdjustSwitch: boolean = audioVolumeGroupManager.isVolumeUnadjustable();
console.info(`Whether it is volume unadjustable: ${volumeAdjustSwitch}.`);

adjustVolumeByStep¹⁰⁺

adjustVolumeByStep(adjustType: VolumeAdjustType, callback: AsyncCallback<void>): void

调节当前最高优先级的流的音量，使音量值按步长加或减，使用callback方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
adjustType	VolumeAdjustType	是	音量调节方向。
callback	AsyncCallback<void>	是	回调表示成功还是失败。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by callback.
6800301	System error. Return by callback.

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.adjustVolumeByStep(audio.VolumeAdjustType.VOLUME_UP, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to adjust the volume by step. ${err}`);
    return;
  } else {
    console.info('Success to adjust the volume by step.');
  }
});

adjustVolumeByStep¹⁰⁺

adjustVolumeByStep(adjustType: VolumeAdjustType): Promise<void>

单步设置当前最高优先级的流的音量，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
adjustType	VolumeAdjustType	是	音量调节方向。

返回值：

类型	说明
Promise<void>	Promise回调表示成功还是失败。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by promise.
6800301	System error. Return by promise.

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.adjustVolumeByStep(audio.VolumeAdjustType.VOLUME_UP).then(() => {
  console.info('Success to adjust the volume by step.');
}).catch((error: BusinessError) => {
  console.error('Fail to adjust the volume by step.');
});

adjustSystemVolumeByStep¹⁰⁺

adjustSystemVolumeByStep(volumeType: AudioVolumeType, adjustType: VolumeAdjustType, callback: AsyncCallback<void>): void

单步设置指定流的音量，使用callback方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
adjustType	VolumeAdjustType	是	音量调节方向。
callback	AsyncCallback<void>	是	回调表示成功还是失败。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by callback.
6800301	System error. Return by callback.

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.adjustSystemVolumeByStep(audio.AudioVolumeType.MEDIA, audio.VolumeAdjustType.VOLUME_UP, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to adjust the system volume by step ${err}`);
  } else {
    console.info('Success to adjust the system volume by step.');
  }
});

adjustSystemVolumeByStep¹⁰⁺

adjustSystemVolumeByStep(volumeType: AudioVolumeType, adjustType: VolumeAdjustType): Promise<void>

单步设置指定流的音量，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

仅设置铃声（即volumeType为AudioVolumeType.RINGTONE）在静音和非静音状态切换时需要该权限。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
adjustType	VolumeAdjustType	是	音量调节方向。

返回值：

类型	说明
Promise<void>	Promise回调表示成功还是失败。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by promise.
6800301	System error. Return by promise.

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.adjustSystemVolumeByStep(audio.AudioVolumeType.MEDIA, audio.VolumeAdjustType.VOLUME_UP).then(() => {
  console.info('Success to adjust the system volume by step.');
}).catch((error: BusinessError) => {
  console.error('Fail to adjust the system volume by step.');
});

getSystemVolumeInDb¹⁰⁺

getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: DeviceType, callback: AsyncCallback<number>): void

获取音量增益dB值，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volumeLevel	number	是	音量等级。
device	DeviceType	是	设备类型。
callback	AsyncCallback<number>	是	回调返回对应的音量增益dB值。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by callback.
6800301	System error. Return by callback.

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.getSystemVolumeInDb(audio.AudioVolumeType.MEDIA, 3, audio.DeviceType.SPEAKER, (err: BusinessError, dB: number) => {
  if (err) {
    console.error(`Failed to get the volume DB. ${err}`);
  } else {
    console.info(`Success to get the volume DB. ${dB}`);
  }
});

getSystemVolumeInDb¹⁰⁺

getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: DeviceType): Promise<number>

获取音量增益dB值，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volumeLevel	number	是	音量等级。
device	DeviceType	是	设备类型。

返回值：

类型	说明
Promise<number>	Promise回调返回对应的音量增益dB值。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by promise.
6800301	System error. Return by promise.

示例：

import { BusinessError } from '@ohos.base';
audioVolumeGroupManager.getSystemVolumeInDb(audio.AudioVolumeType.MEDIA, 3, audio.DeviceType.SPEAKER).then((value: number) => {
  console.info(`Success to get the volume DB. ${value}`);
}).catch((error: BusinessError) => {
  console.error(`Fail to adjust the system volume by step. ${error}`);
});

getSystemVolumeInDbSync¹⁰⁺

getSystemVolumeInDbSync(volumeType: AudioVolumeType, volumeLevel: number, device: DeviceType): number

获取音量增益dB值，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Volume

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volumeLevel	number	是	音量等级。
device	DeviceType	是	设备类型。

返回值：

类型	说明
number	返回对应的音量增益dB值。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: number = audioVolumeGroupManager.getSystemVolumeInDbSync(audio.AudioVolumeType.MEDIA, 3, audio.DeviceType.SPEAKER);
  console.info(`Success to get the volume DB. ${value}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Fail to adjust the system volume by step. ${error}`);
}

AudioStreamManager⁹⁺

管理音频流。在使用AudioStreamManager的API前，需要使用getStreamManager获取AudioStreamManager实例。

getCurrentAudioRendererInfoArray⁹⁺

getCurrentAudioRendererInfoArray(callback: AsyncCallback<AudioRendererChangeInfoArray>): void

获取当前音频渲染器的信息。使用callback异步回调。

系统能力: SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioRendererChangeInfoArray>	是	回调函数，返回当前音频渲染器的信息。

示例：

import { BusinessError } from '@ohos.base';
audioStreamManager.getCurrentAudioRendererInfoArray(async (err: BusinessError, AudioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray) => {
  console.info('getCurrentAudioRendererInfoArray **** Get Callback Called ****');
  if (err) {
    console.error(`getCurrentAudioRendererInfoArray :ERROR: ${err}`);
  } else {
    if (AudioRendererChangeInfoArray != null) {
      for (let i = 0; i < AudioRendererChangeInfoArray.length; i++) {
        let AudioRendererChangeInfo: audio.AudioRendererChangeInfo = AudioRendererChangeInfoArray[i];
        console.info(`StreamId for ${i} is: ${AudioRendererChangeInfo.streamId}`);
        console.info(`ClientUid for ${i} is: ${AudioRendererChangeInfo.clientUid}`);
        console.info(`Content ${i} is: ${AudioRendererChangeInfo.rendererInfo.content}`);
        console.info(`Stream ${i} is: ${AudioRendererChangeInfo.rendererInfo.usage}`);
        console.info(`Flag ${i} is: ${AudioRendererChangeInfo.rendererInfo.rendererFlags}`);
        console.info(`State for ${i} is: ${AudioRendererChangeInfo.rendererState}`);
        for (let j = 0;j < AudioRendererChangeInfo.deviceDescriptors.length; j++) {
          console.info(`Id: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].id}`);
          console.info(`Type: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceType}`);
          console.info(`Role: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceRole}`);
          console.info(`Name: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].name}`);
          console.info(`Address: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].address}`);
          console.info(`SampleRate: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].sampleRates[0]}`);
          console.info(`ChannelCount: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelCounts[0]}`);
          console.info(`ChannelMask: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelMasks[0]}`);
        }
      }
    }
  }
});

getCurrentAudioRendererInfoArray⁹⁺

getCurrentAudioRendererInfoArray(): Promise<AudioRendererChangeInfoArray>

获取当前音频渲染器的信息。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<AudioRendererChangeInfoArray>	Promise对象，返回当前音频渲染器信息。

示例：

import { BusinessError } from '@ohos.base';
async function getCurrentAudioRendererInfoArray(){
  await audioStreamManager.getCurrentAudioRendererInfoArray().then((AudioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray) => {
    console.info(`getCurrentAudioRendererInfoArray ######### Get Promise is called ##########`);
    if (AudioRendererChangeInfoArray != null) {
      for (let i = 0; i < AudioRendererChangeInfoArray.length; i++) {
        let AudioRendererChangeInfo: audio.AudioRendererChangeInfo = AudioRendererChangeInfoArray[i];
        console.info(`StreamId for ${i} is: ${AudioRendererChangeInfo.streamId}`);
        console.info(`ClientUid for ${i} is: ${AudioRendererChangeInfo.clientUid}`);
        console.info(`Content ${i} is: ${AudioRendererChangeInfo.rendererInfo.content}`);
        console.info(`Stream ${i} is: ${AudioRendererChangeInfo.rendererInfo.usage}`);
        console.info(`Flag ${i} is: ${AudioRendererChangeInfo.rendererInfo.rendererFlags}`);
        console.info(`State for ${i} is: ${AudioRendererChangeInfo.rendererState}`);
        for (let j = 0;j < AudioRendererChangeInfo.deviceDescriptors.length; j++) {
          console.info(`Id: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].id}`);
          console.info(`Type: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceType}`);
          console.info(`Role: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceRole}`);
          console.info(`Name: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].name}`);
          console.info(`Address: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].address}`);
          console.info(`SampleRate: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].sampleRates[0]}`);
          console.info(`ChannelCount: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelCounts[0]}`);
          console.info(`ChannelMask: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelMasks[0]}`);
        }
      }
    }
  }).catch((err: BusinessError) => {
    console.error(`getCurrentAudioRendererInfoArray :ERROR: ${err}`);
  });
}

getCurrentAudioRendererInfoArraySync¹⁰⁺

getCurrentAudioRendererInfoArraySync(): AudioRendererChangeInfoArray

获取当前音频渲染器的信息，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
AudioRendererChangeInfoArray	返回当前音频渲染器信息。

示例：

import { BusinessError } from '@ohos.base';

try {
  let audioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray = audioStreamManager.getCurrentAudioRendererInfoArraySync();
  console.info(`getCurrentAudioRendererInfoArraySync success.`);
  if (audioRendererChangeInfoArray != null) {
    for (let i = 0; i < audioRendererChangeInfoArray.length; i++) {
      let AudioRendererChangeInfo: audio.AudioRendererChangeInfo = audioRendererChangeInfoArray[i];
      console.info(`StreamId for ${i} is: ${AudioRendererChangeInfo.streamId}`);
      console.info(`ClientUid for ${i} is: ${AudioRendererChangeInfo.clientUid}`);
      console.info(`Content ${i} is: ${AudioRendererChangeInfo.rendererInfo.content}`);
      console.info(`Stream ${i} is: ${AudioRendererChangeInfo.rendererInfo.usage}`);
      console.info(`Flag ${i} is: ${AudioRendererChangeInfo.rendererInfo.rendererFlags}`);
      console.info(`State for ${i} is: ${AudioRendererChangeInfo.rendererState}`);
      for (let j = 0;j < AudioRendererChangeInfo.deviceDescriptors.length; j++) {
        console.info(`Id: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].id}`);
        console.info(`Type: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceType}`);
        console.info(`Role: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceRole}`);
        console.info(`Name: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].name}`);
        console.info(`Address: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].address}`);
        console.info(`SampleRate: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].sampleRates[0]}`);
        console.info(`ChannelCount: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelCounts[0]}`);
        console.info(`ChannelMask: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelMasks[0]}`);
      }
    }
  }
} catch (err) {
  let error = err as BusinessError;
  console.error(`getCurrentAudioRendererInfoArraySync :ERROR: ${error}`);
}

getCurrentAudioCapturerInfoArray⁹⁺

getCurrentAudioCapturerInfoArray(callback: AsyncCallback<AudioCapturerChangeInfoArray>): void

获取当前音频采集器的信息。使用callback异步回调。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioCapturerChangeInfoArray>	是	回调函数，返回当前音频采集器的信息。

示例：

import { BusinessError } from '@ohos.base';
audioStreamManager.getCurrentAudioCapturerInfoArray(async (err: BusinessError, AudioCapturerChangeInfoArray: audio.AudioCapturerChangeInfoArray) => {
  console.info('getCurrentAudioCapturerInfoArray **** Get Callback Called ****');
  if (err) {
    console.error(`getCurrentAudioCapturerInfoArray :ERROR: ${err}`);
  } else {
    if (AudioCapturerChangeInfoArray != null) {
      for (let i = 0; i < AudioCapturerChangeInfoArray.length; i++) {
        console.info(`StreamId for ${i} is: ${AudioCapturerChangeInfoArray[i].streamId}`);
        console.info(`ClientUid for ${i} is: ${AudioCapturerChangeInfoArray[i].clientUid}`);
        console.info(`Source for ${i} is: ${AudioCapturerChangeInfoArray[i].capturerInfo.source}`);
        console.info(`Flag  ${i} is: ${AudioCapturerChangeInfoArray[i].capturerInfo.capturerFlags}`);
        console.info(`State for ${i} is: ${AudioCapturerChangeInfoArray[i].capturerState}`);
        for (let j = 0; j < AudioCapturerChangeInfoArray[i].deviceDescriptors.length; j++) {
          console.info(`Id: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].id}`);
          console.info(`Type: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceType}`);
          console.info(`Role: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceRole}`);
          console.info(`Name: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].name}`);
          console.info(`Address: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].address}`);
          console.info(`SampleRate: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].sampleRates[0]}`);
          console.info(`ChannelCount: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].channelCounts[0]}`);
          console.info(`ChannelMask: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].channelMasks[0]}`);
        }
      }
    }
  }
});

getCurrentAudioCapturerInfoArray⁹⁺

getCurrentAudioCapturerInfoArray(): Promise<AudioCapturerChangeInfoArray>

获取当前音频采集器的信息。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<AudioCapturerChangeInfoArray>	Promise对象，返回当前音频渲染器信息。

示例：

import { BusinessError } from '@ohos.base';
async function getCurrentAudioCapturerInfoArray(){
  await audioStreamManager.getCurrentAudioCapturerInfoArray().then((AudioCapturerChangeInfoArray: audio.AudioCapturerChangeInfoArray) => {
    console.info('getCurrentAudioCapturerInfoArray **** Get Promise Called ****');
    if (AudioCapturerChangeInfoArray != null) {
      for (let i = 0; i < AudioCapturerChangeInfoArray.length; i++) {
        console.info(`StreamId for ${i} is: ${AudioCapturerChangeInfoArray[i].streamId}`);
        console.info(`ClientUid for ${i} is: ${AudioCapturerChangeInfoArray[i].clientUid}`);
        console.info(`Source for ${i} is: ${AudioCapturerChangeInfoArray[i].capturerInfo.source}`);
        console.info(`Flag  ${i} is: ${AudioCapturerChangeInfoArray[i].capturerInfo.capturerFlags}`);
        console.info(`State for ${i} is: ${AudioCapturerChangeInfoArray[i].capturerState}`);
        for (let j = 0; j < AudioCapturerChangeInfoArray[i].deviceDescriptors.length; j++) {
          console.info(`Id: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].id}`);
          console.info(`Type: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceType}`);
          console.info(`Role: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceRole}`);
          console.info(`Name: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].name}`);
          console.info(`Address: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].address}`);
          console.info(`SampleRate: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].sampleRates[0]}`);
          console.info(`ChannelCount: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].channelCounts[0]}`);
          console.info(`ChannelMask: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].channelMasks[0]}`);
        }
      }
    }
  }).catch((err: BusinessError) => {
    console.error(`getCurrentAudioCapturerInfoArray :ERROR: ${err}`);
  });
}

getCurrentAudioCapturerInfoArraySync¹⁰⁺

getCurrentAudioCapturerInfoArraySync(): AudioCapturerChangeInfoArray

获取当前音频采集器的信息，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
AudioCapturerChangeInfoArray	返回当前音频采集器信息。

示例：

import { BusinessError } from '@ohos.base';

try {
  let audioCapturerChangeInfoArray: audio.AudioCapturerChangeInfoArray = audioStreamManager.getCurrentAudioCapturerInfoArraySync();
  console.info('getCurrentAudioCapturerInfoArraySync success.');
  if (audioCapturerChangeInfoArray != null) {
    for (let i = 0; i < audioCapturerChangeInfoArray.length; i++) {
      console.info(`StreamId for ${i} is: ${audioCapturerChangeInfoArray[i].streamId}`);
      console.info(`ClientUid for ${i} is: ${audioCapturerChangeInfoArray[i].clientUid}`);
      console.info(`Source for ${i} is: ${audioCapturerChangeInfoArray[i].capturerInfo.source}`);
      console.info(`Flag  ${i} is: ${audioCapturerChangeInfoArray[i].capturerInfo.capturerFlags}`);
      console.info(`State for ${i} is: ${audioCapturerChangeInfoArray[i].capturerState}`);
      for (let j = 0; j < audioCapturerChangeInfoArray[i].deviceDescriptors.length; j++) {
        console.info(`Id: ${i} : ${audioCapturerChangeInfoArray[i].deviceDescriptors[j].id}`);
        console.info(`Type: ${i} : ${audioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceType}`);
        console.info(`Role: ${i} : ${audioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceRole}`);
        console.info(`Name: ${i} : ${audioCapturerChangeInfoArray[i].deviceDescriptors[j].name}`);
        console.info(`Address: ${i} : ${audioCapturerChangeInfoArray[i].deviceDescriptors[j].address}`);
        console.info(`SampleRate: ${i} : ${audioCapturerChangeInfoArray[i].deviceDescriptors[j].sampleRates[0]}`);
        console.info(`ChannelCount: ${i} : ${audioCapturerChangeInfoArray[i].deviceDescriptors[j].channelCounts[0]}`);
        console.info(`ChannelMask: ${i} : ${audioCapturerChangeInfoArray[i].deviceDescriptors[j].channelMasks[0]}`);
      }
    }
  }
} catch (err) {
  let error = err as BusinessError;
  console.error(`getCurrentAudioCapturerInfoArraySync ERROR: ${error}`);
}

on(‘audioRendererChange’)⁹⁺

on(type: ‘audioRendererChange’, callback: Callback<AudioRendererChangeInfoArray>): void

监听音频渲染器更改事件。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	事件类型，支持的事件`'audioRendererChange'`：当音频渲染器发生更改时触发。
callback	Callback<AudioRendererChangeInfoArray>	是	回调函数。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioStreamManager.on('audioRendererChange',  (AudioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray) => {
  for (let i = 0; i < AudioRendererChangeInfoArray.length; i++) {
    let AudioRendererChangeInfo: audio.AudioRendererChangeInfo = AudioRendererChangeInfoArray[i];
    console.info(`## RendererChange on is called for ${i} ##`);
    console.info(`StreamId for ${i} is: ${AudioRendererChangeInfo.streamId}`);
    console.info(`ClientUid for ${i} is: ${AudioRendererChangeInfo.clientUid}`);
    console.info(`Content ${i} is: ${AudioRendererChangeInfo.rendererInfo.content}`);
    console.info(`Stream ${i} is: ${AudioRendererChangeInfo.rendererInfo.usage}`);
    console.info(`Flag ${i} is: ${AudioRendererChangeInfo.rendererInfo.rendererFlags}`);
    console.info(`State for ${i} is: ${AudioRendererChangeInfo.rendererState}`);
    for (let j = 0;j < AudioRendererChangeInfo.deviceDescriptors.length; j++) {
      console.info(`Id: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].id}`);
      console.info(`Type: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceType}`);
      console.info(`Role: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].deviceRole}`);
      console.info(`Name: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].name}`);
      console.info(`Address: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].address}`);
      console.info(`SampleRate: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].sampleRates[0]}`);
      console.info(`ChannelCount: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelCounts[0]}`);
      console.info(`ChannelMask: ${i} : ${AudioRendererChangeInfo.deviceDescriptors[j].channelMasks[0]}`);
    }
  }
});

off(‘audioRendererChange’)⁹⁺

off(type: ‘audioRendererChange’): void

取消监听音频渲染器更改事件。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	事件类型，支持的事件`'audioRendererChange'`：音频渲染器更改事件。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioStreamManager.off('audioRendererChange');
console.info('######### RendererChange Off is called #########');

on(‘audioCapturerChange’)⁹⁺

on(type: ‘audioCapturerChange’, callback: Callback<AudioCapturerChangeInfoArray>): void

监听音频采集器更改事件。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	事件类型，支持的事件`'audioCapturerChange'`：当音频采集器发生更改时触发。
callback	Callback<AudioCapturerChangeInfoArray>	是	回调函数。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioStreamManager.on('audioCapturerChange', (AudioCapturerChangeInfoArray: audio.AudioCapturerChangeInfoArray) =>  {
  for (let i = 0; i < AudioCapturerChangeInfoArray.length; i++) {
    console.info(`## CapChange on is called for element ${i} ##`);
    console.info(`StreamId for ${i} is: ${AudioCapturerChangeInfoArray[i].streamId}`);
    console.info(`ClientUid for ${i} is: ${AudioCapturerChangeInfoArray[i].clientUid}`);
    console.info(`Source for ${i} is: ${AudioCapturerChangeInfoArray[i].capturerInfo.source}`);
    console.info(`Flag  ${i} is: ${AudioCapturerChangeInfoArray[i].capturerInfo.capturerFlags}`);
    console.info(`State for ${i} is: ${AudioCapturerChangeInfoArray[i].capturerState}`);
    let devDescriptor: audio.AudioCapturerChangeInfo = AudioCapturerChangeInfoArray[i].deviceDescriptors;
    for (let j = 0; j < AudioCapturerChangeInfoArray[i].deviceDescriptors.length; j++) {
      console.info(`Id: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].id}`);
      console.info(`Type: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceType}`);
      console.info(`Role: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceRole}`);
      console.info(`Name: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].name}`);
      console.info(`Address: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].address}`);
      console.info(`SampleRate: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].sampleRates[0]}`);
      console.info(`ChannelCount: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].channelCounts[0]}`);
      console.info(`ChannelMask: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].channelMasks[0]}`);
    }
  }
});

off(‘audioCapturerChange’)⁹⁺

off(type: ‘audioCapturerChange’): void;

取消监听音频采集器更改事件。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	事件类型，支持的事件`'audioCapturerChange'`：音频采集器更改事件。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioStreamManager.off('audioCapturerChange');
console.info('######### CapturerChange Off is called #########');

isActive⁹⁺

isActive(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): void

获取指定音频流是否为活跃状态，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音频流类型。
callback	AsyncCallback<boolean>	是	回调返回流的活跃状态，true为活跃，false为不活跃。

示例：

import { BusinessError } from '@ohos.base';
audioStreamManager.isActive(audio.AudioVolumeType.MEDIA, (err: BusinessError, value: boolean) => {
if (err) {
  console.error(`Failed to obtain the active status of the stream. ${err}`);
  return;
}
  console.info(`Callback invoked to indicate that the active status of the stream is obtained ${value}.`);
});

isActive⁹⁺

isActive(volumeType: AudioVolumeType): Promise<boolean>

获取指定音频流是否为活跃状态，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音频流类型。

返回值：

类型	说明
Promise<boolean>	Promise回调返回流的活跃状态，true为活跃，false为不活跃。

示例：

audioStreamManager.isActive(audio.AudioVolumeType.MEDIA).then((value: boolean) => {
  console.info(`Promise returned to indicate that the active status of the stream is obtained ${value}.`);
});

isActiveSync¹⁰⁺

isActiveSync(volumeType: AudioVolumeType): boolean

获取指定音频流是否为活跃状态，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音频流类型。

返回值：

类型	说明
boolean	返回流的活跃状态，true为活跃，false为不活跃。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: boolean = audioStreamManager.isActiveSync(audio.AudioVolumeType.MEDIA);
  console.info(`Indicate that the active status of the stream is obtained ${value}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the active status of the stream ${error}.`);
}

getAudioEffectInfoArray¹⁰⁺

getAudioEffectInfoArray(usage: StreamUsage, callback: AsyncCallback<AudioEffectInfoArray>): void

获取当前音效模式的信息。使用callback异步回调。

系统能力: SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
usage	StreamUsage	是	音频流使用类型。
callback	AsyncCallback<AudioEffectInfoArray>	是	回调函数，返回当前音效模式的信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by callback.

示例：

import { BusinessError } from '@ohos.base';
audioStreamManager.getAudioEffectInfoArray(audio.StreamUsage.STREAM_USAGE_MEDIA, async (err: BusinessError, audioEffectInfoArray: audio.AudioEffectInfoArray) => {
  console.info('getAudioEffectInfoArray **** Get Callback Called ****');
  if (err) {
    console.error(`getAudioEffectInfoArray :ERROR: ${err}`);
    return;
  } else {
    console.info(`The effect modes are: ${audioEffectInfoArray}`);
  }
});

getAudioEffectInfoArray¹⁰⁺

getAudioEffectInfoArray(usage: StreamUsage): Promise<AudioEffectInfoArray>

获取当前音效模式的信息。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
usage	StreamUsage	是	音频流使用类型。

返回值：

类型	说明
Promise<AudioEffectInfoArray>	Promise对象，返回当前音效模式的信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by promise.

示例：

import { BusinessError } from '@ohos.base';
audioStreamManager.getAudioEffectInfoArray(audio.StreamUsage.STREAM_USAGE_MEDIA).then((audioEffectInfoArray: audio.AudioEffectInfoArray) => {
  console.info('getAudioEffectInfoArray ######### Get Promise is called ##########');
  console.info(`The effect modes are: ${audioEffectInfoArray}`);
}).catch((err: BusinessError) => {
  console.error(`getAudioEffectInfoArray :ERROR: ${err}`);
});

getAudioEffectInfoArraySync¹⁰⁺

getAudioEffectInfoArraySync(usage: StreamUsage): AudioEffectInfoArray

获取当前音效模式的信息，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
usage	StreamUsage	是	音频流使用类型。

返回值：

类型	说明
AudioEffectInfoArray	返回当前音效模式的信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let audioEffectInfoArray: audio.AudioEffectInfoArray = audioStreamManager.getAudioEffectInfoArraySync(audio.StreamUsage.STREAM_USAGE_MEDIA);
  console.info(`The effect modes are: ${audioEffectInfoArray}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`getAudioEffectInfoArraySync ERROR: ${error}`);
}

AudioRoutingManager⁹⁺

音频路由管理。在使用AudioRoutingManager的接口前，需要使用getRoutingManager获取AudioRoutingManager实例。

getDevices⁹⁺

getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors>): void

获取音频设备列表，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceFlag	DeviceFlag	是	设备类型的flag。
callback	AsyncCallback<AudioDeviceDescriptors>	是	回调，返回设备列表。

示例：

import { BusinessError } from '@ohos.base';
audioRoutingManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err: BusinessError, value: audio.AudioDeviceDescriptors) => {
  if (err) {
    console.error(`Failed to obtain the device list. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the device list is obtained.');
});

getDevices⁹⁺

getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors>

获取音频设备列表，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceFlag	DeviceFlag	是	设备类型的flag。

返回值：

类型	说明
Promise<AudioDeviceDescriptors>	Promise回调返回设备列表。

示例：

audioRoutingManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data: audio.AudioDeviceDescriptors) => {
  console.info('Promise returned to indicate that the device list is obtained.');
});

getDevicesSync¹⁰⁺

getDevicesSync(deviceFlag: DeviceFlag): AudioDeviceDescriptors

获取音频设备列表，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
deviceFlag	DeviceFlag	是	设备类型的flag。

返回值：

类型	说明
AudioDeviceDescriptors	返回设备列表。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let data: audio.AudioDeviceDescriptors = audioRoutingManager.getDevicesSync(audio.DeviceFlag.OUTPUT_DEVICES_FLAG);
  console.info(`Indicate that the device list is obtained ${data}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the device list. ${error}`);
}

on(‘deviceChange’)⁹⁺

on(type: ‘deviceChange’, deviceFlag: DeviceFlag, callback: Callback): void

设备更改。音频设备连接状态变化。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件的类型。支持事件：’deviceChange’
deviceFlag	DeviceFlag	是	设备类型的flag。
callback	Callback<DeviceChangeAction>	是	获取设备更新详情。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioRoutingManager.on('deviceChange', audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (deviceChanged: audio.DeviceChangeAction) => {
  console.info('device change type : ' + deviceChanged.type);
  console.info('device descriptor size : ' + deviceChanged.deviceDescriptors.length);
  console.info('device change descriptor : ' + deviceChanged.deviceDescriptors[0].deviceRole);
  console.info('device change descriptor : ' + deviceChanged.deviceDescriptors[0].deviceType);
});

off(‘deviceChange’)⁹⁺

off(type: ‘deviceChange’, callback?: Callback): void

取消订阅音频设备连接变化事件。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件的类型。支持事件：’deviceChange’
callback	Callback<DeviceChangeAction>	否	获取设备更新详情。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioRoutingManager.off('deviceChange');

selectInputDevice⁹⁺

selectInputDevice(inputAudioDevices: AudioDeviceDescriptors, callback: AsyncCallback<void>): void

选择音频输入设备，当前只能选择一个输入设备，使用callback方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
inputAudioDevices	AudioDeviceDescriptors	是	输入设备类。
callback	AsyncCallback<void>	是	回调，返回选择输入设备结果。

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let inputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.INPUT_DEVICE,
  deviceType : audio.DeviceType.EARPIECE,
  id : 1,
  name : "",
  address : "",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : "",
}];

async function selectInputDevice(){
  audioRoutingManager.selectInputDevice(inputAudioDeviceDescriptor, (err: BusinessError) => {
    if (err) {
      console.error(`Result ERROR: ${err}`);
    } else {
      console.info('Select input devices result callback: SUCCESS');
    }
  });
}

selectInputDevice⁹⁺

selectInputDevice(inputAudioDevices: AudioDeviceDescriptors): Promise<void>

系统接口： 该接口为系统接口

选择音频输入设备，当前只能选择一个输入设备，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
inputAudioDevices	AudioDeviceDescriptors	是	输入设备类。

返回值：

类型	说明
Promise<void>	Promise返回选择输入设备结果。

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let inputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.INPUT_DEVICE,
  deviceType : audio.DeviceType.EARPIECE,
  id : 1,
  name : "",
  address : "",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : "",
}];

async function getRoutingManager(){
  audioRoutingManager.selectInputDevice(inputAudioDeviceDescriptor).then(() => {
    console.info('Select input devices result promise: SUCCESS');
  }).catch((err: BusinessError) => {
    console.error(`Result ERROR: ${err}`);
  });
}

setCommunicationDevice⁹⁺

setCommunicationDevice(deviceType: CommunicationDeviceType, active: boolean, callback: AsyncCallback<void>): void

设置通信设备激活状态，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
deviceType	CommunicationDeviceType	是	音频设备类型。
active	boolean	是	设备激活状态。
callback	AsyncCallback<void>	是	回调返回设置成功或失败。

示例：

import { BusinessError } from '@ohos.base';
audioRoutingManager.setCommunicationDevice(audio.CommunicationDeviceType.SPEAKER, true, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to set the active status of the device. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the device is set to the active status.');
});

setCommunicationDevice⁹⁺

setCommunicationDevice(deviceType: CommunicationDeviceType, active: boolean): Promise<void>

设置通信设备激活状态，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
deviceType	CommunicationDeviceType	是	活跃音频设备类型。
active	boolean	是	设备激活状态。

返回值：

类型	说明
Promise<void>	Promise回调返回设置成功或失败。

示例：

audioRoutingManager.setCommunicationDevice(audio.CommunicationDeviceType.SPEAKER, true).then(() => {
  console.info('Promise returned to indicate that the device is set to the active status.');
});

isCommunicationDeviceActive⁹⁺

isCommunicationDeviceActive(deviceType: CommunicationDeviceType, callback: AsyncCallback<boolean>): void

获取指定通信设备的激活状态，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
deviceType	CommunicationDeviceType	是	活跃音频设备类型。
callback	AsyncCallback<boolean>	是	回调返回设备的激活状态。

示例：

import { BusinessError } from '@ohos.base';
audioRoutingManager.isCommunicationDeviceActive(audio.CommunicationDeviceType.SPEAKER, (err: BusinessError, value: boolean) => {
  if (err) {
    console.error(`Failed to obtain the active status of the device. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the active status of the device is obtained.');
});

isCommunicationDeviceActive⁹⁺

isCommunicationDeviceActive(deviceType: CommunicationDeviceType): Promise<boolean>

获取指定通信设备的激活状态，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
deviceType	CommunicationDeviceType	是	活跃音频设备类型。

返回值：

Type	Description
Promise<boolean>	Promise回调返回设备的激活状态。

示例：

audioRoutingManager.isCommunicationDeviceActive(audio.CommunicationDeviceType.SPEAKER).then((value: boolean) => {
  console.info(`Promise returned to indicate that the active status of the device is obtained ${value}.`);
});

isCommunicationDeviceActiveSync¹⁰⁺

isCommunicationDeviceActiveSync(deviceType: CommunicationDeviceType): boolean

获取指定通信设备的激活状态，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Communication

参数：

参数名	类型	必填	说明
deviceType	CommunicationDeviceType	是	活跃音频设备类型。

返回值：

Type	Description
boolean	返回设备的激活状态。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: boolean = audioRoutingManager.isCommunicationDeviceActiveSync(audio.CommunicationDeviceType.SPEAKER);
  console.info(`Indicate that the active status of the device is obtained ${value}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to obtain the active status of the device ${error}.`);
}

selectOutputDevice⁹⁺

selectOutputDevice(outputAudioDevices: AudioDeviceDescriptors, callback: AsyncCallback<void>): void

选择音频输出设备，当前只能选择一个输出设备，使用callback方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
outputAudioDevices	AudioDeviceDescriptors	是	输出设备类。
callback	AsyncCallback<void>	是	回调，返回获取输出设备结果。

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let outputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.SPEAKER,
  id : 1,
  name : "",
  address : "",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : "",
}];

async function selectOutputDevice(){
  audioRoutingManager.selectOutputDevice(outputAudioDeviceDescriptor, (err: BusinessError) => {
    if (err) {
      console.error(`Result ERROR: ${err}`);
    } else {
      console.info('Select output devices result callback: SUCCESS'); }
  });
}

selectOutputDevice⁹⁺

selectOutputDevice(outputAudioDevices: AudioDeviceDescriptors): Promise<void>

系统接口： 该接口为系统接口

选择音频输出设备，当前只能选择一个输出设备，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
outputAudioDevices	AudioDeviceDescriptors	是	输出设备类。

返回值：

类型	说明
Promise<void>	Promise返回选择输出设备结果。

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let outputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.SPEAKER,
  id : 1,
  name : "",
  address : "",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : "",
}];

async function selectOutputDevice(){
  audioRoutingManager.selectOutputDevice(outputAudioDeviceDescriptor).then(() => {
    console.info('Select output devices result promise: SUCCESS');
  }).catch((err: BusinessError) => {
    console.error(`Result ERROR: ${err}`);
  });
}

selectOutputDeviceByFilter⁹⁺

selectOutputDeviceByFilter(filter: AudioRendererFilter, outputAudioDevices: AudioDeviceDescriptors, callback: AsyncCallback<void>): void

系统接口： 该接口为系统接口

根据过滤条件，选择音频输出设备，当前只能选择一个输出设备，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
filter	AudioRendererFilter	是	过滤条件类。
outputAudioDevices	AudioDeviceDescriptors	是	输出设备类。
callback	AsyncCallback<void>	是	回调，返回获取输出设备结果。

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let outputAudioRendererFilter: audio.AudioRendererFilter = {
  uid : 20010041,
  rendererInfo : {
    content : audio.ContentType.CONTENT_TYPE_MUSIC,
    usage : audio.StreamUsage.STREAM_USAGE_MEDIA,
    rendererFlags : 0
  },
  rendererId : 0
};

let outputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.SPEAKER,
  id : 1,
  name : "",
  address : "",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : "",
}];

async function selectOutputDeviceByFilter(){
  audioRoutingManager.selectOutputDeviceByFilter(outputAudioRendererFilter, outputAudioDeviceDescriptor, (err: BusinessError) => {
    if (err) {
      console.error(`Result ERROR: ${err}`);
    } else {
      console.info('Select output devices by filter result callback: SUCCESS'); }
  });
}

selectOutputDeviceByFilter⁹⁺

selectOutputDeviceByFilter(filter: AudioRendererFilter, outputAudioDevices: AudioDeviceDescriptors): Promise<void>

系统接口： 该接口为系统接口

根据过滤条件，选择音频输出设备，当前只能选择一个输出设备，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
filter	AudioRendererFilter	是	过滤条件类。
outputAudioDevices	AudioDeviceDescriptors	是	输出设备类。

返回值：

类型	说明
Promise<void>	Promise返回选择输出设备结果。

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let outputAudioRendererFilter: audio.AudioRendererFilter = {
  uid : 20010041,
  rendererInfo : {
    content : audio.ContentType.CONTENT_TYPE_MUSIC,
    usage : audio.StreamUsage.STREAM_USAGE_MEDIA,
    rendererFlags : 0
  },
  rendererId : 0
};

let outputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.SPEAKER,
  id : 1,
  name : "",
  address : "",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : "",
}];

async function selectOutputDeviceByFilter(){
  audioRoutingManager.selectOutputDeviceByFilter(outputAudioRendererFilter, outputAudioDeviceDescriptor).then(() => {
    console.info('Select output devices by filter result promise: SUCCESS');
  }).catch((err: BusinessError) => {
    console.error(`Result ERROR: ${err}`);
  })
}

getPreferOutputDeviceForRendererInfo¹⁰⁺

getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback<AudioDeviceDescriptors>): void

根据音频信息，返回优先级最高的输出设备，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
rendererInfo	AudioRendererInfo	是	表示渲染器信息。
callback	AsyncCallback<AudioDeviceDescriptors>	是	回调，返回优先级最高的输出设备信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Input parameter value error. Return by callback.
6800301	System error. Return by callback.

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let rendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags : 0
}

async function getPreferOutputDevice() {
  audioRoutingManager.getPreferOutputDeviceForRendererInfo(rendererInfo, (err: BusinessError, desc: audio.AudioDeviceDescriptors) => {
    if (err) {
      console.error(`Result ERROR: ${err}`);
    } else {
      console.info(`device descriptor: ${desc}`);
    }
  });
}

getPreferOutputDeviceForRendererInfo¹⁰⁺

getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise<AudioDeviceDescriptors>

根据音频信息，返回优先级最高的输出设备，使用promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
rendererInfo	AudioRendererInfo	是	表示渲染器信息。

返回值：

类型	说明
Promise<AudioDeviceDescriptors>	Promise返回优先级最高的输出设备信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Input parameter value error. Return by promise.
6800301	System error. Return by promise.

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let rendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags : 0
}

async function getPreferOutputDevice() {
  audioRoutingManager.getPreferOutputDeviceForRendererInfo(rendererInfo).then((desc: audio.AudioDeviceDescriptors) => {
    console.info(`device descriptor: ${desc}`);
  }).catch((err: BusinessError) => {
    console.error(`Result ERROR: ${err}`);
  })
}

getPreferredOutputDeviceForRendererInfoSync¹⁰⁺

getPreferredOutputDeviceForRendererInfoSync(rendererInfo: AudioRendererInfo): AudioDeviceDescriptors

根据音频信息，返回优先级最高的输出设备，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
rendererInfo	AudioRendererInfo	是	表示渲染器信息。

返回值：

类型	说明
AudioDeviceDescriptors	返回优先级最高的输出设备信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error.

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';

let rendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags : 0
}

try {
  let desc: audio.AudioDeviceDescriptors = audioRoutingManager.getPreferredOutputDeviceForRendererInfoSync(rendererInfo);
  console.info(`device descriptor: ${desc}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Result ERROR: ${error}`);
}

on(‘preferOutputDeviceChangeForRendererInfo’)¹⁰⁺

on(type: ‘preferOutputDeviceChangeForRendererInfo’, rendererInfo: AudioRendererInfo, callback: Callback): void

订阅最高优先级输出设备变化事件，使用callback获取最高优先级输出设备。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件的类型。支持事件：’preferOutputDeviceChangeForRendererInfo’
rendererInfo	AudioRendererInfo	是	表示渲染器信息。
callback	Callback<AudioDeviceDescriptors>	是	获取优先级最高的输出设备信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

import audio from '@ohos.multimedia.audio';
let rendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags : 0
}

audioRoutingManager.on('preferOutputDeviceChangeForRendererInfo', rendererInfo, (desc: audio.AudioDeviceDescriptors) => {
  console.info(`device descriptor: ${desc}`);
});

off(‘preferOutputDeviceChangeForRendererInfo’)¹⁰⁺

off(type: ‘preferOutputDeviceChangeForRendererInfo’, callback?: Callback): void

取消订阅最高优先级输出音频设备变化事件。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件的类型。支持事件：’preferOutputDeviceChangeForRendererInfo’
callback	Callback<AudioDeviceDescriptors>	否	监听方法的回调函数。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioRoutingManager.off('preferOutputDeviceChangeForRendererInfo');

getPreferredInputDeviceForCapturerInfo¹⁰⁺

getPreferredInputDeviceForCapturerInfo(capturerInfo: AudioCapturerInfo, callback: AsyncCallback<AudioDeviceDescriptors>): void

根据音频信息，返回优先级最高的输入设备，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
capturerInfo	AudioCapturerInfo	是	表示采集器信息。
callback	AsyncCallback<AudioDeviceDescriptors>	是	回调，返回优先级最高的输入设备信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by callback.
6800301	System error. Return by callback.

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let capturerInfo: audio.AudioCapturerInfo = {
  source: audio.SourceType.SOURCE_TYPE_MIC,
  capturerFlags: 0
}

audioRoutingManager.getPreferredInputDeviceForCapturerInfo(capturerInfo, (err: BusinessError, desc: audio.AudioDeviceDescriptors) => {
  if (err) {
    console.error(`Result ERROR: ${err}`);
  } else {
    console.info(`device descriptor: ${desc}`);
  }
});

getPreferredInputDeviceForCapturerInfo¹⁰⁺

getPreferredInputDeviceForCapturerInfo(capturerInfo: AudioCapturerInfo): Promise<AudioDeviceDescriptors>

根据音频信息，返回优先级最高的输入设备，使用promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
capturerInfo	AudioCapturerInfo	是	表示采集器信息。

返回值：

类型	说明
Promise<AudioDeviceDescriptors>	Promise返回优先级最高的输入设备信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by promise.
6800301	System error. Return by promise.

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
let capturerInfo: audio.AudioCapturerInfo = {
  source: audio.SourceType.SOURCE_TYPE_MIC,
  capturerFlags: 0
}

audioRoutingManager.getPreferredInputDeviceForCapturerInfo(capturerInfo).then((desc: audio.AudioDeviceDescriptors) => {
  console.info(`device descriptor: ${desc}`);
}).catch((err: BusinessError) => {
  console.error(`Result ERROR: ${err}`);
});

getPreferredInputDeviceForCapturerInfoSync¹⁰⁺

getPreferredInputDeviceForCapturerInfoSync(capturerInfo: AudioCapturerInfo): AudioDeviceDescriptors

根据音频信息，返回优先级最高的输入设备，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
capturerInfo	AudioCapturerInfo	是	表示采集器信息。

返回值：

类型	说明
AudioDeviceDescriptors	返回优先级最高的输入设备信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';

let capturerInfo: audio.AudioCapturerInfo = {
  source: audio.SourceType.SOURCE_TYPE_MIC,
  capturerFlags: 0
}

try {
  let desc: audio.AudioDeviceDescriptors = audioRoutingManager.getPreferredInputDeviceForCapturerInfoSync(capturerInfo);
  console.info(`device descriptor: ${desc}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Result ERROR: ${error}`);
}

on(‘preferredInputDeviceChangeForCapturerInfo’)¹⁰⁺

on(type: ‘preferredInputDeviceChangeForCapturerInfo’, capturerInfo: AudioCapturerInfo, callback: Callback): void

订阅最高优先级输入设备变化事件，使用callback获取最高优先级输入设备。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件的类型。支持事件：’preferredInputDeviceChangeForCapturerInfo’
capturerInfo	AudioCapturerInfo	是	表示采集器信息。
callback	Callback<AudioDeviceDescriptors>	是	获取优先级最高的输入设备信息。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

import audio from '@ohos.multimedia.audio';
let capturerInfo: audio.AudioCapturerInfo = {
  source: audio.SourceType.SOURCE_TYPE_MIC,
  capturerFlags: 0
}

audioRoutingManager.on('preferredInputDeviceChangeForCapturerInfo', capturerInfo, (desc: audio.AudioDeviceDescriptors) => {
  console.info(`device descriptor: ${desc}`);
});

off(‘preferredInputDeviceChangeForCapturerInfo’)¹⁰⁺

off(type: ‘preferredInputDeviceChangeForCapturerInfo’, callback?: Callback): void

取消订阅最高优先级输入音频设备变化事件。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件的类型。支持事件：’preferredInputDeviceChangeForCapturerInfo’
callback	Callback<AudioDeviceDescriptors>	否	监听方法的回调函数。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioRoutingManager.off('preferredInputDeviceChangeForCapturerInfo');

AudioRendererChangeInfoArray⁹⁺

数组类型，AudioRenderChangeInfo数组，只读。

系统能力： SystemCapability.Multimedia.Audio.Renderer

AudioRendererChangeInfo⁹⁺

描述音频渲染器更改信息。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	类型	可读	可写	说明
streamId	number	是	否	音频流唯一id。
clientUid	number	是	否	音频渲染器客户端应用程序的Uid。此接口为系统接口。
rendererInfo	AudioRendererInfo	是	否	音频渲染器信息。
rendererState	AudioState	是	否	音频状态。此接口为系统接口。
deviceDescriptors	AudioDeviceDescriptors	是	否	音频设备描述。

示例：

import audio from '@ohos.multimedia.audio';

const audioManager = audio.getAudioManager();
let audioStreamManager = audioManager.getStreamManager();
let resultFlag = false;

audioStreamManager.on('audioRendererChange',  (AudioRendererChangeInfoArray) => {
  for (let i = 0; i < AudioRendererChangeInfoArray.length; i++) {
    console.info(`## RendererChange on is called for ${i} ##`);
    console.info(`StreamId for ${i} is: ${AudioRendererChangeInfoArray[i].streamId}`);
    console.info(`ClientUid for ${i} is: ${AudioRendererChangeInfoArray[i].clientUid}`);
    console.info(`Content for ${i} is: ${AudioRendererChangeInfoArray[i].rendererInfo.content}`);
    console.info(`Stream for ${i} is: ${AudioRendererChangeInfoArray[i].rendererInfo.usage}`);
    console.info(`Flag ${i} is: ${AudioRendererChangeInfoArray[i].rendererInfo.rendererFlags}`);
    console.info(`State for ${i} is: ${AudioRendererChangeInfoArray[i].rendererState}`);
    let devDescriptor = AudioRendererChangeInfoArray[i].deviceDescriptors;
    for (let j = 0; j < AudioRendererChangeInfoArray[i].deviceDescriptors.length; j++) {
      console.info(`Id: ${i} : ${AudioRendererChangeInfoArray[i].deviceDescriptors[j].id}`);
      console.info(`Type: ${i} : ${AudioRendererChangeInfoArray[i].deviceDescriptors[j].deviceType}`);
      console.info(`Role: ${i} : ${AudioRendererChangeInfoArray[i].deviceDescriptors[j].deviceRole}`);
      console.info(`Name: ${i} : ${AudioRendererChangeInfoArray[i].deviceDescriptors[j].name}`);
      console.info(`Addr: ${i} : ${AudioRendererChangeInfoArray[i].deviceDescriptors[j].address}`);
      console.info(`SR: ${i} : ${AudioRendererChangeInfoArray[i].deviceDescriptors[j].sampleRates[0]}`);
      console.info(`C ${i} : ${AudioRendererChangeInfoArray[i].deviceDescriptors[j].channelCounts[0]}`);
      console.info(`CM: ${i} : ${AudioRendererChangeInfoArray[i].deviceDescriptors[j].channelMasks[0]}`);
    }
    if (AudioRendererChangeInfoArray[i].rendererState == 1 && devDescriptor != null) {
      resultFlag = true;
      console.info(`ResultFlag for ${i} is: ${resultFlag}`);
    }
  }
});

AudioCapturerChangeInfoArray⁹⁺

数组类型，AudioCapturerChangeInfo数组，只读。

系统能力： SystemCapability.Multimedia.Audio.Capturer

AudioCapturerChangeInfo⁹⁺

描述音频采集器更改信息。

系统能力： SystemCapability.Multimedia.Audio.Capturer

名称	类型	可读	可写	说明
streamId	number	是	否	音频流唯一id。
clientUid	number	是	否	音频采集器客户端应用程序的Uid。此接口为系统接口。
capturerInfo	AudioCapturerInfo	是	否	音频采集器信息。
capturerState	AudioState	是	否	音频状态。此接口为系统接口。
deviceDescriptors	AudioDeviceDescriptors	是	否	音频设备描述。
muted¹¹⁺	boolean	是	否	音频采集器静音状态。true表示音频采集器为静音状态，false表示音频采集器为非静音状态。

示例：

import audio from '@ohos.multimedia.audio';

const audioManager = audio.getAudioManager();
let audioStreamManager = audioManager.getStreamManager();

let resultFlag = false;
audioStreamManager.on('audioCapturerChange', (AudioCapturerChangeInfoArray) =>  {
  for (let i = 0; i < AudioCapturerChangeInfoArray.length; i++) {
    console.info(`## CapChange on is called for element ${i} ##`);
    console.info(`StrId for  ${i} is: ${AudioCapturerChangeInfoArray[i].streamId}`);
    console.info(`CUid for ${i} is: ${AudioCapturerChangeInfoArray[i].clientUid}`);
    console.info(`Src for ${i} is: ${AudioCapturerChangeInfoArray[i].capturerInfo.source}`);
    console.info(`Flag ${i} is: ${AudioCapturerChangeInfoArray[i].capturerInfo.capturerFlags}`);
    console.info(`State for ${i} is: ${AudioCapturerChangeInfoArray[i].capturerState}`);
    let devDescriptor = AudioCapturerChangeInfoArray[i].deviceDescriptors;
    for (let j = 0; j < AudioCapturerChangeInfoArray[i].deviceDescriptors.length; j++) {
      console.info(`Id: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].id}`);
      console.info(`Type: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceType}`);
      console.info(`Role: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].deviceRole}`);
      console.info(`Name: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].name}`);
      console.info(`Addr: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].address}`);
      console.info(`SR: ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].sampleRates[0]}`);
      console.info(`C ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].channelCounts[0]}`);
      console.info(`CM ${i} : ${AudioCapturerChangeInfoArray[i].deviceDescriptors[j].channelMasks[0]}`);
    }
    if (AudioCapturerChangeInfoArray[i].capturerState == 1 && devDescriptor != null) {
      resultFlag = true;
      console.info(`ResultFlag for element ${i} is: ${resultFlag}`);
    }
  }
});

AudioEffectInfoArray¹⁰⁺

待查询ContentType和StreamUsage组合场景下的音效模式数组类型，AudioEffectMode数组，只读。

AudioDeviceDescriptors

设备属性数组类型，为AudioDeviceDescriptor的数组，只读。

AudioDeviceDescriptor

描述音频设备。

名称	类型	可读	可写	说明
deviceRole	DeviceRole	是	否	设备角色。系统能力： SystemCapability.Multimedia.Audio.Device
deviceType	DeviceType	是	否	设备类型。系统能力： SystemCapability.Multimedia.Audio.Device
id⁹⁺	number	是	否	设备id，唯一。系统能力： SystemCapability.Multimedia.Audio.Device
name⁹⁺	string	是	否	设备名称。如果是蓝牙设备，需要申请权限ohos.permission.USE_BLUETOOTH。系统能力： SystemCapability.Multimedia.Audio.Device
address⁹⁺	string	是	否	设备地址。如果是蓝牙设备，需要申请权限ohos.permission.USE_BLUETOOTH。系统能力： SystemCapability.Multimedia.Audio.Device
sampleRates⁹⁺	Array<number>	是	否	支持的采样率。系统能力： SystemCapability.Multimedia.Audio.Device
channelCounts⁹⁺	Array<number>	是	否	支持的通道数。系统能力： SystemCapability.Multimedia.Audio.Device
channelMasks⁹⁺	Array<number>	是	否	支持的通道掩码。系统能力： SystemCapability.Multimedia.Audio.Device
displayName¹⁰⁺	string	是	否	设备显示名。系统能力： SystemCapability.Multimedia.Audio.Device
networkId⁹⁺	string	是	否	设备组网的ID。此接口为系统接口。系统能力： SystemCapability.Multimedia.Audio.Device
interruptGroupId⁹⁺	number	是	否	设备所处的焦点组ID。此接口为系统接口。系统能力： SystemCapability.Multimedia.Audio.Device
volumeGroupId⁹⁺	number	是	否	设备所处的音量组ID。此接口为系统接口。系统能力： SystemCapability.Multimedia.Audio.Device
encodingTypes¹¹⁺	Array<AudioEncodingType>	是	否	支持的编码类型。系统能力： SystemCapability.Multimedia.Audio.Core

示例：

import audio from '@ohos.multimedia.audio';

function displayDeviceProp(value: audio.AudioDeviceDescriptor) {
  deviceRoleValue = value.deviceRole;
  deviceTypeValue = value.deviceType;
}

let deviceRoleValue: audio.DeviceRole|undefined = undefined;;
let deviceTypeValue: audio.DeviceType|undefined = undefined;;
audio.getAudioManager().getDevices(1).then((value: audio.AudioDeviceDescriptors) => {
  console.info('AudioFrameworkTest: Promise: getDevices OUTPUT_DEVICES_FLAG');
  value.forEach(displayDeviceProp);
  if (deviceTypeValue != undefined && deviceRoleValue != undefined){
    console.info('AudioFrameworkTest: Promise: getDevices : OUTPUT_DEVICES_FLAG :  PASS');
  } else {
    console.error('AudioFrameworkTest: Promise: getDevices : OUTPUT_DEVICES_FLAG :  FAIL');
  }
});

AudioRendererFilter⁹⁺

过滤条件类。在调用selectOutputDeviceByFilter接口前，需要先创建AudioRendererFilter实例。

系统接口： 该接口为系统接口

名称	类型	必填	说明
uid	number	否	表示应用ID。系统能力： SystemCapability.Multimedia.Audio.Core
rendererInfo	AudioRendererInfo	否	表示渲染器信息。系统能力： SystemCapability.Multimedia.Audio.Renderer
rendererId	number	否	音频流唯一id。系统能力： SystemCapability.Multimedia.Audio.Renderer

示例：

import audio from '@ohos.multimedia.audio';
let outputAudioRendererFilter: audio.AudioRendererFilter = {
  uid : 20010041,
  rendererInfo : {
    content : audio.ContentType.CONTENT_TYPE_MUSIC,
    usage : audio.StreamUsage.STREAM_USAGE_MEDIA,
    rendererFlags : 0
  },
  rendererId : 0
};

AudioRenderer⁸⁺

提供音频渲染的相关接口。在调用AudioRenderer的接口前，需要先通过createAudioRenderer创建实例。

属性

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	类型	可读	可写	说明
state⁸⁺	AudioState	是	否	音频渲染器的状态。

示例：

import audio from '@ohos.multimedia.audio';
let state: audio.AudioState = audioRenderer.state;

getRendererInfo⁸⁺

getRendererInfo(callback: AsyncCallback): void

获取当前被创建的音频渲染器的信息，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioRendererInfo>	是	返回音频渲染器的信息。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getRendererInfo((err: BusinessError, rendererInfo: audio.AudioRendererInfo) => {
  console.info('Renderer GetRendererInfo:');
  console.info(`Renderer content: ${rendererInfo.content}`);
  console.info(`Renderer usage: ${rendererInfo.usage}`);
  console.info(`Renderer flags: ${rendererInfo.rendererFlags}`);
});

getRendererInfo⁸⁺

getRendererInfo(): Promise

获取当前被创建的音频渲染器的信息，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<AudioRendererInfo>	Promise用于返回音频渲染器信息。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getRendererInfo().then((rendererInfo: audio.AudioRendererInfo) => {
  console.info('Renderer GetRendererInfo:');
  console.info(`Renderer content: ${rendererInfo.content}`);
  console.info(`Renderer usage: ${rendererInfo.usage}`);
  console.info(`Renderer flags: ${rendererInfo.rendererFlags}`)
}).catch((err: BusinessError) => {
  console.error(`AudioFrameworkRenderLog: RendererInfo :ERROR: ${err}`);
});

getRendererInfoSync¹⁰⁺

getRendererInfoSync(): AudioRendererInfo

获取当前被创建的音频渲染器的信息，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
AudioRendererInfo	返回音频渲染器信息。

示例：

import { BusinessError } from '@ohos.base';

try {
  let rendererInfo: audio.AudioRendererInfo = audioRenderer.getRendererInfoSync();
  console.info(`Renderer content: ${rendererInfo.content}`);
  console.info(`Renderer usage: ${rendererInfo.usage}`);
  console.info(`Renderer flags: ${rendererInfo.rendererFlags}`)
} catch (err) {
  let error = err as BusinessError;
  console.error(`AudioFrameworkRenderLog: RendererInfo :ERROR: ${error}`);
}

getStreamInfo⁸⁺

getStreamInfo(callback: AsyncCallback): void

获取音频流信息，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioStreamInfo>	是	回调返回音频流信息。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getStreamInfo((err: BusinessError, streamInfo: audio.AudioStreamInfo) => {
  console.info('Renderer GetStreamInfo:');
  console.info(`Renderer sampling rate: ${streamInfo.samplingRate}`);
  console.info(`Renderer channel: ${streamInfo.channels}`);
  console.info(`Renderer format: ${streamInfo.sampleFormat}`);
  console.info(`Renderer encoding type: ${streamInfo.encodingType}`);
});

getStreamInfo⁸⁺

getStreamInfo(): Promise

获取音频流信息，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<AudioStreamInfo>	Promise返回音频流信息.

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getStreamInfo().then((streamInfo: audio.AudioStreamInfo) => {
  console.info('Renderer GetStreamInfo:');
  console.info(`Renderer sampling rate: ${streamInfo.samplingRate}`);
  console.info(`Renderer channel: ${streamInfo.channels}`);
  console.info(`Renderer format: ${streamInfo.sampleFormat}`);
  console.info(`Renderer encoding type: ${streamInfo.encodingType}`);
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

getStreamInfoSync¹⁰⁺

getStreamInfoSync(): AudioStreamInfo

获取音频流信息，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
AudioStreamInfo	返回音频流信息.

示例：

import { BusinessError } from '@ohos.base';

try {
  let streamInfo: audio.AudioStreamInfo = audioRenderer.getStreamInfoSync();
  console.info(`Renderer sampling rate: ${streamInfo.samplingRate}`);
  console.info(`Renderer channel: ${streamInfo.channels}`);
  console.info(`Renderer format: ${streamInfo.sampleFormat}`);
  console.info(`Renderer encoding type: ${streamInfo.encodingType}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

getAudioStreamId⁹⁺

getAudioStreamId(callback: AsyncCallback): void

获取音频流id，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	回调返回音频流id。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getAudioStreamId((err: BusinessError, streamid: number) => {
  console.info(`Renderer GetStreamId: ${streamid}`);
});

getAudioStreamId⁹⁺

getAudioStreamId(): Promise

获取音频流id，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise	Promise返回音频流id。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getAudioStreamId().then((streamid: number) => {
  console.info(`Renderer getAudioStreamId: ${streamid}`);
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

getAudioStreamIdSync¹⁰⁺

getAudioStreamIdSync(): number

获取音频流id，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
number	返回音频流id。

示例：

import { BusinessError } from '@ohos.base';

try {
  let streamid: number = audioRenderer.getAudioStreamIdSync();
  console.info(`Renderer getAudioStreamIdSync: ${streamid}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

setAudioEffectMode¹⁰⁺

setAudioEffectMode(mode: AudioEffectMode, callback: AsyncCallback<void>): void

设置当前音效模式。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
mode	AudioEffectMode	是	音效模式。
callback	AsyncCallback<void>	是	用于返回执行结果的回调。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by callback.

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.setAudioEffectMode(audio.AudioEffectMode.EFFECT_DEFAULT, (err: BusinessError) => {
  if (err) {
    console.error('Failed to set params');
  } else {
    console.info('Callback invoked to indicate a successful audio effect mode setting.');
  }
});

setAudioEffectMode¹⁰⁺

setAudioEffectMode(mode: AudioEffectMode): Promise<void>

设置当前音效模式。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
mode	AudioEffectMode	是	音效模式。

返回值：

类型	说明
Promise<void>	Promise用于返回执行结果。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Invalid parameter error. Return by promise.

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.setAudioEffectMode(audio.AudioEffectMode.EFFECT_DEFAULT).then(() => {
  console.info('setAudioEffectMode SUCCESS');
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

getAudioEffectMode¹⁰⁺

getAudioEffectMode(callback: AsyncCallback<AudioEffectMode>): void

获取当前音效模式。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioEffectMode>	是	回调返回当前音效模式。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getAudioEffectMode((err: BusinessError, effectmode: audio.AudioEffectMode) => {
  if (err) {
    console.error('Failed to get params');
  } else {
    console.info(`getAudioEffectMode: ${effectmode}`);
  }
});

getAudioEffectMode¹⁰⁺

getAudioEffectMode(): Promise<AudioEffectMode>

获取当前音效模式。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<AudioEffectMode>	Promise回调返回当前音效模式。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getAudioEffectMode().then((effectmode: audio.AudioEffectMode) => {
  console.info(`getAudioEffectMode: ${effectmode}`);
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

start⁸⁺

start(callback: AsyncCallback): void

启动音频渲染器。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.start((err: BusinessError) => {
  if (err) {
    console.error('Renderer start failed.');
  } else {
    console.info('Renderer start success.');
  }
});

start⁸⁺

start(): Promise

启动音频渲染器。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<void>	Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.start().then(() => {
  console.info('Renderer started');
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

pause⁸⁺

pause(callback: AsyncCallback<void>): void

暂停渲染。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	返回回调的结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.pause((err: BusinessError) => {
  if (err) {
    console.error('Renderer pause failed');
  } else {
    console.info('Renderer paused.');
  }
});

pause⁸⁺

pause(): Promise<void>

暂停渲染。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<void>	Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.pause().then(() => {
  console.info('Renderer paused');
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

drain⁸⁺

drain(callback: AsyncCallback<void>): void

检查缓冲区是否已被耗尽。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	返回回调的结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.drain((err: BusinessError) => {
  if (err) {
    console.error('Renderer drain failed');
  } else {
    console.info('Renderer drained.');
  }
});

drain⁸⁺

drain(): Promise<void>

检查缓冲区是否已被耗尽。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<void>	Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.drain().then(() => {
  console.info('Renderer drained successfully');
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

stop⁸⁺

stop(callback: AsyncCallback<void>): void

停止渲染。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	返回回调的结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.stop((err: BusinessError) => {
  if (err) {
    console.error('Renderer stop failed');
  } else {
    console.info('Renderer stopped.');
  }
});

stop⁸⁺

stop(): Promise<void>

停止渲染。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<void>	Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.stop().then(() => {
  console.info('Renderer stopped successfully');
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

release⁸⁺

release(callback: AsyncCallback<void>): void

释放音频渲染器。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	返回回调的结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.release((err: BusinessError) => {
  if (err) {
    console.error('Renderer release failed');
  } else {
    console.info('Renderer released.');
  }
});

release⁸⁺

release(): Promise<void>

释放渲染器。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<void>	Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.release().then(() => {
  console.info('Renderer released successfully');
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

write⁸⁺

write(buffer: ArrayBuffer, callback: AsyncCallback<number>): void

写入缓冲区。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
buffer	ArrayBuffer	是	要写入缓冲区的数据。
callback	AsyncCallback<number>	是	回调如果成功，返回写入的字节数，否则返回errorcode。

示例：

import { BusinessError } from '@ohos.base';
let bufferSize: number;
class Options {
  offset?: number;
  length?: number;
}
audioRenderer.getBufferSize().then((data: number)=> {
  console.info(`AudioFrameworkRenderLog: getBufferSize: SUCCESS ${data}`);
  bufferSize = data;
  console.info(`Buffer size: ${bufferSize}`);
  let path = getContext().cacheDir;
  let filePath = path + '/StarWars10s-2C-48000-4SW.wav';
  let file: fs.File = fs.openSync(filePath, fs.OpenMode.READ_ONLY);
  fs.stat(filePath).then(async (stat: fs.Stat) => {
    let buf = new ArrayBuffer(bufferSize);
    let len = stat.size % bufferSize == 0 ? Math.floor(stat.size / bufferSize) : Math.floor(stat.size / bufferSize + 1);
    for (let i = 0;i < len; i++) {
      let options: Options = {
        offset: i * bufferSize,
        length: bufferSize
      }
      let readsize: number = await fs.read(file.fd, buf, options)
      let writeSize: number = await new Promise((resolve,reject)=>{
        audioRenderer.write(buf,(err: BusinessError, writeSize: number)=>{
          if(err){
            reject(err)
          }else{
            resolve(writeSize)
          }
        })
      })
    }
  });
  }).catch((err: BusinessError) => {
    console.error(`AudioFrameworkRenderLog: getBufferSize: ERROR: ${err}`);
});

write⁸⁺

write(buffer: ArrayBuffer): Promise<number>

写入缓冲区。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<number>	Promise返回结果，如果成功，返回写入的字节数，否则返回errorcode。

示例：

import { BusinessError } from '@ohos.base';
let bufferSize: number;
class Options {
  offset?: number;
  length?: number;
}
audioRenderer.getBufferSize().then((data: number) => {
  console.info(`AudioFrameworkRenderLog: getBufferSize: SUCCESS ${data}`);
  bufferSize = data;
  console.info(`BufferSize: ${bufferSize}`);
  let path = getContext().cacheDir;
  let filePath = path + '/StarWars10s-2C-48000-4SW.wav';
  let file: fs.File = fs.openSync(filePath, fs.OpenMode.READ_ONLY);
  fs.stat(filePath).then(async (stat: fs.Stat) => {
    let buf = new ArrayBuffer(bufferSize);
    let len = stat.size % bufferSize == 0 ? Math.floor(stat.size / bufferSize) : Math.floor(stat.size / bufferSize + 1);
    for (let i = 0;i < len; i++) {
      let options: Options = {
        offset: i * bufferSize,
        length: bufferSize
      }
      let readsize: number = await fs.read(file.fd, buf, options)
      try{
        let writeSize: number = await audioRenderer.write(buf);
      } catch(err) {
        let error = err as BusinessError;
        console.error(`audioRenderer.write err: ${error}`);
      }
    }
  });
  }).catch((err: BusinessError) => {
    console.info(`AudioFrameworkRenderLog: getBufferSize: ERROR: ${err}`);
});

getAudioTime⁸⁺

getAudioTime(callback: AsyncCallback<number>): void

获取时间戳（从 1970 年 1 月 1 日开始）。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调返回时间戳。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getAudioTime((err: BusinessError, timestamp: number) => {
  console.info(`Current timestamp: ${timestamp}`);
});

getAudioTime⁸⁺

getAudioTime(): Promise<number>

获取时间戳（从 1970 年 1 月 1 日开始）。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	描述
Promise<number>	Promise回调返回时间戳。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getAudioTime().then((timestamp: number) => {
  console.info(`Current timestamp: ${timestamp}`);
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

getAudioTimeSync¹⁰⁺

getAudioTimeSync(): number

获取时间戳（从 1970 年 1 月 1 日开始），同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	描述
number	返回时间戳。

示例：

import { BusinessError } from '@ohos.base';

try {
  let timestamp: number = audioRenderer.getAudioTimeSync();
  console.info(`Current timestamp: ${timestamp}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

getBufferSize⁸⁺

getBufferSize(callback: AsyncCallback<number>): void

获取音频渲染器的最小缓冲区大小。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调返回缓冲区大小。

示例：

import { BusinessError } from '@ohos.base';
let bufferSize: number;
audioRenderer.getBufferSize((err: BusinessError, data: number) => {
  if (err) {
    console.error('getBufferSize error');
  } else {
    console.info(`AudioFrameworkRenderLog: getBufferSize: SUCCESS ${data}`);
    bufferSize = data;
  }
});

getBufferSize⁸⁺

getBufferSize(): Promise<number>

获取音频渲染器的最小缓冲区大小。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<number>	promise回调返回缓冲区大小。

示例：

import { BusinessError } from '@ohos.base';
let bufferSize: number;
audioRenderer.getBufferSize().then((data: number) => {
  console.info(`AudioFrameworkRenderLog: getBufferSize: SUCCESS ${data}`);
  bufferSize = data;
}).catch((err: BusinessError) => {
  console.error(`AudioFrameworkRenderLog: getBufferSize: ERROR: ${err}`);
});

getBufferSizeSync¹⁰⁺

getBufferSizeSync(): number

获取音频渲染器的最小缓冲区大小，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
number	返回缓冲区大小。

示例：

import { BusinessError } from '@ohos.base';

let bufferSize: number = 0;
try {
  bufferSize = audioRenderer.getBufferSizeSync();
  console.info(`AudioFrameworkRenderLog: getBufferSize: SUCCESS ${bufferSize}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`AudioFrameworkRenderLog: getBufferSize: ERROR: ${error}`);
}

setRenderRate⁸⁺

setRenderRate(rate: AudioRendererRate, callback: AsyncCallback<void>): void

设置音频渲染速率。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
rate	AudioRendererRate	是	渲染的速率。
callback	AsyncCallback<void>	是	用于返回执行结果的回调。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.setRenderRate(audio.AudioRendererRate.RENDER_RATE_NORMAL, (err: BusinessError) => {
  if (err) {
    console.error('Failed to set params');
  } else {
    console.info('Callback invoked to indicate a successful render rate setting.');
  }
});

setRenderRate⁸⁺

setRenderRate(rate: AudioRendererRate): Promise<void>

设置音频渲染速率。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
rate	AudioRendererRate	是	渲染的速率。

返回值：

类型	说明
Promise<void>	Promise用于返回执行结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.setRenderRate(audio.AudioRendererRate.RENDER_RATE_NORMAL).then(() => {
  console.info('setRenderRate SUCCESS');
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

getRenderRate⁸⁺

getRenderRate(callback: AsyncCallback<AudioRendererRate>): void

获取当前渲染速率。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioRendererRate>	是	回调返回渲染速率。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getRenderRate((err: BusinessError, renderrate: audio.AudioRendererRate) => {
  console.info(`getRenderRate: ${renderrate}`);
});

getRenderRate⁸⁺

getRenderRate(): Promise<AudioRendererRate>

获取当前渲染速率。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<AudioRendererRate>	Promise回调返回渲染速率。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getRenderRate().then((renderRate: audio.AudioRendererRate) => {
  console.info(`getRenderRate: ${renderRate}`);
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

getRenderRateSync¹⁰⁺

getRenderRateSync(): AudioRendererRate

获取当前渲染速率，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
AudioRendererRate	返回渲染速率。

示例：

import { BusinessError } from '@ohos.base';

try {
  let renderRate: audio.AudioRendererRate = audioRenderer.getRenderRateSync();
  console.info(`getRenderRate: ${renderRate}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

setInterruptMode⁹⁺

setInterruptMode(mode: InterruptMode): Promise<void>

设置应用的焦点模型。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

参数：

参数名	类型	必填	说明
mode	InterruptMode	是	焦点模型。

返回值：

类型	说明
Promise<void>	以Promise对象返回结果，设置成功时返回undefined，否则返回error。

示例：

import { BusinessError } from '@ohos.base';
let mode = 0;
audioRenderer.setInterruptMode(mode).then(() => {
  console.info('setInterruptMode Success!');
}).catch((err: BusinessError) => {
  console.error(`setInterruptMode Fail: ${err}`);
});

setInterruptMode⁹⁺

setInterruptMode(mode: InterruptMode, callback: AsyncCallback<void>): void

设置应用的焦点模型。使用Callback回调返回执行结果。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

参数：

参数名	类型	必填	说明
mode	InterruptMode	是	焦点模型。
callback	AsyncCallback<void>	是	回调返回执行结果。

示例：

import { BusinessError } from '@ohos.base';
let mode = 1;
audioRenderer.setInterruptMode(mode, (err: BusinessError) => {
  if(err){
    console.error(`setInterruptMode Fail: ${err}`);
  }
  console.info('setInterruptMode Success!');
});

setInterruptModeSync¹⁰⁺

setInterruptModeSync(mode: InterruptMode): void

设置应用的焦点模型，同步设置。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

参数：

参数名	类型	必填	说明
mode	InterruptMode	是	焦点模型。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	invalid parameter error

示例：

import { BusinessError } from '@ohos.base';

try {
  audioRenderer.setInterruptModeSync(0);
  console.info('setInterruptMode Success!');
} catch (err) {
  let error = err as BusinessError;
  console.error(`setInterruptMode Fail: ${error}`);
}

setVolume⁹⁺

setVolume(volume: number): Promise<void>

设置应用的音量。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
volume	number	是	音量值范围为0.0-1.0。

返回值：

类型	说明
Promise<void>	以Promise对象返回结果，设置成功时返回undefined，否则返回error。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.setVolume(0.5).then(() => {
  console.info('setVolume Success!');
}).catch((err: BusinessError) => {
  console.error(`setVolume Fail: ${err}`);
});

setVolume⁹⁺

setVolume(volume: number, callback: AsyncCallback<void>): void

设置应用的音量。使用Callback回调返回执行结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
volume	number	是	音量值范围为0.0-1.0。
callback	AsyncCallback<void>	是	回调返回执行结果。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.setVolume(0.5, (err: BusinessError) => {
  if(err){
    console.error(`setVolume Fail: ${err}`);
  }
  console.info('setVolume Success!');
});

getMinStreamVolume¹⁰⁺

getMinStreamVolume(callback: AsyncCallback<number>): void

获取应用基于音频流的最小音量。使用Callback回调返回。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	Callback回调返回音频流最小音量（音量范围0-1）。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getMinStreamVolume((err: BusinessError, minVolume: number) => {
  if (err) {
    console.error(`getMinStreamVolume error: ${err}`);
  } else {
    console.info(`getMinStreamVolume Success! ${minVolume}`);
  }
});

getMinStreamVolume¹⁰⁺

getMinStreamVolume(): Promise<number>

获取应用基于音频流的最小音量。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<number>	Promise回调返回音频流最小音量（音量范围0-1）。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getMinStreamVolume().then((value: number) => {
  console.info(`Get min stream volume Success! ${value}`);
}).catch((err: BusinessError) => {
  console.error(`Get min stream volume Fail: ${err}`);
});

getMinStreamVolumeSync¹⁰⁺

getMinStreamVolumeSync(): number

获取应用基于音频流的最小音量，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
number	返回音频流最小音量（音量范围0-1）。

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: number = audioRenderer.getMinStreamVolumeSync();
  console.info(`Get min stream volume Success! ${value}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Get min stream volume Fail: ${error}`);
}

getMaxStreamVolume¹⁰⁺

getMaxStreamVolume(callback: AsyncCallback<number>): void

获取应用基于音频流的最大音量。使用Callback回调返回。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	Callback回调返回音频流最大音量（音量范围0-1）。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getMaxStreamVolume((err: BusinessError, maxVolume: number) => {
  if (err) {
    console.error(`getMaxStreamVolume Fail: ${err}`);
  } else {
    console.info(`getMaxStreamVolume Success! ${maxVolume}`);
  }
});

getMaxStreamVolume¹⁰⁺

getMaxStreamVolume(): Promise<number>

获取应用基于音频流的最大音量。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<number>	Promise回调返回音频流最大音量（音量范围0-1）。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getMaxStreamVolume().then((value: number) => {
  console.info(`Get max stream volume Success! ${value}`);
}).catch((err: BusinessError) => {
  console.error(`Get max stream volume Fail: ${err}`);
});

getMaxStreamVolumeSync¹⁰⁺

getMaxStreamVolumeSync(): number

获取应用基于音频流的最大音量，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
number	返回音频流最大音量（音量范围0-1）。

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: number = audioRenderer.getMaxStreamVolumeSync();
  console.info(`Get max stream volume Success! ${value}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Get max stream volume Fail: ${error}`);
}

getUnderflowCount¹⁰⁺

getUnderflowCount(callback: AsyncCallback<number>): void

获取当前播放音频流的欠载音频帧数量。使用Callback回调返回。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	Callback回调返回音频流的欠载音频帧数量。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getUnderflowCount((err: BusinessError, underflowCount: number) => {
  if (err) {
    console.error(`getUnderflowCount Fail: ${err}`);
  } else {
    console.info(`getUnderflowCount Success! ${underflowCount}`);
  }
});

getUnderflowCount¹⁰⁺

getUnderflowCount(): Promise<number>

获取当前播放音频流的欠载音频帧数量。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
Promise<number>	Promise回调返回音频流的欠载音频帧数量。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getUnderflowCount().then((value: number) => {
  console.info(`Get underflow count Success! ${value}`);
}).catch((err: BusinessError) => {
  console.error(`Get underflow count Fail: ${err}`);
});

getUnderflowCountSync¹⁰⁺

getUnderflowCountSync(): number

获取当前播放音频流的欠载音频帧数量，同步返回数据。

系统能力： SystemCapability.Multimedia.Audio.Renderer

返回值：

类型	说明
number	返回音频流的欠载音频帧数量。

示例：

import { BusinessError } from '@ohos.base';

try {
  let value: number = audioRenderer.getUnderflowCountSync();
  console.info(`Get underflow count Success! ${value}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Get underflow count Fail: ${error}`);
}

getCurrentOutputDevices¹⁰⁺

getCurrentOutputDevices(callback: AsyncCallback<AudioDeviceDescriptors>): void

获取音频流输出设备描述符。使用Callback回调返回。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioDeviceDescriptors>	是	Callback回调返回音频流的输出设备描述符。

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getCurrentOutputDevices((err: BusinessError, deviceInfo: audio.AudioDeviceDescriptors) => {
  if (err) {
    console.error(`getCurrentOutputDevices Fail: ${err}`);
  } else {
    for (let i = 0; i < deviceInfo.length; i++) {
      console.info(`DeviceInfo id: ${deviceInfo[i].id}`);
      console.info(`DeviceInfo type: ${deviceInfo[i].deviceType}`);
      console.info(`DeviceInfo role: ${deviceInfo[i].deviceRole}`);
      console.info(`DeviceInfo name: ${deviceInfo[i].name}`);
      console.info(`DeviceInfo address: ${deviceInfo[i].address}`);
      console.info(`DeviceInfo samplerate: ${deviceInfo[i].sampleRates[0]}`);
      console.info(`DeviceInfo channelcount: ${deviceInfo[i].channelCounts[0]}`);
      console.info(`DeviceInfo channelmask: ${deviceInfo[i].channelMasks[0]}`);
    }
  }
});

getCurrentOutputDevices¹⁰⁺

getCurrentOutputDevices(): Promise<AudioDeviceDescriptors>

获取音频流输出设备描述符。使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Audio.Device

返回值：

类型	说明
Promise<AudioDeviceDescriptors>	Promise回调返回音频流的输出设备描述信息

示例：

import { BusinessError } from '@ohos.base';
audioRenderer.getCurrentOutputDevices().then((deviceInfo: audio.AudioDeviceDescriptors) => {
  for (let i = 0; i < deviceInfo.length; i++) {
    console.info(`DeviceInfo id: ${deviceInfo[i].id}`);
    console.info(`DeviceInfo type: ${deviceInfo[i].deviceType}`);
    console.info(`DeviceInfo role: ${deviceInfo[i].deviceRole}`);
    console.info(`DeviceInfo name: ${deviceInfo[i].name}`);
    console.info(`DeviceInfo address: ${deviceInfo[i].address}`);
    console.info(`DeviceInfo samplerate: ${deviceInfo[i].sampleRates[0]}`);
    console.info(`DeviceInfo channelcount: ${deviceInfo[i].channelCounts[0]}`);
    console.info(`DeviceInfo channelmask: ${deviceInfo[i].channelMasks[0]}`);
  }
}).catch((err: BusinessError) => {
  console.error(`Get current output devices Fail: ${err}`);
});

getCurrentOutputDevicesSync¹⁰⁺

getCurrentOutputDevicesSync(): AudioDeviceDescriptors

获取音频流输出设备描述符，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

返回值：

类型	说明
AudioDeviceDescriptors	返回音频流的输出设备描述信息

示例：

import { BusinessError } from '@ohos.base';

try {
  let deviceInfo: audio.AudioDeviceDescriptors = audioRenderer.getCurrentOutputDevicesSync();
  for (let i = 0; i < deviceInfo.length; i++) {
    console.info(`DeviceInfo id: ${deviceInfo[i].id}`);
    console.info(`DeviceInfo type: ${deviceInfo[i].deviceType}`);
    console.info(`DeviceInfo role: ${deviceInfo[i].deviceRole}`);
    console.info(`DeviceInfo name: ${deviceInfo[i].name}`);
    console.info(`DeviceInfo address: ${deviceInfo[i].address}`);
    console.info(`DeviceInfo samplerate: ${deviceInfo[i].sampleRates[0]}`);
    console.info(`DeviceInfo channelcount: ${deviceInfo[i].channelCounts[0]}`);
    console.info(`DeviceInfo channelmask: ${deviceInfo[i].channelMasks[0]}`);
  }
} catch (err) {
  let error = err as BusinessError;
  console.error(`Get current output devices Fail: ${error}`);
}

setChannelBlendMode¹¹⁺

setChannelBlendMode(mode: ChannelBlendMode): void

设置单双声道混合模式。使用同步方式返回结果。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
mode	ChannelBlendMode	是	声道混合模式类型。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	Input parameter value error.
6800103	Operation not permit at current state.

示例：

let mode = audio.ChannelBlendMode.MODE_DEFAULT;

audioRenderer.setChannelBlendMode(mode);
console.info(`BlendMode: ${mode}`);

on(‘audioInterrupt’)⁹⁺

on(type: ‘audioInterrupt’, callback: Callback<InterruptEvent>): void

监听音频中断事件。使用callback获取中断事件。

与on(‘interrupt’)一致，均用于监听焦点变化。AudioRenderer对象在start事件发生时会主动获取焦点，在pause、stop等事件发生时会主动释放焦点，不需要开发者主动发起获取焦点或释放焦点的申请。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’audioInterrupt’（中断事件被触发，音频渲染被中断。）
callback	Callback<InterruptEvent>	是	被监听的中断事件的回调。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

import audio from '@ohos.multimedia.audio';

let isPlaying: boolean; // 标识符，表示是否正在渲染
let isDucked: boolean; // 标识符，表示是否被降低音量
onAudioInterrupt();

async function onAudioInterrupt(){
  audioRenderer.on('audioInterrupt', (interruptEvent: audio.InterruptEvent) => {
    if (interruptEvent.forceType == audio.InterruptForceType.INTERRUPT_FORCE) {
      // 由系统进行操作，强制打断音频渲染，应用需更新自身状态及显示内容等
      switch (interruptEvent.hintType) {
        case audio.InterruptHint.INTERRUPT_HINT_PAUSE:
          // 音频流已被暂停，临时失去焦点，待可重获焦点时会收到resume对应的interruptEvent
          console.info('Force paused. Update playing status and stop writing');
          isPlaying = false; // 简化处理，代表应用切换至暂停状态的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_STOP:
          // 音频流已被停止，永久失去焦点，若想恢复渲染，需用户主动触发
          console.info('Force stopped. Update playing status and stop writing');
          isPlaying = false; // 简化处理，代表应用切换至暂停状态的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_DUCK:
          // 音频流已被降低音量渲染
          console.info('Force ducked. Update volume status');
          isDucked = true; // 简化处理，代表应用更新音量状态的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_UNDUCK:
          // 音频流已被恢复正常音量渲染
          console.info('Force ducked. Update volume status');
          isDucked = false; // 简化处理，代表应用更新音量状态的若干操作
          break;
        default:
          console.info('Invalid interruptEvent');
          break;
      }
    } else if (interruptEvent.forceType == audio.InterruptForceType.INTERRUPT_SHARE) {
      // 由应用进行操作，应用可以自主选择打断或忽略
      switch (interruptEvent.hintType) {
        case audio.InterruptHint.INTERRUPT_HINT_RESUME:
          // 建议应用继续渲染（说明音频流此前被强制暂停，临时失去焦点，现在可以恢复渲染）
          console.info('Resume force paused renderer or ignore');
          // 若选择继续渲染，需在此处主动执行开始渲染的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_PAUSE:
          // 建议应用暂停渲染
          console.info('Choose to pause or ignore');
          // 若选择暂停渲染，需在此处主动执行暂停渲染的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_STOP:
          // 建议应用停止渲染
          console.info('Choose to stop or ignore');
          // 若选择停止渲染，需在此处主动执行停止渲染的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_DUCK:
          // 建议应用降低音量渲染
          console.info('Choose to duck or ignore');
          // 若选择降低音量渲染，需在此处主动执行降低音量渲染的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_UNDUCK:
          // 建议应用恢复正常音量渲染
          console.info('Choose to unduck or ignore');
          // 若选择恢复正常音量渲染，需在此处主动执行恢复正常音量渲染的若干操作
          break;
        default:
          break;
      }
    }
  });
}

on(‘markReach’)⁸⁺

on(type: ‘markReach’, frame: number, callback: Callback<number>): void

订阅到达标记的事件。当渲染的帧数达到 frame 参数的值时，回调被调用。

系统能力: SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’markReach’。
frame	number	是	触发事件的帧数。该值必须大于 0。
callback	Callback<number>	是	触发事件时调用的回调。

示例：

audioRenderer.on('markReach', 1000, (position: number) => {
  if (position == 1000) {
    console.info('ON Triggered successfully');
  }
});

off(‘markReach’) ⁸⁺

off(type: ‘markReach’): void

取消订阅标记事件。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	要取消订阅事件的类型。支持的事件为：’markReach’。

示例：

audioRenderer.off('markReach');

on(‘periodReach’) ⁸⁺

on(type: ‘periodReach’, frame: number, callback: Callback<number>): void

订阅到达标记的事件。当渲染的帧数达到 frame 参数的值时，触发回调并返回设定的值。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’periodReach’。
frame	number	是	触发事件的帧数。该值必须大于 0。
callback	Callback<number>	是	触发事件时调用的回调。

示例：

audioRenderer.on('periodReach', 1000, (position: number) => {
  if (position == 1000) {
    console.info('ON Triggered successfully');
  }
});

off(‘periodReach’) ⁸⁺

off(type: ‘periodReach’): void

取消订阅标记事件。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	要取消订阅事件的类型。支持的事件为：’periodReach’。

示例：

audioRenderer.off('periodReach')

on(‘stateChange’) ⁸⁺

on(type: ‘stateChange’, callback: Callback): void

订阅监听状态变化。

系统能力： SystemCapability.Multimedia.Audio.Renderer

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’stateChange’。
callback	Callback<AudioState>	是	返回监听的状态。

示例：

audioRenderer.on('stateChange', (state: audio.AudioState) => {
  if (state == 1) {
    console.info('audio renderer state is: STATE_PREPARED');
  }
  if (state == 2) {
    console.info('audio renderer state is: STATE_RUNNING');
  }
});

on(‘outputDeviceChange’) ¹⁰⁺

on(type: ‘outputDeviceChange’, callback: Callback<AudioDeviceDescriptors>): void;

订阅监听音频输出设备变化。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’outputDeviceChange’。
callback	Callback<AudioDeviceDescriptors>	是	返回监听的音频设备变化。

错误码：

错误码ID	错误信息
6800101	if input parameter value error.

示例：

audioRenderer.on('outputDeviceChange', (deviceInfo: audio.AudioDeviceDescriptors) => {
  console.info(`DeviceInfo id: ${deviceInfo[0].id}`);
  console.info(`DeviceInfo name: ${deviceInfo[0].name}`);
  console.info(`DeviceInfo address: ${deviceInfo[0].address}`);
});

off(‘outputDeviceChange’) ¹⁰⁺

off(type: ‘outputDeviceChange’, callback?: Callback<AudioDeviceDescriptors>): void;

取消订阅监听音频输出设备变化。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’outputDeviceChange’。
callback	Callback<AudioDeviceDescriptors>	否	取消监听的音频设备变化。

错误码：

错误码ID	错误信息
6800101	if input parameter value error.

示例：

audioRenderer.off('outputDeviceChange', (deviceInfo: audio.AudioDeviceDescriptors) => {
  console.info(`DeviceInfo id: ${deviceInfo[0].id}`);
  console.info(`DeviceInfo name: ${deviceInfo[0].name}`);
  console.info(`DeviceInfo address: ${deviceInfo[0].address}`);
});

AudioCapturer⁸⁺

提供音频采集的相关接口。在调用AudioCapturer的接口前，需要先通过createAudioCapturer创建实例。

属性

系统能力： SystemCapability.Multimedia.Audio.Capturer

名称	类型	可读	可写	说明
state⁸⁺	AudioState	是	否	音频采集器状态。

示例：

import audio from '@ohos.multimedia.audio';
let state: audio.AudioState = audioCapturer.state;

getCapturerInfo⁸⁺

getCapturerInfo(callback: AsyncCallback): void

获取采集器信息。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回采集器信息。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getCapturerInfo((err: BusinessError, capturerInfo: audio.AudioCapturerInfo) => {
  if (err) {
    console.error('Failed to get capture info');
  } else {
    console.info('Capturer getCapturerInfo:');
    console.info(`Capturer source: ${capturerInfo.source}`);
    console.info(`Capturer flags: ${capturerInfo.capturerFlags}`);
  }
});

getCapturerInfo⁸⁺

getCapturerInfo(): Promise

获取采集器信息。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
Promise<AudioCapturerInfo>	使用Promise方式异步返回采集器信息。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getCapturerInfo().then((audioParamsGet: audio.AudioCapturerInfo) => {
  if (audioParamsGet != undefined) {
    console.info('AudioFrameworkRecLog: Capturer CapturerInfo:');
    console.info(`AudioFrameworkRecLog: Capturer SourceType: ${audioParamsGet.source}`);
    console.info(`AudioFrameworkRecLog: Capturer capturerFlags: ${audioParamsGet.capturerFlags}`);
  } else {
    console.info(`AudioFrameworkRecLog: audioParamsGet is : ${audioParamsGet}`);
    console.info('AudioFrameworkRecLog: audioParams getCapturerInfo are incorrect');
  }
}).catch((err: BusinessError) => {
  console.error(`AudioFrameworkRecLog: CapturerInfo :ERROR: ${err}`);
})

getCapturerInfoSync¹⁰⁺

getCapturerInfoSync(): AudioCapturerInfo

获取采集器信息，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
AudioCapturerInfo	返回采集器信息。

示例：

import { BusinessError } from '@ohos.base';

try {
  let audioParamsGet: audio.AudioCapturerInfo = audioCapturer.getCapturerInfoSync();
  console.info(`AudioFrameworkRecLog: Capturer SourceType: ${audioParamsGet.source}`);
  console.info(`AudioFrameworkRecLog: Capturer capturerFlags: ${audioParamsGet.capturerFlags}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`AudioFrameworkRecLog: CapturerInfo :ERROR: ${error}`);
}

getStreamInfo⁸⁺

getStreamInfo(callback: AsyncCallback): void

获取采集器流信息。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AudioStreamInfo>	是	使用callback方式异步返回流信息。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getStreamInfo((err: BusinessError, streamInfo: audio.AudioStreamInfo) => {
  if (err) {
    console.error('Failed to get stream info');
  } else {
    console.info('Capturer GetStreamInfo:');
    console.info(`Capturer sampling rate: ${streamInfo.samplingRate}`);
    console.info(`Capturer channel: ${streamInfo.channels}`);
    console.info(`Capturer format: ${streamInfo.sampleFormat}`);
    console.info(`Capturer encoding type: ${streamInfo.encodingType}`);
  }
});

getStreamInfo⁸⁺

getStreamInfo(): Promise

获取采集器流信息。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
Promise<AudioStreamInfo>	使用Promise方式异步返回流信息。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getStreamInfo().then((audioParamsGet: audio.AudioStreamInfo) => {
  console.info('getStreamInfo:');
  console.info(`sampleFormat: ${audioParamsGet.sampleFormat}`);
  console.info(`samplingRate: ${audioParamsGet.samplingRate}`);
  console.info(`channels: ${audioParamsGet.channels}`);
  console.info(`encodingType: ${audioParamsGet.encodingType}`);
}).catch((err: BusinessError) => {
  console.error(`getStreamInfo :ERROR: ${err}`);
});

getStreamInfoSync¹⁰⁺

getStreamInfoSync(): AudioStreamInfo

获取采集器流信息，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
AudioStreamInfo	返回流信息。

示例：

import { BusinessError } from '@ohos.base';

try {
  let audioParamsGet: audio.AudioStreamInfo = audioCapturer.getStreamInfoSync();
  console.info(`sampleFormat: ${audioParamsGet.sampleFormat}`);
  console.info(`samplingRate: ${audioParamsGet.samplingRate}`);
  console.info(`channels: ${audioParamsGet.channels}`);
  console.info(`encodingType: ${audioParamsGet.encodingType}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`getStreamInfo :ERROR: ${error}`);
}

getAudioStreamId⁹⁺

getAudioStreamId(callback: AsyncCallback): void

获取音频流id，使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	回调返回音频流id。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getAudioStreamId((err: BusinessError, streamid: number) => {
  console.info(`audioCapturer GetStreamId: ${streamid}`);
});

getAudioStreamId⁹⁺

getAudioStreamId(): Promise

获取音频流id，使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
Promise	Promise返回音频流id。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getAudioStreamId().then((streamid: number) => {
  console.info(`audioCapturer getAudioStreamId: ${streamid}`);
}).catch((err: BusinessError) => {
  console.error(`ERROR: ${err}`);
});

getAudioStreamIdSync¹⁰⁺

getAudioStreamIdSync(): number

获取音频流id，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
number	返回音频流id。

示例：

import { BusinessError } from '@ohos.base';

try {
  let streamid: number = audioCapturer.getAudioStreamIdSync();
  console.info(`audioCapturer getAudioStreamIdSync: ${streamid}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

start⁸⁺

start(callback: AsyncCallback): void

启动音频采集器。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.start((err: BusinessError) => {
  if (err) {
    console.error('Capturer start failed.');
  } else {
    console.info('Capturer start success.');
  }
});

start⁸⁺

start(): Promise

启动音频采集器。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
Promise	使用Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.start().then(() => {
  console.info('AudioFrameworkRecLog: ---------START---------');
  console.info('AudioFrameworkRecLog: Capturer started: SUCCESS');
  console.info(`AudioFrameworkRecLog: AudioCapturer: STATE: ${audioCapturer.state}`);
  console.info('AudioFrameworkRecLog: Capturer started: SUCCESS');
  if ((audioCapturer.state == audio.AudioState.STATE_RUNNING)) {
    console.info('AudioFrameworkRecLog: AudioCapturer is in Running State');
  }
}).catch((err: BusinessError) => {
  console.info(`AudioFrameworkRecLog: Capturer start :ERROR : ${err}`);
});

stop⁸⁺

stop(callback: AsyncCallback): void

停止采集。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.stop((err: BusinessError) => {
  if (err) {
    console.error('Capturer stop failed');
  } else {
    console.info('Capturer stopped.');
  }
});

stop⁸⁺

stop(): Promise

停止采集。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
Promise	使用Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.stop().then(() => {
  console.info('AudioFrameworkRecLog: ---------STOP RECORD---------');
  console.info('AudioFrameworkRecLog: Capturer stopped: SUCCESS');
  if ((audioCapturer.state == audio.AudioState.STATE_STOPPED)){
    console.info('AudioFrameworkRecLog: State is Stopped:');
  }
}).catch((err: BusinessError) => {
  console.info(`AudioFrameworkRecLog: Capturer stop: ERROR: ${err}`);
});

release⁸⁺

release(callback: AsyncCallback): void

释放采集器。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.release((err: BusinessError) => {
  if (err) {
    console.error('capturer release failed');
  } else {
    console.info('capturer released.');
  }
});

release⁸⁺

release(): Promise

释放采集器。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
Promise	使用Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.release().then(() => {
  console.info('AudioFrameworkRecLog: ---------RELEASE RECORD---------');
  console.info('AudioFrameworkRecLog: Capturer release : SUCCESS');
  console.info(`AudioFrameworkRecLog: AudioCapturer : STATE : ${audioCapturer.state}`);
}).catch((err: BusinessError) => {
  console.info(`AudioFrameworkRecLog: Capturer stop: ERROR: ${err}`);
});

read⁸⁺

read(size: number, isBlockingRead: boolean, callback: AsyncCallback): void

读入缓冲区。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
size	number	是	读入的字节数。
isBlockingRead	boolean	是	是否阻塞读操作。
callback	AsyncCallback	是	使用callback方式异步返回缓冲区。

示例：

import { BusinessError } from '@ohos.base';
let bufferSize: number = 0;
audioCapturer.getBufferSize().then((data: number) => {
  console.info(`AudioFrameworkRecLog: getBufferSize: SUCCESS ${data}`);
  bufferSize = data;
}).catch((err: BusinessError) => {
  console.error(`AudioFrameworkRecLog: getBufferSize: ERROR: ${err}`);
});
audioCapturer.read(bufferSize, true, (err: BusinessError, buffer: ArrayBuffer) => {
  if (!err) {
    console.info('Success in reading the buffer data');
  }
});

read⁸⁺

read(size: number, isBlockingRead: boolean): Promise

读入缓冲区。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
size	number	是	读入的字节数。
isBlockingRead	boolean	是	是否阻塞读操作。

返回值：

类型	说明
Promise	如果操作成功，返回读取的缓冲区数据；否则返回错误代码。

示例：

import { BusinessError } from '@ohos.base';
let bufferSize: number = 0;
audioCapturer.getBufferSize().then((data: number) => {
  console.info(`AudioFrameworkRecLog: getBufferSize: SUCCESS ${data}`);
  bufferSize = data;
}).catch((err: BusinessError) => {
  console.info(`AudioFrameworkRecLog: getBufferSize: ERROR ${err}`);
});
console.info(`Buffer size: ${bufferSize}`);
audioCapturer.read(bufferSize, true).then((buffer: ArrayBuffer) => {
  console.info('buffer read successfully');
}).catch((err: BusinessError) => {
  console.info(`ERROR : ${err}`);
});

getAudioTime⁸⁺

getAudioTime(callback: AsyncCallback): void

获取时间戳（从1970年1月1日开始），单位为纳秒。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getAudioTime((err: BusinessError, timestamp: number) => {
  console.info(`Current timestamp: ${timestamp}`);
});

getAudioTime⁸⁺

getAudioTime(): Promise

获取时间戳（从1970年1月1日开始），单位为纳秒。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
Promise	使用Promise方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getAudioTime().then((audioTime: number) => {
  console.info(`AudioFrameworkRecLog: AudioCapturer getAudioTime : Success ${audioTime}`);
}).catch((err: BusinessError) => {
  console.info(`AudioFrameworkRecLog: AudioCapturer Created : ERROR : ${err}`);
});

getAudioTimeSync¹⁰⁺

getAudioTimeSync(): number

获取时间戳（从1970年1月1日开始），单位为纳秒，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
number	返回时间戳。

示例：

import { BusinessError } from '@ohos.base';

try {
  let audioTime: number = audioCapturer.getAudioTimeSync();
  console.info(`AudioFrameworkRecLog: AudioCapturer getAudioTimeSync : Success ${audioTime}`);
} catch (err) {
  let error = err as BusinessError;
  console.info(`AudioFrameworkRecLog: AudioCapturer getAudioTimeSync : ERROR : ${error}`);
}

getBufferSize⁸⁺

getBufferSize(callback: AsyncCallback): void

获取采集器合理的最小缓冲区大小。使用callback方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回缓冲区大小。

示例：

import { BusinessError } from '@ohos.base';
audioCapturer.getBufferSize((err: BusinessError, bufferSize: number) => {
  if (!err) {
    console.info(`BufferSize : ${bufferSize}`);
    audioCapturer.read(bufferSize, true).then((buffer: ArrayBuffer) => {
      console.info(`Buffer read is ${buffer.byteLength}`);
    }).catch((err: BusinessError) => {
      console.error(`AudioFrameworkRecLog: AudioCapturer Created : ERROR : ${err}`);
    });
  }
});

getBufferSize⁸⁺

getBufferSize(): Promise

获取采集器合理的最小缓冲区大小。使用Promise方式异步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
Promise	使用Promise方式异步返回缓冲区大小。

示例：

import { BusinessError } from '@ohos.base';
let bufferSize: number = 0;
audioCapturer.getBufferSize().then((data: number) => {
  console.info(`AudioFrameworkRecLog: getBufferSize :SUCCESS ${data}`);
  bufferSize = data;
}).catch((err: BusinessError) => {
  console.info(`AudioFrameworkRecLog: getBufferSize :ERROR : ${err}`);
});

getBufferSizeSync¹⁰⁺

getBufferSizeSync(): number

获取采集器合理的最小缓冲区大小，同步返回结果。

系统能力： SystemCapability.Multimedia.Audio.Capturer

返回值：

类型	说明
number	返回缓冲区大小。

示例：

import { BusinessError } from '@ohos.base';

let bufferSize: number = 0;
try {
  bufferSize = audioCapturer.getBufferSizeSync();
  console.info(`AudioFrameworkRecLog: getBufferSizeSync :SUCCESS ${bufferSize}`);
} catch (err) {
  let error = err as BusinessError;
  console.info(`AudioFrameworkRecLog: getBufferSizeSync :ERROR : ${error}`);
}

getCurrentInputDevices¹¹⁺

getCurrentInputDevices(): AudioDeviceDescriptors

获取录音流输入设备描述符。使用同步方式返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

返回值：

类型	说明
AudioDeviceDescriptors	同步接口，返回设备属性数组类型数据。

示例：

let deviceDescriptors: audio.AudioDeviceDescriptors = audioCapturer.getCurrentInputDevices();
console.info(`Device id: ${deviceDescriptors[0].id}`);
console.info(`Device type: ${deviceDescriptors[0].deviceType}`);
console.info(`Device role: ${deviceDescriptors[0].deviceRole}`);
console.info(`Device name: ${deviceDescriptors[0].name}`);
console.info(`Device address: ${deviceDescriptors[0].address}`);
console.info(`Device samplerates: ${deviceDescriptors[0].sampleRates[0]}`);
console.info(`Device channelcounts: ${deviceDescriptors[0].channelCounts[0]}`);
console.info(`Device channelmask: ${deviceDescriptors[0].channelMasks[0]}`);
console.info(`Device encodingTypes: ${deviceDescriptors[0].encodingTypes[0]}`);

getCurrentAudioCapturerChangeInfo¹¹⁺

getCurrentAudioCapturerChangeInfo(): AudioCapturerChangeInfo

获取录音流配置。使用同步方式返回结果。

系统能力： SystemCapability.Multimedia.Audio.Device

返回值：

类型	说明
AudioCapturerChangeInfo	同步接口，返回描述音频采集器更改信息。

示例：

let info: audio.AudioCapturerChangeInfo = audioCapturer.getCurrentAudioCapturerChangeInfo();
console.info(`Info streamId: ${info.streamId}`);
console.info(`Info source: ${info.capturerInfo.source}`);
console.info(`Info capturerFlags: ${info.capturerInfo.capturerFlags}`);
console.info(`Info capturerState: ${info.capturerState}`);
console.info(`Info muted: ${info.muted}`);
console.info(`Info type: ${info.deviceDescriptors[0].deviceType}`);
console.info(`Info role: ${info.deviceDescriptors[0].deviceRole}`);
console.info(`Info name: ${info.deviceDescriptors[0].name}`);
console.info(`Info address: ${info.deviceDescriptors[0].address}`);
console.info(`Info samplerates: ${info.deviceDescriptors[0].sampleRates[0]}`);
console.info(`Info channelcounts: ${info.deviceDescriptors[0].channelCounts[0]}`);
console.info(`Info channelmask: ${info.deviceDescriptors[0].channelMasks[0]}`);
console.info(`Info encodingTypes: ${info.deviceDescriptors[0].encodingTypes[0]}`);

on(‘audioInterrupt’)¹⁰⁺

on(type: ‘audioInterrupt’, callback: Callback<InterruptEvent>): void

监听音频中断事件。使用callback获取中断事件。

与on(‘interrupt’)一致，均用于监听焦点变化。AudioCapturer对象在start事件发生时会主动获取焦点，在pause、stop等事件发生时会主动释放焦点，不需要开发者主动发起获取焦点或释放焦点的申请。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’audioInterrupt’（中断事件被触发，音频采集被中断。）
callback	Callback<InterruptEvent>	是	被监听的中断事件的回调。

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

import audio from '@ohos.multimedia.audio';
let isCapturing: boolean; // 标识符，表示是否正在采集
onAudioInterrupt();

async function onAudioInterrupt(){
  audioCapturer.on('audioInterrupt', (interruptEvent: audio.InterruptEvent) => {
    if (interruptEvent.forceType == audio.InterruptForceType.INTERRUPT_FORCE) {
      // 由系统进行操作，强制打断音频采集，应用需更新自身状态及显示内容等
      switch (interruptEvent.hintType) {
        case audio.InterruptHint.INTERRUPT_HINT_PAUSE:
          // 音频流已被暂停，临时失去焦点，待可重获焦点时会收到resume对应的interruptEvent
          console.info('Force paused. Update capturing status and stop reading');
          isCapturing = false; // 简化处理，代表应用切换至暂停状态的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_STOP:
          // 音频流已被停止，永久失去焦点，若想恢复采集，需用户主动触发
          console.info('Force stopped. Update capturing status and stop reading');
          isCapturing = false; // 简化处理，代表应用切换至暂停状态的若干操作
          break;
        default:
          console.info('Invalid interruptEvent');
          break;
      }
    } else if (interruptEvent.forceType == audio.InterruptForceType.INTERRUPT_SHARE) {
      // 由应用进行操作，应用可以自主选择打断或忽略
      switch (interruptEvent.hintType) {
        case audio.InterruptHint.INTERRUPT_HINT_RESUME:
          // 建议应用继续采集（说明音频流此前被强制暂停，临时失去焦点，现在可以恢复采集）
          console.info('Resume force paused renderer or ignore');
          // 若选择继续采集，需在此处主动执行开始采集的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_PAUSE:
          // 建议应用暂停采集
          console.info('Choose to pause or ignore');
          // 若选择暂停采集，需在此处主动执行暂停采集的若干操作
          break;
        case audio.InterruptHint.INTERRUPT_HINT_STOP:
          // 建议应用停止采集
          console.info('Choose to stop or ignore');
          // 若选择停止采集，需在此处主动执行停止采集的若干操作
          break;
        default:
          break;
      }
    }
  });
}

off(‘audioInterrupt’)¹⁰⁺

off(type: ‘audioInterrupt’): void

取消订阅音频中断事件。

系统能力： SystemCapability.Multimedia.Audio.Interrupt

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’audioInterrupt’

错误码：

以下错误码的详细介绍请参见音频错误码。

错误码ID	错误信息
6800101	if input parameter value error

示例：

audioCapturer.off('audioInterrupt');

on(‘inputDeviceChange’)¹¹⁺

on(type: ‘inputDeviceChange’, callback: Callback<AudioDeviceDescriptors>): void

订阅监听音频输入设备变化。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’inputDeviceChange’。
callback	Callback<AudioDeviceDescriptors>	是	返回监听的音频输入设备变化(返回数据为切换后的设备信息)。

错误码：

错误码ID	错误信息
6800101	Input parameter value error.

示例：

audioCapturer.on('inputDeviceChange', (deviceChangeInfo: audio.AudioDeviceDescriptors) => {
  console.info(`inputDevice id: ${deviceChangeInfo[0].id}`);
  console.info(`inputDevice deviceRole: ${deviceChangeInfo[0].deviceRole}`);
  console.info(`inputDevice deviceType: ${deviceChangeInfo[0].deviceType}`);
});

off(‘inputDeviceChange’)¹¹⁺

off(type: ‘inputDeviceChange’, callback?: Callback<AudioDeviceDescriptors>): void

取消订阅音频输入设备更改事件。

系统能力： SystemCapability.Multimedia.Audio.Device

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’inputDeviceChange’。
callback	Callback<AudioDeviceDescriptors>	否	取消监听的音频输入设备变化。

错误码：

错误码ID	错误信息
6800101	Input parameter value error.

示例：

audioCapturer.off('inputDeviceChange');

on(‘audioCapturerChange’)¹¹⁺

on(type: ‘audioCapturerChange’, callback: Callback<AudioCapturerChangeInfo>): void

订阅监听录音流配置变化。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’audioCapturerChange’。
callback	Callback<AudioCapturerChangeInfo>	是	返回监听的录音流配置变化。

错误码：

错误码ID	错误信息
6800101	Input parameter value error.

示例：

audioCapturer.on('audioCapturerChange', (capturerChangeInfo: audio.AudioCapturerChangeInfo) => {
  console.info(`audioCapturerChange id: ${capturerChangeInfo[0].id}`);
  console.info(`audioCapturerChange deviceRole: ${capturerChangeInfo[0].deviceRole}`);
  console.info(`audioCapturerChange deviceType: ${capturerChangeInfo[0].deviceType}`);
});

off(‘audioCapturerChange’)¹¹⁺

off(type: ‘audioCapturerChange’, callback?: Callback<AudioCapturerChangeInfo>): void

取消订阅音频输入设备更改事件。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’audioCapturerChange’。
callback	Callback<AudioCapturerChangeInfo>	否	取消监听的录音流配置变化。

错误码：

错误码ID	错误信息
6800101	Input parameter value error.

示例：

audioCapturer.off('audioCapturerChange');

on(‘markReach’)⁸⁺

on(type: ‘markReach’, frame: number, callback: Callback<number>): void

订阅标记到达的事件。当采集的帧数达到 frame 参数的值时，回调被触发。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’markReach’。
frame	number	是	触发事件的帧数。该值必须大于0。
callback	Callback<number>	是	使用callback方式异步返回被触发事件的回调。

示例：

audioCapturer.on('markReach', 1000, (position: number) => {
  if (position == 1000) {
    console.info('ON Triggered successfully');
  }
});

off(‘markReach’)⁸⁺

off(type: ‘markReach’): void

取消订阅标记到达的事件。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	取消事件回调类型，支持的事件为：’markReach’。

示例：

audioCapturer.off('markReach');

on(‘periodReach’)⁸⁺

on(type: ‘periodReach’, frame: number, callback: Callback<number>): void

订阅到达标记的事件。当采集的帧数达到 frame 参数的值时，触发回调并返回设定的值。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’periodReach’。
frame	number	是	触发事件的帧数。该值必须大于0。
callback	Callback<number>	是	使用callback方式异步返回被触发事件的回调

示例：

audioCapturer.on('periodReach', 1000, (position: number) => {
  if (position == 1000) {
    console.info('ON Triggered successfully');
  }
});

off(‘periodReach’)⁸⁺

off(type: ‘periodReach’): void

取消订阅标记到达的事件。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	取消事件回调类型，支持的事件为：’periodReach’。

示例：

audioCapturer.off('periodReach')

on(‘stateChange’) ⁸⁺

on(type: ‘stateChange’, callback: Callback): void

订阅监听状态变化。

系统能力： SystemCapability.Multimedia.Audio.Capturer

参数：

参数名	类型	必填	说明
type	string	是	事件回调类型，支持的事件为：’stateChange’。
callback	Callback<AudioState>	是	返回监听的状态。

示例：

audioCapturer.on('stateChange', (state: audio.AudioState) => {
  if (state == 1) {
    console.info('audio capturer state is: STATE_PREPARED');
  }
  if (state == 2) {
    console.info('audio capturer state is: STATE_RUNNING');
  }
});

ToneType⁹⁺

枚举，播放器的音调类型。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

名称	值	说明
TONE_TYPE_DIAL_0	0	键0的DTMF音。
TONE_TYPE_DIAL_1	1	键1的DTMF音。
TONE_TYPE_DIAL_2	2	键2的DTMF音。
TONE_TYPE_DIAL_3	3	键3的DTMF音。
TONE_TYPE_DIAL_4	4	键4的DTMF音。
TONE_TYPE_DIAL_5	5	键5的DTMF音。
TONE_TYPE_DIAL_6	6	键6的DTMF音。
TONE_TYPE_DIAL_7	7	键7的DTMF音。
TONE_TYPE_DIAL_8	8	键8的DTMF音。
TONE_TYPE_DIAL_9	9	键9的DTMF音。
TONE_TYPE_DIAL_S	10	键*的DTMF音。
TONE_TYPE_DIAL_P	11	键#的DTMF音。
TONE_TYPE_DIAL_A	12	键A的DTMF音。
TONE_TYPE_DIAL_B	13	键B的DTMF音。
TONE_TYPE_DIAL_C	14	键C的DTMF音。
TONE_TYPE_DIAL_D	15	键D的DTMF音。
TONE_TYPE_COMMON_SUPERVISORY_DIAL	100	呼叫监管音调，拨号音。
TONE_TYPE_COMMON_SUPERVISORY_BUSY	101	呼叫监管音调，忙。
TONE_TYPE_COMMON_SUPERVISORY_CONGESTION	102	呼叫监管音调，拥塞。
TONE_TYPE_COMMON_SUPERVISORY_RADIO_ACK	103	呼叫监管音调，无线电 ACK。
TONE_TYPE_COMMON_SUPERVISORY_RADIO_NOT_AVAILABLE	104	呼叫监管音调，无线电不可用。
TONE_TYPE_COMMON_SUPERVISORY_CALL_WAITING	106	呼叫监管音调，呼叫等待。
TONE_TYPE_COMMON_SUPERVISORY_RINGTONE	107	呼叫监管音调，铃声。
TONE_TYPE_COMMON_PROPRIETARY_BEEP	200	专有声调，一般蜂鸣声。
TONE_TYPE_COMMON_PROPRIETARY_ACK	201	专有声调，ACK。
TONE_TYPE_COMMON_PROPRIETARY_PROMPT	203	专有声调，PROMPT。
TONE_TYPE_COMMON_PROPRIETARY_DOUBLE_BEEP	204	专有声调，双重蜂鸣声。

TonePlayer⁹⁺

提供播放和管理DTMF（Dual Tone Multi Frequency，双音多频）音调的方法，包括各种系统监听音调、专有音调，如拨号音、通话回铃音等。

系统接口： 该接口为系统接口

load⁹⁺

load(type: ToneType, callback: AsyncCallback<void>): void

加载DTMF音调配置。使用callback方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

参数：

参数名	类型	必填	说明
type	ToneType	是	配置的音调类型。
callback	AsyncCallback	是	使用callback方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
tonePlayer.load(audio.ToneType.TONE_TYPE_DIAL_5, (err: BusinessError) => {
  if (err) {
    console.error(`callback call load failed error: ${err.message}`);
    return;
  } else {
    console.info('callback call load success');
  }
});

load⁹⁺

load(type: ToneType): Promise<void>

加载DTMF音调配置。使用Promise方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

参数：

参数名	类型	必填	说明
type	ToneType	是	配置的音调类型。

返回值：

类型	说明
Promise	使用Promise方式异步返回结果。

示例：

tonePlayer.load(audio.ToneType.TONE_TYPE_DIAL_1).then(() => {
  console.info('promise call load ');
}).catch(() => {
  console.error('promise call load fail');
});

start⁹⁺

start(callback: AsyncCallback<void>): void

启动DTMF音调播放。使用callback方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
tonePlayer.start((err: BusinessError) => {
  if (err) {
    console.error(`callback call start failed error: ${err.message}`);
    return;
  } else {
    console.info('callback call start success');
  }
});

start⁹⁺

start(): Promise<void>

启动DTMF音调播放。使用Promise方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

返回值：

类型	说明
Promise	使用Promise方式异步返回结果。

示例：

tonePlayer.start().then(() => {
  console.info('promise call start');
}).catch(() => {
  console.error('promise call start fail');
});

stop⁹⁺

stop(callback: AsyncCallback<void>): void

停止当前正在播放的音调。使用callback方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
tonePlayer.stop((err: BusinessError) => {
  if (err) {
    console.error(`callback call stop error: ${err.message}`);
    return;
  } else {
    console.error('callback call stop success ');
  }
});

stop⁹⁺

stop(): Promise<void>

停止当前正在播放的音调。使用Promise方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

返回值：

类型	说明
Promise	使用Promise方式异步返回结果。

示例：

tonePlayer.stop().then(() => {
  console.info('promise call stop finish');
}).catch(() => {
  console.error('promise call stop fail');
});

release⁹⁺

release(callback: AsyncCallback<void>): void

释放与此TonePlayer对象关联的资源。使用callback方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	使用callback方式异步返回结果。

示例：

import { BusinessError } from '@ohos.base';
tonePlayer.release((err: BusinessError) => {
  if (err) {
    console.error(`callback call release failed error: ${err.message}`);
    return;
  } else {
    console.info('callback call release success ');
  }
});

release⁹⁺

release(): Promise<void>

释放与此TonePlayer对象关联的资源。使用Promise方式异步返回结果。

系统接口： 该接口为系统接口

系统能力： SystemCapability.Multimedia.Audio.Tone

返回值：

类型	说明
Promise	使用Promise方式异步返回结果。

示例：

tonePlayer.release().then(() => {
  console.info('promise call release');
}).catch(() => {
  console.error('promise call release fail');
});

ActiveDeviceType^(deprecated)

枚举，活跃设备类型。

说明：

从 API version 9 开始废弃，建议使用CommunicationDeviceType替代。

系统能力： SystemCapability.Multimedia.Audio.Device

名称	值	说明
SPEAKER	2	扬声器。
BLUETOOTH_SCO	7	蓝牙设备SCO（Synchronous Connection Oriented）连接。

InterruptActionType^(deprecated)

枚举，中断事件返回类型。

说明：

从 API version 7 开始支持，从 API version 9 开始废弃。无替代接口，与中断事件配套使用。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	值	说明
TYPE_ACTIVATED	0	表示触发焦点事件。
TYPE_INTERRUPT	1	表示音频打断事件。

AudioInterrupt^(deprecated)

音频监听事件传入的参数。

说明：

从 API version 7 开始支持，从 API version 9 开始废弃。无替代接口，与中断事件配套使用。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	类型	必填	说明
streamUsage	StreamUsage	是	音频流使用类型。
contentType	ContentType	是	音频打断媒体类型。
pauseWhenDucked	boolean	是	音频打断时是否可以暂停音频播放（true表示音频播放可以在音频打断期间暂停，false表示相反）。

InterruptAction^(deprecated)

音频打断/获取焦点事件的回调方法。

说明：

从 API version 7 开始支持，从 API version 9 开始废弃。建议使用InterruptEvent替代。

系统能力： SystemCapability.Multimedia.Audio.Renderer

名称	类型	必填	说明
actionType	InterruptActionType	是	事件返回类型。TYPE_ACTIVATED为焦点触发事件，TYPE_INTERRUPT为音频打断事件。
type	InterruptType	否	打断事件类型。
hint	InterruptHint	否	打断事件提示。
activated	boolean	否	获得/释放焦点。true表示焦点获取/释放成功，false表示焦点获得/释放失败。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0 赞

所属分类： 后端技术
本文标签： 鸿蒙软件
版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/60fe1d5891674c2cba9350dcf5f1dd5d

harmony 鸿蒙@ohos.multimedia.audio (音频管理)

@ohos.multimedia.audio (音频管理)

导入模块

常量

audio.getAudioManager

audio.createAudioRenderer8+

audio.createAudioRenderer8+

audio.createAudioCapturer8+

audio.createAudioCapturer8+

audio.createTonePlayer9+

audio.createTonePlayer9+

AudioVolumeType

InterruptRequestResultType9+

InterruptMode9+

DeviceFlag

DeviceRole

DeviceType

CommunicationDeviceType9+

AudioRingMode

AudioSampleFormat8+

AudioErrors9+

AudioChannel8+

AudioSamplingRate8+

AudioEncodingType8+

ContentType

StreamUsage

InterruptRequestType9+

AudioState8+

AudioEffectMode10+

AudioRendererRate8+

InterruptType

InterruptForceType9+

InterruptHint

AudioStreamInfo8+

AudioRendererInfo8+

InterruptResult9+

AudioRendererOptions8+

AudioPrivacyType10+

InterruptEvent9+

VolumeEvent9+

MicStateChangeEvent9+

ConnectType9+

VolumeGroupInfos9+

VolumeGroupInfo9+

DeviceChangeAction

ChannelBlendMode11+

DeviceChangeType

AudioCapturerOptions8+

AudioCapturerInfo8+

SourceType8+

AudioPlaybackCaptureConfig10+

CaptureFilterOptions10+

AudioScene8+

VolumeAdjustType10+

AudioManager

setAudioParameter

setAudioParameter

getAudioParameter

getAudioParameter

setAudioScene8+

setAudioScene8+

getAudioScene8+

getAudioScene8+

getAudioSceneSync10+

getVolumeManager9+

getStreamManager9+

getRoutingManager9+

setVolume(deprecated)

setVolume(deprecated)

getVolume(deprecated)

getVolume(deprecated)

getMinVolume(deprecated)

getMinVolume(deprecated)

getMaxVolume(deprecated)

getMaxVolume(deprecated)

mute(deprecated)

mute(deprecated)

isMute(deprecated)

isMute(deprecated)

isActive(deprecated)

audio.createAudioRenderer⁸⁺

audio.createAudioRenderer⁸⁺

audio.createAudioCapturer⁸⁺

audio.createAudioCapturer⁸⁺

audio.createTonePlayer⁹⁺

audio.createTonePlayer⁹⁺

InterruptRequestResultType⁹⁺

InterruptMode⁹⁺

CommunicationDeviceType⁹⁺

AudioSampleFormat⁸⁺

AudioErrors⁹⁺

AudioChannel⁸⁺

AudioSamplingRate⁸⁺

AudioEncodingType⁸⁺

InterruptRequestType⁹⁺

AudioState⁸⁺

AudioEffectMode¹⁰⁺

AudioRendererRate⁸⁺

InterruptForceType⁹⁺

AudioStreamInfo⁸⁺

AudioRendererInfo⁸⁺

InterruptResult⁹⁺

AudioRendererOptions⁸⁺

AudioPrivacyType¹⁰⁺

InterruptEvent⁹⁺

VolumeEvent⁹⁺

MicStateChangeEvent⁹⁺

ConnectType⁹⁺

VolumeGroupInfos⁹⁺

VolumeGroupInfo⁹⁺

ChannelBlendMode¹¹⁺

AudioCapturerOptions⁸⁺

AudioCapturerInfo⁸⁺

SourceType⁸⁺

AudioPlaybackCaptureConfig¹⁰⁺

CaptureFilterOptions¹⁰⁺

AudioScene⁸⁺

VolumeAdjustType¹⁰⁺

setAudioScene⁸⁺

setAudioScene⁸⁺

getAudioScene⁸⁺

getAudioScene⁸⁺

getAudioSceneSync¹⁰⁺

getVolumeManager⁹⁺

getStreamManager⁹⁺

getRoutingManager⁹⁺

setVolume^(deprecated)

setVolume^(deprecated)

getVolume^(deprecated)

getVolume^(deprecated)

getMinVolume^(deprecated)

getMinVolume^(deprecated)

getMaxVolume^(deprecated)

getMaxVolume^(deprecated)

mute^(deprecated)

mute^(deprecated)

isMute^(deprecated)

isMute^(deprecated)

isActive^(deprecated)

isActive^(deprecated)

setRingerMode^(deprecated)

setRingerMode^(deprecated)

getRingerMode^(deprecated)

getRingerMode^(deprecated)

getDevices^(deprecated)

getDevices^(deprecated)

setDeviceActive^(deprecated)

setDeviceActive^(deprecated)

isDeviceActive^(deprecated)

isDeviceActive^(deprecated)

setMicrophoneMute^(deprecated)

setMicrophoneMute^(deprecated)

isMicrophoneMute^(deprecated)

isMicrophoneMute^(deprecated)

on(‘volumeChange’)^(deprecated)

on(‘ringerModeChange’)^(deprecated)

on(‘deviceChange’)^(deprecated)

off(‘deviceChange’)^(deprecated)

AudioVolumeManager⁹⁺

getVolumeGroupInfos⁹⁺