@ohos.multimedia.audio (音频管理)(系统接口)

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

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

• AudioManager：音频管理。
• TonePlayer：用于管理和播放DTMF（Dual Tone Multi Frequency，双音多频）音调，如拨号音、通话回铃音等。

说明：

• 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.multimedia.audio (音频管理)。

导入模块

import { audio } from '@kit.AudioKit';

常量

名称	类型	可读	可写	说明
LOCAL_NETWORK_ID9+	string	是	否	本地设备网络id。 此接口为系统接口。 系统能力： SystemCapability.Multimedia.Audio.Device

audio.createTonePlayer⁹⁺

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

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

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

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

参数：

参数名	类型	必填	说明
options	AudioRendererInfo	是	配置音频渲染器信息。
callback	AsyncCallback<TonePlayer>	是	回调函数。当获取DTMF播放器成功，err为undefined，data为获取到的DTMF播放器对象；否则为错误对象。

示例：

import { audio } from '@kit.AudioKit';

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对象，返回DTMF播放器对象。

示例：

import { audio } from '@kit.AudioKit';

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

audio.createAsrProcessingController¹²⁺

createAsrProcessingController(audioCapturer: AudioCapturer): AsrProcessingController;

获取ASR处理控制器

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

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

返回值：

类型	说明
AsrProcessingController	ASR处理控制器对象。

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.
6800104	Operation not allowed.

示例：

import { audio } from '@kit.AudioKit';

let audioStreamInfo: audio.AudioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_48000,
  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;
    let asrProcessingController = audio.createAsrProcessingController(audioCapturer);
    console.info('AsrProcessingController Created : Success : SUCCESS');
  }
});

AudioVolumeType

枚举，音频流类型。

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

名称	值	说明
ULTRASONIC10+	10	超声波。 此接口为系统接口。
ALL9+	100	所有公共音频流。 此接口为系统接口。

InterruptRequestResultType⁹⁺

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

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

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

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

DeviceFlag

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

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

名称	值	说明
NONE_DEVICES_FLAG9+	0	无设备。 此接口为系统接口。
DISTRIBUTED_OUTPUT_DEVICES_FLAG9+	4	分布式输出设备。 此接口为系统接口。
DISTRIBUTED_INPUT_DEVICES_FLAG9+	8	分布式输入设备。 此接口为系统接口。
ALL_DISTRIBUTED_DEVICES_FLAG9+	12	分布式输入和输出设备。 此接口为系统接口。

EffectFlag¹⁸⁺

枚举，音效分类。

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

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

名称	值	说明
RENDER_EFFECT_FLAG	0	下行音效类型。
CAPTURE_EFFECT_FLAG	1	上行音效类型。

AudioEffectProperty¹⁸⁺

音效属性。

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

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

名称	类型	必填	说明
name	string	是	音效名称。
category	string	是	音效分类。
flag	EffectFlag	是	音效分类。

StreamUsage

枚举，音频流使用类型。

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

名称	值	说明
STREAM_USAGE_SYSTEM10+	9	系统音(如屏幕锁定或按键音)。 此接口为系统接口。
STREAM_USAGE_DTMF10+	14	拨号音。 此接口为系统接口。
STREAM_USAGE_ENFORCED_TONE10+	15	强制音(如相机快门音)。 此接口为系统接口。
STREAM_USAGE_ULTRASONIC10+	16	超声波（目前仅提供给MSDP使用）。 此接口为系统接口。
STREAM_USAGE_VOICE_CALL_ASSISTANT12+	21	通话辅助语音。 此接口为系统接口。

InterruptRequestType⁹⁺

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

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

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

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

VolumeFlag¹²⁺

枚举，音量相关操作。

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

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

名称	值	说明
FLAG_SHOW_SYSTEM_UI	1	拉起系统音量条。

AsrNoiseSuppressionMode¹²⁺

枚举，ASR 噪音抑制模式

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

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

名称	值	说明
BYPASS	0	旁路噪音抑制
STANDARD	1	标准噪音抑制
NEAR_FIELD	2	近场噪音抑制
FAR_FIELD	3	远场噪音抑制

AsrAecMode¹²⁺

枚举，ASR AEC 模式

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

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

名称	值	说明
BYPASS	0	BYPASS AEC
STANDARD	1	STANDARD AEC

AsrWhisperDetectionMode¹²⁺

枚举，ASR（Automatic Speech Recognition，自动语音识别）耳语检测模式。

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

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

名称	值	说明
BYPASS	0	不启用检测模型。
STANDARD	1	耳语检测模型。

AsrVoiceControlMode¹²⁺

枚举，ASR音频通路模式。

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

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

名称	值	说明
AUDIO_2_VOICE_TX	0	仅媒体音频流生效。
AUDIO_MIX_2_VOICE_TX	1	媒体音频流和MIC音频流均生效。
AUDIO_2_VOICE_TX_EX	2	仅媒体音频流生效，将媒体流上报给通话录音。
AUDIO_MIX_2_VOICE_TX_EX	3	媒体音频流和MIC音频流均生效，将媒体流上报给通话录音。

AsrVoiceMuteMode¹²⁺

枚举，ASR静音模式。

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

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

名称	值	说明
OUTPUT_MUTE	0	本地输出静音。
INPUT_MUTE	1	本地的MIC输入静音。
TTS_MUTE	2	应用下发的媒体音频本地静音。
CALL_MUTE	3	通话语音流静音。
OUTPUT_MUTE_EX	4	本地输出静音，媒体音频流送给通话录音。

InterruptResult⁹⁺

音频中断结果。

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

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

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

VolumeEvent⁹⁺

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

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

名称	类型	必填	说明
volumeGroupId	number	是	音量组id，可用于getGroupManager入参。 此接口为系统接口。
networkId	string	是	网络id。 此接口为系统接口。

ConnectType⁹⁺

枚举，设备连接类型。

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

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

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

VolumeGroupInfos⁹⁺

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

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

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

VolumeGroupInfo⁹⁺

音量组信息。

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

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

名称	类型	可读	可写	说明
networkId9+	string	是	否	组网络id。
groupId9+	number	是	否	组设备组id。
mappingId9+	number	是	否	组映射id。
groupName9+	string	是	否	组名。
type9+	ConnectType	是	否	连接设备类型。

SourceType⁸⁺

枚举，音源类型。

名称	值	说明
SOURCE_TYPE_WAKEUP 10+	3	语音唤醒音频流录制音频源。 系统能力： SystemCapability.Multimedia.Audio.Core 需要权限： ohos.permission.MANAGE_INTELLIGENT_VOICE 此接口为系统接口
SOURCE_TYPE_VOICE_CALL11+	4	通话录音的音频源。 系统能力： SystemCapability.Multimedia.Audio.Core 需要权限： ohos.permission.RECORD_VOICE_CALL 此接口为系统接口
SOURCE_TYPE_VOICE_TRANSCRIPTION18+	12	语音转写音频源。 系统能力： SystemCapability.Multimedia.Audio.Core 此接口为系统接口

VolumeAdjustType¹⁰⁺

枚举，音量调节类型。

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

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

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

AudioManager

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

setExtraParameters¹¹⁺

setExtraParameters(mainKey: string, kvpairs: Record<string, string>): Promise<void>

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

需要权限： ohos.permission.MODIFY_AUDIO_SETTINGS

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

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

参数：

参数名	类型	必填	说明
mainKey	string	是	被设置的音频参数的主键。
kvpairs	Record<string, string>	是	被设置的音频参数的子键值对。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let kvpairs = {} as Record<string, string>;
kvpairs = {
  'key_example': 'value_example'
};

audioManager.setExtraParameters('key_example', kvpairs).then(() => {
  console.info('Promise returned to indicate a successful setting of the extra parameters.');
}).catch ((err: BusinessError) => {
  console.error(`Failed to set the audio extra parameters ${err}`);
});

getExtraParameters¹¹⁺

getExtraParameters(mainKey: string, subKeys?: Array<string>): Promise<Record<string, string>>

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

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

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

参数：

参数名	类型	必填	说明
mainKey	string	是	待获取的音频参数的主键。
subKeys	Array<string>	否	待获取的音频参数的子键。

返回值：

类型	说明
Promise<Record<string, string>>	Promise对象，返回获取的音频参数的值。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let subKeys: Array<String> = ['key_example'];
audioManager.getExtraParameters('key_example', subKeys).then((value: Record<string, string>) => {
  console.info(`Promise returned to indicate that the value of the audio extra parameters is obtained ${value}.`);
}).catch ((err: BusinessError) => {
  console.error(`Failed to get the audio extra parameters ${err}`);
});

setAudioScene⁸⁺

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

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

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

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

参数：

参数名	类型	必填	说明
scene	AudioScene	是	音频场景模式。
callback	AsyncCallback<void>	是	回调函数。当设置音频场景模式成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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<void>

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

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

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

参数：

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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}`);
});

getEffectManager¹⁸⁺

getEffectManager(): AudioEffectManager

获取音效会话管理器。

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

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

返回值：

类型	说明
AudioEffectManager	AudioEffectManager实例

错误码：

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

错误码ID	错误信息
202	Not system App.

示例：

import { audio } from '@kit.AudioKit';

let audioEffectManager: audio.AudioEffectManager = audioManager.getEffectManager();

disableSafeMediaVolume¹²⁺

disableSafeMediaVolume(): Promise<void>

设置安全音量为非激活状态。使用Promise方式异步返回结果。

设置为非激活状态后，当设备长时间高音量播放时，不再自动提醒用户降低到安全音量。

需要权限： ohos.permission.MODIFY_AUDIO_SETTINGS

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

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
201	Permission denied.
202	Not system App.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

audioManager.disableSafeMediaVolume().then(() => {
  console.info('disableSafeMediaVolume success.');
}).catch ((err: BusinessError) => {
  console.error(`disableSafeMediaVolume fail: ${err.code},${err.message}`);
});

on('volumeChange')^(deprecated)

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

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

监听系统音量变化事件（当系统音量发生变化时触发），使用callback方式返回结果。

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

目前此订阅接口在单进程多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

监听铃声模式变化事件（当铃声模式发生改变时触发），使用callback方式返回结果。

说明： 从 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}`);
});

AudioVolumeManager⁹⁺

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

getVolumeGroupInfos⁹⁺

getVolumeGroupInfos(networkId: string, callback: AsyncCallback<VolumeGroupInfos>): void

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

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

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

参数：

参数名	类型	必填	说明
networkId	string	是	设备的网络id。本地设备audio.LOCAL_NETWORK_ID。
callback	AsyncCallback<VolumeGroupInfos>	是	回调函数。当获取音量组信息列表成功，err为undefined，data为获取到的音量组信息列表；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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<VolumeGroupInfos>

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

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

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

参数：

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

返回值：

类型	说明
Promise<VolumeGroupInfos>	Promise对象，返回音量组信息列表。

示例：

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	音量组信息列表。

错误码：

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

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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}`);
}

getAppVolumePercentageForUid¹⁸⁺

getAppVolumePercentageForUid(uid: number): Promise<number>

根据应用ID获取指定应用的音量（范围为0到100）。使用Promise异步回调。

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

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

参数：

参数名	类型	必填	说明
uid	number	是	表示应用ID。

返回值：

类型	说明
Promise<number>	Promise对象，返回应用的音量（范围为0到100）。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

let uid: number = 20010041; // 应用ID。

audioVolumeManager.getAppVolumePercentageForUid(20010041).then((value: number) => {
  console.info(`app volume is ${value}.`);
});

setAppVolumePercentageForUid¹⁸⁺

setAppVolumePercentageForUid(uid: number, volume: number): Promise<void>

根据应用ID设置指定应用的音量（范围为0到100）。使用Promise异步回调。

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

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

参数：

参数名	类型	必填	说明
uid	number	是	表示应用ID。
volume	number	是	要设置的音量值。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.
6800301	Crash or blocking occurs in system process.

示例：

let uid: number = 20010041; // 应用ID。
let volume: number = 20;    // 要设置的音量值。

audioVolumeManager.setAppVolumePercentageForUid(uid, volume).then(() => {
  console.info(`set app volume success.`);
});

isAppVolumeMutedForUid¹⁸⁺

isAppVolumeMutedForUid(uid: number, owned: boolean): Promise<boolean>

根据应用ID查询应用音量是否已静音。使用Promise异步回调。

说明：

如果有多个调用者设置了静音状态，那么只有当所有调用者都取消静音状态后，此应用才会真正取消静音。

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

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

参数：

参数名	类型	必填	说明
uid	number	是	表示应用ID。
owned	boolean	是	要查询的静音状态。true查询当前调用者的静音状态，false查询应用的静音状态。

返回值：

类型	说明
Promise<boolean>	Promise对象，返回应用静音状态。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

let uid: number = 20010041; // 应用ID。

audioVolumeManager.setAppVolumePercentageForUid(uid, true).then((value: boolean) => {
  console.info(`app muted state is ${value}.`);
});

setAppVolumeMutedForUid¹⁸⁺

setAppVolumeMutedForUid(uid: number, muted: boolean): Promise<void>

根据应用ID设置应用静音状态。使用Promise异步回调。

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

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

参数：

参数名	类型	必填	说明
uid	number	是	表示应用ID。
owned	boolean	是	设置应用的静音状态。true设置为静音，false解除静音。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.
6800301	Crash or blocking occurs in system process.

示例：

let uid: number = 20010041; // 应用ID。

audioVolumeManager.setAppVolumePercentageForUid(uid, true).then(() => {
  console.info(`set app mute state success.`);
});

on('appVolumeChangeForUid')¹⁸⁺

on(type: 'appVolumeChangeForUid', uid: number, callback: Callback<VolumeEvent>): void

监听指定应用应用级音量变化事件（当应用级音量发生变化时触发）。使用callback方式返回结果。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'appVolumeChangeForUid'。
uid	number	是	表示应用ID。
callback	Callback<VolumeEvent>	是	回调函数，返回变化后的音量信息。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

let uid: number = 20010041; // 应用ID。

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

off('appVolumeChangeForUid')¹⁸⁺

off(type: 'appVolumeChangeForUid', callback?: Callback<VolumeEvent>): void

取消监听指定应用应用级音量变化事件。使用callback方式返回结果。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'appVolumeChangeForUid'。
callback	Callback<VolumeEvent>	否	回调函数，返回变化后的音量信息。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

// 取消该事件的所有监听。
audioVolumeManager.off('appVolumeChangeForUid');

// 同一监听事件中，on方法和off方法传入callback参数一致，off方法取消对应on方法订阅的监听。
let appVolumeChangeForUidCallback = (volumeEvent: audio.VolumeEvent) => {
  console.info(`VolumeType of stream: ${volumeEvent.volumeType} `);
  console.info(`Volume level: ${volumeEvent.volume} `);
  console.info(`Whether to updateUI: ${volumeEvent.updateUi} `);
};

audioVolumeManager.on('appVolumeChangeForUid', appVolumeChangeForUidCallback);

audioVolumeManager.off('appVolumeChangeForUid', appVolumeChangeForUidCallback);

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>	是	回调函数。当设置指定流的音量成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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.');
});

setVolumeWithFlag¹²⁺

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

设置指定流的音量，同时指定本次修改音量是否要显示系统音量条，使用Promise方式异步返回结果。

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

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

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

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

参数：

参数名	类型	必填	说明
volumeType	AudioVolumeType	是	音量流类型。
volume	number	是	音量等级，可设置范围通过getMinVolume和getMaxVolume获取。
flags	number	是	是否需要显示系统音量条，0为不需要显示，1为需要显示。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Not system App.

示例：

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

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>	是	回调函数。当设置指定音量流静音成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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.');
});

setRingerMode⁹⁺

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

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

需要权限： ohos.permission.ACCESS_NOTIFICATION_POLICY

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

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

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

参数：

参数名	类型	必填	说明
mode	AudioRingMode	是	音频铃声模式。
callback	AsyncCallback<void>	是	回调函数。当设置铃声模式成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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.');
});

setMicMute¹¹⁺

setMicMute(mute: boolean): Promise<void>

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

需要权限： ohos.permission.MANAGE_AUDIO_CONFIG

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

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

参数：

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

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

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

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>	是	回调函数。当调节当前最高优先级的流的音量成功，err为undefined，否则为错误对象。

错误码：

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

错误码ID	错误信息
201	Permission denied.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed. Return by callback.
6800301	System error. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed. Return by promise.
6800301	System error. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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>	是	回调函数。当单步设置指定流的音量成功，err为undefined，否则为错误对象。

错误码：

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

错误码ID	错误信息
201	Permission denied.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed. Return by callback.
6800301	System error. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed. Return by promise.
6800301	System error. Return by promise.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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.');
});

AudioEffectManager¹⁸⁺

音频效果管理。在使用AudioEffectManager的接口前，需要使用getEffectManager获取AudioEffectManager实例。

getSupportedAudioEffectProperty¹⁸⁺

getSupportedAudioEffectProperty(): Array<AudioEffectProperty>

获取支持的下行音效模式，同步返回结果。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

返回值：

类型	说明
Array<AudioEffectProperty>	返回当前设备支持的音效模式。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Caller is not a system application.
6800301	System error. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let propertyArray: Array<audio.AudioEffectProperty> = audioStreamManager.getSupportedAudioEffectProperty();
  console.info(`The effect modes are: ${propertyArray}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`getSupportedAudioEffectProperty ERROR: ${error}`);
}

getAudioEffectProperty¹⁸⁺

getAudioEffectProperty(): Array<AudioEffectProperty>

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

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

返回值：

类型	说明
Array<AudioEffectProperty>	返回当前音效模式。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Caller is not a system application.
6800301	System error. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let propertyArray: Array<audio.AudioEffectProperty> = audioStreamManager.getAudioEffectProperty();
  console.info(`The effect modes are: ${propertyArray}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`getAudioEffectProperty ERROR: ${error}`);
}

setAudioEffectProperty¹⁸⁺

setAudioEffectProperty(propertyArray: Array<AudioEffectProperty>): void

设置当前音效模式，同步返回结果。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
propertyArray	Array<AudioEffectProperty>	是	需要设置的音效模式。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Caller is not a system application.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed. Possible causes: 1.more than one enhanceProps of the same enhanceClass in input Array; 2.input audioEnhanceProperties are not supported by current device. 3.names of enhanceProp or enhanceClass are incorrect.
6800301	System error. Return by callback.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let propertyArray: Array<audio.AudioEffectProperty> = audioEffectManager.getAudioEffectProperty();
  console.info(`The effect modes are: ${propertyArray}`);
  audioEffectManager.setAudioEffectProperty(propertyArray);
} catch (err) {
  let error = err as BusinessError;
  console.error(`setAudioEffectProperty ERROR: ${error}`);
}

AudioRoutingManager⁹⁺

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

selectInputDevice⁹⁺

selectInputDevice(inputAudioDevices: AudioDeviceDescriptors, callback: AsyncCallback<void>): void

选择音频输入设备，当前只能选择一个输入设备，使用callback方式异步返回结果。

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

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

参数：

参数名	类型	必填	说明
inputAudioDevices	AudioDeviceDescriptors	是	输入设备类。
callback	AsyncCallback<void>	是	回调函数。当选择音频输入设备成功，err为undefined，否则为错误对象。

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let inputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.INPUT_DEVICE,
  deviceType : audio.DeviceType.MIC,
  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 '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let inputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.INPUT_DEVICE,
  deviceType : audio.DeviceType.MIC,
  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}`);
  });
}

selectOutputDevice⁹⁺

selectOutputDevice(outputAudioDevices: AudioDeviceDescriptors, callback: AsyncCallback<void>): void

选择音频输出设备，当前只能选择一个输出设备，使用callback方式异步返回结果。

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

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

参数：

参数名	类型	必填	说明
outputAudioDevices	AudioDeviceDescriptors	是	输出设备类。
callback	AsyncCallback<void>	是	回调函数。当选择音频输出设备成功，err为undefined，否则为错误对象。

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

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 '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

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>	是	回调函数。当选择音频输出设备成功，err为undefined，否则为错误对象。

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let outputAudioRendererFilter: audio.AudioRendererFilter = {
  uid : 20010041,
  rendererInfo : {
    usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
    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 '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let outputAudioRendererFilter: audio.AudioRendererFilter = {
  uid : 20010041,
  rendererInfo : {
    usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
    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}`);
  })
}

selectInputDeviceByFilter¹⁸⁺

selectInputDeviceByFilter(filter: AudioCapturerFilter, inputAudioDevices: AudioDeviceDescriptors): Promise<void>

根据过滤条件，选择音频输入设备，当前只能选择一个输入设备。使用Promise异步回调。

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

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

参数：

参数名	类型	必填	说明
filter	AudioCapturerFilter	是	过滤条件类。
inputAudioDevices	AudioDeviceDescriptors	是	输入设备类。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let inputAudioCapturerFilter: audio.AudioCapturerFilter = {
    uid : 20010041,
    capturerInfo : {
        source: audio.SourceType.SOURCE_TYPE_MIC,
        capturerFlags: 0
    }
};

let inputAudioDeviceDescriptor: audio.AudioDeviceDescriptors = [{
    deviceRole : audio.DeviceRole.INPUT_DEVICE,
    deviceType : audio.DeviceType.MIC,
    id : 1,
    name : "",
    address : "",
    sampleRates : [44100],
    channelCounts : [2],
    channelMasks : [0],
    networkId : audio.LOCAL_NETWORK_ID,
    interruptGroupId : 1,
    volumeGroupId : 1,
    displayName : "",
}];

async function selectInputDeviceByFilter(){
    let audioManager = audio.getAudioManager();  // 需要先创建AudioManager实例。
    let audioRoutingManager = audioManager.getRoutingManager();  // 再调用AudioManager的方法创建AudioRoutingManager实例。
    audioRoutingManager.selectInputDeviceByFilter(inputAudioCapturerFilter, inputAudioDeviceDescriptor).then(() => {
        console.info('Select input devices by filter result promise: SUCCESS');
    }).catch((err: BusinessError) => {
        console.error(`Result ERROR: ${err}`);
    })
}

getPreferredOutputDeviceByFilter¹⁸⁺

getPreferredOutputDeviceByFilter(filter: AudioRendererFilter): AudioDeviceDescriptors

根据过滤条件，查询音频输出设备。

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

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

参数：

参数名	类型	必填	说明
filter	AudioRendererFilter	是	过滤条件类。

返回值：

类型	说明
AudioDeviceDescriptors	return the device list.

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let outputAudioRendererFilter: audio.AudioRendererFilter = {
  uid : 20010041,
  rendererInfo : {
    usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
    rendererFlags : 0
  },
  rendererId : 0
};

async function selectOutputDeviceByFilter(){
    let audioManager = audio.getAudioManager();  // 需要先创建AudioManager实例。
    let audioRoutingManager = audioManager.getRoutingManager();  // 再调用AudioManager的方法创建AudioRoutingManager实例。
    let desc : audio.AudioDeviceDescriptors = audioRoutingManager.getPreferredOutputDeviceByFilter(outputAudioRendererFilter);
    console.info(`device descriptor: ${desc}`);
}

getPreferredInputDeviceByFilter¹⁸⁺

getPreferredInputDeviceByFilter(filter: AudioCapturerFilter): AudioDeviceDescriptors

根据过滤条件，查询音频输入设备，当前只能查询一个输入设备。

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

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

参数：

参数名	类型	必填	说明
filter	AudioCapturerFilter	是	过滤条件类。

返回值：

类型	说明
AudioDeviceDescriptors	return the device list.

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和Audio错误码。

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let inputAudioCapturerFilter: audio.AudioCapturerFilter = {
    uid : 20010041,
    capturerInfo : {
        source: audio.SourceType.SOURCE_TYPE_MIC,
        capturerFlags: 0
    }
};

async function getPreferredInputDeviceByFilter(){
    let audioManager = audio.getAudioManager();  // 需要先创建AudioManager实例。
    let audioRoutingManager = audioManager.getRoutingManager();  // 再调用AudioManager的方法创建AudioRoutingManager实例。
    let desc: audio.AudioDeviceDescriptors = audioRoutingManager.getPreferredInputDeviceByFilter(inputAudioCapturerFilter);
    console.info(`device descriptor: ${desc}`);
}

excludeOutputDevices¹⁶⁺

excludeOutputDevices(usage: DeviceUsage, devices: AudioDeviceDescriptors): Promise<void>

排除输出设备。成功调用此函数后，音频将不会在指定的设备上播放。

说明：

该功能仅能排除外部输出设备，不支持本地输出设备。

需要权限： ohos.permission.MANAGE_AUDIO_CONFIG

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

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

参数：

参数名	类型	必填	说明
usage	DeviceUsage	是	设备种类。只支持排除输出设备。
devices	AudioDeviceDescriptors	是	排除输出设备列表。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果。

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let usage: audio.DeviceUsage.MEDIA_OUTPUT_DEVICES;
let excludedDevices: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.BLUETOOTH_A2DP,
  id : 3,
  name : "",
  address : "",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : "",
}];

async function excludeOutputDevices(){
  audioRoutingManager.excludeOutputDevices(usage, excludedDevices, (err: BusinessError) => {
    if (err) {
      console.error(`Result ERROR: ${err}`);
    } else {
      console.info('Exclude Output Devices result callback: SUCCESS'); }
  });
}

unexcludeOutputDevices¹⁶⁺

unexcludeOutputDevices(usage: DeviceUsage, devices: AudioDeviceDescriptors): Promise<void>

解除排除输出设备。成功调用此函数后，音频将会重新选择输出设备。

需要权限： ohos.permission.MANAGE_AUDIO_CONFIG

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

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

参数：

参数名	类型	必填	说明
usage	DeviceUsage	是	设备种类。只支持排除输出设备。
devices	AudioDeviceDescriptors	是	解除排除输出设备列表。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果。

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let usage: audio.DeviceUsage.MEDIA_OUTPUT_DEVICES;
let unexcludedDevices: audio.AudioDeviceDescriptors = [{
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.BLUETOOTH_A2DP,
  id : 3,
  name : "",
  address : "",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : "",
}];

async function unexcludeOutputDevices(){
  audioRoutingManager.unexcludeOutputDevices(usage, unexcludedDevices, (err: BusinessError) => {
    if (err) {
      console.error(`Result ERROR: ${err}`);
    } else {
      console.info('Unexclude Output Devices result callback: SUCCESS'); }
  });
}

unexcludeOutputDevices¹⁶⁺

unexcludeOutputDevices(usage: DeviceUsage): Promise<void>

解除属于特定用途的所有输出设备的排除。成功调用此函数后，音频将会重新选择输出设备。

需要权限： ohos.permission.MANAGE_AUDIO_CONFIG

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

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

参数：

参数名	类型	必填	说明
usage	DeviceUsage	是	设备种类。只支持排除输出设备。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果。

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let usage: audio.DeviceUsage.MEDIA_OUTPUT_DEVICES;

async function unexcludeOutputDevices(){
  audioRoutingManager.unexcludeOutputDevices(usage).then(() => {
    console.info('Unexclude Output Devices result promise: SUCCESS');
  }).catch((err: BusinessError) => {
    console.error(`Result ERROR: ${err}`);
  });
}

getExcludedDevices¹⁶⁺

getExcludedDevices(usage: DeviceUsage): AudioDeviceDescriptors

获取排除输出设备列表。

需要权限： ohos.permission.MANAGE_AUDIO_CONFIG

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

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

参数：

参数名	类型	必填	说明
usage	DeviceUsage	是	设备种类。只支持排除输出设备。

返回值：

类型	说明
AudioDeviceDescriptors	排除设备列表。

示例：

import { audio } from '@kit.AudioKit';

let usage: audio.DeviceUsage.MEDIA_OUTPUT_DEVICES;

async function getExcludedDevices(){
  let desc: audio.AudioDeviceDescriptors = audioRoutingManager.getExcludedDevices(usage);
  console.info(`device descriptor: ${desc}`);
}

AudioRendererChangeInfo⁹⁺

描述音频渲染器更改信息。

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

名称	类型	可读	可写	说明
clientUid	number	是	否	音频渲染器客户端应用程序的Uid。 此接口为系统接口。
rendererState	AudioState	是	否	音频状态。 此接口为系统接口。

AudioCapturerChangeInfo⁹⁺

描述音频采集器更改信息。

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

名称	类型	可读	可写	说明
clientUid	number	是	否	音频采集器客户端应用程序的Uid。 此接口为系统接口。
capturerState	AudioState	是	否	音频状态。 此接口为系统接口。

AudioDeviceDescriptor

描述音频设备。

名称	类型	可读	可写	说明
networkId9+	string	是	否	设备组网的ID。 此接口为系统接口。 系统能力： SystemCapability.Multimedia.Audio.Device
interruptGroupId9+	number	是	否	设备所处的焦点组ID。 此接口为系统接口。 系统能力： SystemCapability.Multimedia.Audio.Device
volumeGroupId9+	number	是	否	设备所处的音量组ID。 此接口为系统接口。 系统能力： SystemCapability.Multimedia.Audio.Device

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 '@kit.AudioKit';

let outputAudioRendererFilter: audio.AudioRendererFilter = {
  uid : 20010041,
  rendererInfo : {
    usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
    rendererFlags : 0
  },
  rendererId : 0
};

AudioCapturerFilter¹⁸⁺

过滤条件类。在调用selectOutputDeviceByFilter接口前，需要先创建AudioCapturerFilter实例。

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

名称	类型	必填	说明
uid	number	否	表示应用ID。 系统能力： SystemCapability.Multimedia.Audio.Core
capturerInfo	AudioCapturerInfo	否	表示采集器信息。。 系统能力： SystemCapability.Multimedia.Audio.Capturer

示例：

import { audio } from '@kit.AudioKit';

let inputAudioCapturerFilter: audio.AudioCapturerFilter = {
    uid : 20010041,
    capturerInfo : {
        source: audio.SourceType.SOURCE_TYPE_MIC,
        capturerFlags: 0
    }
};

AudioSpatialEnabledStateForDevice¹²⁺

监听设备空间音频开关状态。

系统接口：此接口为系统接口。

系统能力：SystemCapability.Multimedia.Audio

参数名	类型	必填	说明
deviceDescriptor	AudioDeviceDescriptor	是	指定设备的描述。
enabled	boolean	是	表示开启/关闭空间音频渲染或头动。true为开启，false为关闭。

AudioSpatializationManager¹¹⁺

空间音频管理。在使用AudioSpatializationManager的接口前，需要使用getSpatializationManager获取AudioSpatializationManager实例。

isSpatializationSupported¹¹⁺

isSpatializationSupported(): boolean

获取系统是否支持空间音频，同步返回结果。

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

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

返回值：

类型	说明
boolean	返回系统是否支持空间音频，true为支持，false为不支持。

错误码：

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

错误码ID	错误信息
202	Not system App.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
  let isSpatializationSupported: boolean = audioSpatializationManager.isSpatializationSupported();
  console.info(`AudioSpatializationManager isSpatializationSupported: ${isSpatializationSupported}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

isSpatializationSupportedForDevice¹¹⁺

isSpatializationSupportedForDevice(deviceDescriptor: AudioDeviceDescriptor): boolean

获取指定设备是否支持空间音频，同步返回结果。

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

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

参数：

参数名	类型	必填	说明
deviceDescriptor	AudioDeviceDescriptor	是	指定设备的描述。

返回值：

类型	说明
boolean	返回指定设备是否支持空间音频，true为支持，false为不支持。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let deviceDescriptor: audio.AudioDeviceDescriptor = {
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.BLUETOOTH_A2DP,
  id : 1,
  name : "",
  address : "123",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : ""
};

try {
  let isSpatializationSupportedForDevice: boolean = audioSpatializationManager.isSpatializationSupportedForDevice(deviceDescriptor);
  console.info(`AudioSpatializationManager isSpatializationSupportedForDevice: ${isSpatializationSupportedForDevice}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

isHeadTrackingSupported¹¹⁺

isHeadTrackingSupported(): boolean

获取系统是否支持头动跟踪，同步返回结果。

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

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

返回值：

类型	说明
boolean	返回系统是否支持头动跟踪，true为支持，false为不支持。

错误码：

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

错误码ID	错误信息
202	Not system App.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  let isHeadTrackingSupported: boolean = audioSpatializationManager.isHeadTrackingSupported();
  console.info(`AudioSpatializationManager isHeadTrackingSupported: ${isHeadTrackingSupported}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

isHeadTrackingSupportedForDevice¹¹⁺

isHeadTrackingSupportedForDevice(deviceDescriptor: AudioDeviceDescriptor): boolean

获取指定设备是否支持头动跟踪，同步返回结果。

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

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

参数：

参数名	类型	必填	说明
deviceDescriptor	AudioDeviceDescriptor	是	指定设备的描述。

返回值：

类型	说明
boolean	返回指定设备是否支持头动跟踪，true为支持，false为不支持。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let deviceDescriptor: audio.AudioDeviceDescriptor = {
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.BLUETOOTH_A2DP,
  id : 1,
  name : "",
  address : "123",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : ""
};

try {
  let isHeadTrackingSupportedForDevice: boolean = audioSpatializationManager.isHeadTrackingSupportedForDevice(deviceDescriptor);
  console.info(`AudioSpatializationManager isHeadTrackingSupportedForDevice: ${isHeadTrackingSupportedForDevice}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

setSpatializationEnabled^(deprecated)

setSpatializationEnabled(enable: boolean, callback: AsyncCallback<void>): void

根据输入指令，开启/关闭空间音频渲染效果，使用callback方式异步返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用setSpatializationEnabled(deviceDescriptor: AudioDeviceDescriptor, enabled: boolean): Promise<void>替代。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
enable	boolean	是	表示开启/关闭空间音频渲染。true为开启，false为关闭。
callback	AsyncCallback<void>	是	AsyncCallback对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied. Return by callback.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let enable: boolean = true;

audioSpatializationManager.setSpatializationEnabled(enable, (err: BusinessError) => {
  if (err) {
    console.error(`Result ERROR: ${err}`);
  } else {
    console.info(`setSpatializationEnabled success`);
  }
});

setSpatializationEnabled^(deprecated)

setSpatializationEnabled(enable: boolean): Promise<void>

根据输入指令，开启/关闭空间音频渲染效果，使用Promise方式异步返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用setSpatializationEnabled(deviceDescriptor: AudioDeviceDescriptor, enabled: boolean): Promise<void>替代。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
enable	boolean	是	表示开启/关闭空间音频渲染。true为开启，false为关闭。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied. Return by promise.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let enable: boolean = true;

audioSpatializationManager.setSpatializationEnabled(enable).then(() => {
  console.info(`setSpatializationEnabled success`);
}).catch((err: BusinessError) => {
  console.error(`Result ERROR: ${err}`);
});

setSpatializationEnabled¹²⁺

setSpatializationEnabled(deviceDescriptor: AudioDeviceDescriptor, enabled: boolean): Promise<void>

根据输入指令，开启/关闭指定设备的空间音频渲染效果，使用Promise方式异步返回结果。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
deviceDescriptor	AudioDeviceDescriptor	是	指定设备的描述。
enabled	boolean	是	表示开启/关闭空间音频渲染。true为开启，false为关闭。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied. Return by promise.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let deviceDescriptor: audio.AudioDeviceDescriptor = {
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.BLUETOOTH_A2DP,
  id : 1,
  name : "",
  address : "123",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : ""
};
let enabled: boolean = true;

audioSpatializationManager.setSpatializationEnabled(deviceDescriptor, enabled).then(() => {
  console.info(`setSpatializationEnabled success`);
}).catch((err: BusinessError) => {
  console.error(`Result ERROR: ${err}`);
});

isSpatializationEnabled^(deprecated)

isSpatializationEnabled(): boolean

获取空间音频渲染是否开启，同步返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用isSpatializationEnabled(deviceDescriptor: AudioDeviceDescriptor): boolean替代。

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

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

返回值：

类型	说明
boolean	返回空间音频渲染是否开启，true为开启，false为未开启。

错误码：

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

错误码ID	错误信息
202	Not system App.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  let isSpatializationEnabled: boolean = audioSpatializationManager.isSpatializationEnabled();
  console.info(`AudioSpatializationManager isSpatializationEnabled: ${isSpatializationEnabled}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

isSpatializationEnabled¹²⁺

isSpatializationEnabled(deviceDescriptor: AudioDeviceDescriptor): boolean

获取指定设备的空间音频渲染是否开启，同步返回结果。

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

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

参数：

参数名	类型	必填	说明
deviceDescriptor	AudioDeviceDescriptor	是	指定设备的描述。

返回值：

类型	说明
boolean	返回指定设备的空间音频渲染是否开启，true为开启，false为未开启。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let deviceDescriptor: audio.AudioDeviceDescriptor = {
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.BLUETOOTH_A2DP,
  id : 1,
  name : "",
  address : "123",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : ""
};

try {
  let isSpatializationEnabled: boolean = audioSpatializationManager.isSpatializationEnabled(deviceDescriptor);
  console.info(`AudioSpatializationManager isSpatializationEnabled: ${isSpatializationEnabled}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

on('spatializationEnabledChange')^(deprecated)

on(type: 'spatializationEnabledChange', callback: Callback<boolean>): void

监听空间音频渲染开关状态变化事件（当空间音频渲染开关状态发生变化时触发），使用callback方式返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用on(type: 'spatializationEnabledChangeForAnyDevice', callback: Callback<AudioSpatialEnabledStateForDevice>): void替代。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'spatializationEnabledChange'。
callback	Callback<boolean>	是	回调函数，返回空间音频渲染开关状态，true为打开，false为关闭。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';

audioSpatializationManager.on('spatializationEnabledChange', (isSpatializationEnabled: boolean) => {
  console.info(`isSpatializationEnabled: ${isSpatializationEnabled}`);
});

on('spatializationEnabledChangeForAnyDevice')¹²⁺

on(type: 'spatializationEnabledChangeForAnyDevice', callback: Callback<AudioSpatialEnabledStateForDevice>): void

监听空间音频渲染开关状态变化事件（当空间音频渲染开关状态发生变化时触发），使用callback方式返回结果。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'spatializationEnabledChangeForAnyDevice'。
callback	Callback<AudioSpatialEnabledStateForDevice>	是	Callback对象，返回设备信息和空间音频渲染开关状态。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';

audioSpatializationManager.on('spatializationEnabledChangeForAnyDevice', (audioSpatialEnabledStateForDevice: audio.AudioSpatialEnabledStateForDevice) => {
  console.info(`deviceDescriptor: ${audioSpatialEnabledStateForDevice.deviceDescriptor}`);
  console.info(`isSpatializationEnabled: ${audioSpatialEnabledStateForDevice.enabled}`);
});

off('spatializationEnabledChange')^(deprecated)

off(type: 'spatializationEnabledChange', callback?: Callback<boolean>): void

取消监听空间音频渲染开关状态变化事件，使用callback方式返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用off(type: 'spatializationEnabledChangeForAnyDevice', callback: Callback<AudioSpatialEnabledStateForDevice>): void替代。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'spatializationEnabledChange'。
callback	Callback<boolean>	否	回调函数，返回空间音频渲染开关状态，true为打开，false为关闭。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

// 取消该事件的所有监听。
audioSpatializationManager.off('spatializationEnabledChange');

// 同一监听事件中，on方法和off方法传入callback参数一致，off方法取消对应on方法订阅的监听。
let spatializationEnabledChangeCallback = (isSpatializationEnabled: boolean) => {
  console.info(`isSpatializationEnabled: ${isSpatializationEnabled}`);
};

audioSpatializationManager.on('spatializationEnabledChange', spatializationEnabledChangeCallback);

audioSpatializationManager.off('spatializationEnabledChange', spatializationEnabledChangeCallback);

off('spatializationEnabledChangeForAnyDevice')¹²⁺

off(type: 'spatializationEnabledChangeForAnyDevice', callback?: Callback<AudioSpatialEnabledStateForDevice>): void

取消监听空间音频渲染开关状态变化事件，使用callback方式返回结果。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'spatializationEnabledChangeForAnyDevice'。
callback	Callback<AudioSpatialEnabledStateForDevice>	是	回调函数，返回设备信息和空间音频渲染开关状态。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';

// 取消该事件的所有监听。
audioSpatializationManager.off('spatializationEnabledChangeForAnyDevice');

// 同一监听事件中，on方法和off方法传入callback参数一致，off方法取消对应on方法订阅的监听。
let spatializationEnabledChangeForAnyDeviceCallback = (audioSpatialEnabledStateForDevice: audio.AudioSpatialEnabledStateForDevice) => {
  console.info(`deviceDescriptor: ${audioSpatialEnabledStateForDevice.deviceDescriptor}`);
  console.info(`isSpatializationEnabled: ${audioSpatialEnabledStateForDevice.enabled}`);
};

audioSpatializationManager.on('spatializationEnabledChangeForAnyDevice', spatializationEnabledChangeForAnyDeviceCallback);

audioSpatializationManager.off('spatializationEnabledChangeForAnyDevice', spatializationEnabledChangeForAnyDeviceCallback);

setHeadTrackingEnabled^(deprecated)

setHeadTrackingEnabled(enable: boolean, callback: AsyncCallback<void>): void

根据输入指令，开启/关闭头动跟踪效果，使用callback方式异步返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用setHeadTrackingEnabled(deviceDescriptor: AudioDeviceDescriptor, enabled: boolean): Promise<void>替代。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
enable	boolean	是	表示开启/关闭头动跟踪。true为开启，false为关闭。
callback	AsyncCallback<void>	是	AsyncCallback对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied. Return by callback.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let enable: boolean = true;

audioSpatializationManager.setHeadTrackingEnabled(enable, (err: BusinessError) => {
  if (err) {
    console.error(`Result ERROR: ${err}`);
  } else {
    console.info(`setHeadTrackingEnabled success`);
  }
});

setHeadTrackingEnabled^(deprecated)

setHeadTrackingEnabled(enable: boolean): Promise<void>

根据输入指令，开启/关闭头动跟踪效果，使用Promise方式异步返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用setHeadTrackingEnabled(deviceDescriptor: AudioDeviceDescriptor, enabled: boolean): Promise<void>替代。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
enable	boolean	是	表示开启/关闭头动跟踪。true为开启，false为关闭。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied. Return by promise.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let enable: boolean = true;

audioSpatializationManager.setHeadTrackingEnabled(enable).then(() => {
  console.info(`setHeadTrackingEnabled success`);
}).catch((err: BusinessError) => {
  console.error(`Result ERROR: ${err}`);
});

setHeadTrackingEnabled¹²⁺

setHeadTrackingEnabled(enable: boolean): Promise<void>

根据输入指令，开启/关闭指定设备的头动跟踪效果，使用Promise方式异步返回结果。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
deviceDescriptor	AudioDeviceDescriptor	是	指定设备的描述。
enable	boolean	是	表示开启/关闭头动跟踪。true为开启，false为关闭。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

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

错误码ID	错误信息
201	Permission denied. Return by promise.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let deviceDescriptor: audio.AudioDeviceDescriptor = {
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.BLUETOOTH_A2DP,
  id : 1,
  name : "",
  address : "123",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : ""
};
let enable: boolean = true;

audioSpatializationManager.setHeadTrackingEnabled(deviceDescriptor, enable).then(() => {
  console.info(`setHeadTrackingEnabled success`);
}).catch((err: BusinessError) => {
  console.error(`Result ERROR: ${err}`);
});

isHeadTrackingEnabled^(deprecated)

isHeadTrackingEnabled(): boolean

获取头动跟踪是否开启，同步返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用isHeadTrackingEnabled(deviceDescriptor: AudioDeviceDescriptor): boolean替代。

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

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

返回值：

类型	说明
boolean	返回头动跟踪是否开启，true为开启，false为未开启。

错误码：

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

错误码ID	错误信息
202	Not system App.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  let isHeadTrackingEnabled: boolean = audioSpatializationManager.isHeadTrackingEnabled();
  console.info(`AudioSpatializationManager isHeadTrackingEnabled: ${isHeadTrackingEnabled}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

isHeadTrackingEnabled¹²⁺

isHeadTrackingEnabled(): boolean

获取指定设备的头动跟踪是否开启，同步返回结果。

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

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

参数：

参数名	类型	必填	说明
deviceDescriptor	AudioDeviceDescriptor	是	指定设备的描述。

返回值：

类型	说明
boolean	返回指定设备的头动跟踪是否开启，true为开启，false为未开启。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let deviceDescriptor: audio.AudioDeviceDescriptor = {
  deviceRole : audio.DeviceRole.OUTPUT_DEVICE,
  deviceType : audio.DeviceType.BLUETOOTH_A2DP,
  id : 1,
  name : "",
  address : "123",
  sampleRates : [44100],
  channelCounts : [2],
  channelMasks : [0],
  networkId : audio.LOCAL_NETWORK_ID,
  interruptGroupId : 1,
  volumeGroupId : 1,
  displayName : ""
};

try {
  let isHeadTrackingEnabled: boolean = audioSpatializationManager.isHeadTrackingEnabled(deviceDescriptor);
  console.info(`AudioSpatializationManager isHeadTrackingEnabled: ${isHeadTrackingEnabled}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

on('headTrackingEnabledChange')^(deprecated)

on(type: 'headTrackingEnabledChange', callback: Callback<boolean>): void

监听头动跟踪开关状态变化事件（当动跟踪开关状态发生变化时触发），使用callback方式返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用on(type: 'headTrackingEnabledChangeForAnyDevice', callback: Callback<AudioSpatialEnabledStateForDevice>): void替代。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'headTrackingEnabledChange'。
callback	Callback<boolean>	是	Callback对象，返回头动跟踪开关状态，true为打开，false为关闭。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';

audioSpatializationManager.on('headTrackingEnabledChange', (isHeadTrackingEnabled: boolean) => {
  console.info(`isHeadTrackingEnabled: ${isHeadTrackingEnabled}`);
});

on('headTrackingEnabledChangeForAnyDevice')¹²⁺

on(type: 'headTrackingEnabledChangeForAnyDevice', callback: Callback<AudioSpatialEnabledStateForDevice>): void

监听头动跟踪开关状态变化事件（当动跟踪开关状态发生变化时触发），使用callback方式返回结果。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'headTrackingEnabledChangeForAnyDevice'。
callback	Callback<AudioSpatialEnabledStateForDevice>	是	Callback对象，返回设备信息和空间音频头动开关状态。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';

audioSpatializationManager.on('headTrackingEnabledChangeForAnyDevice', (audioSpatialEnabledStateForDevice: audio.AudioSpatialEnabledStateForDevice) => {
  console.info(`deviceDescriptor: ${audioSpatialEnabledStateForDevice.deviceDescriptor}`);
  console.info(`isSpatializationEnabled: ${audioSpatialEnabledStateForDevice.enabled}`);
});

off('headTrackingEnabledChange')^(deprecated)

off(type: 'headTrackingEnabledChange', callback?: Callback<boolean>): void

取消监听头动跟踪开关状态变化事件，使用callback方式返回结果。

说明： 从 API version 11 开始支持，从 API version 12 开始废弃，建议使用off(type: 'headTrackingEnabledChangeForAnyDevice', callback: Callback<AudioSpatialEnabledStateForDevice>): void替代。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'headTrackingEnabledChange'。
callback	Callback<boolean>	否	回调函数，返回头动跟踪开关状态，true为打开，false为关闭。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';

// 取消该事件的所有监听。
audioSpatializationManager.off('headTrackingEnabledChange');

// 同一监听事件中，on方法和off方法传入callback参数一致，off方法取消对应on方法订阅的监听。
let headTrackingEnabledChangeCallback = (isHeadTrackingEnabled: boolean) => {
  console.info(`isHeadTrackingEnabled: ${isHeadTrackingEnabled}`);
};

audioSpatializationManager.on('headTrackingEnabledChange', headTrackingEnabledChangeCallback);

audioSpatializationManager.off('headTrackingEnabledChange', headTrackingEnabledChangeCallback);

off('headTrackingEnabledChangeForAnyDevice')¹²⁺

off(type: 'headTrackingEnabledChangeForAnyDevice', callback?: Callback<AudioSpatialEnabledStateForDevice>): void

取消监听头动跟踪开关状态变化事件，使用callback方式返回结果。

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

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

参数：

参数名	类型	必填	说明
type	string	是	监听事件，固定为：'headTrackingEnabledChangeForAnyDevice'。
callback	Callback<AudioSpatialEnabledStateForDevice>	是	回调函数，返回设备信息和空间音频头动开关状态。

错误码：

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

错误码ID	错误信息
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';

// 取消该事件的所有监听。
audioSpatializationManager.off('headTrackingEnabledChangeForAnyDevice');

// 同一监听事件中，on方法和off方法传入callback参数一致，off方法取消对应on方法订阅的监听。
let headTrackingEnabledChangeForAnyDeviceCallback = (audioSpatialEnabledStateForDevice: audio.AudioSpatialEnabledStateForDevice) => {
  console.info(`deviceDescriptor: ${audioSpatialEnabledStateForDevice.deviceDescriptor}`);
  console.info(`isSpatializationEnabled: ${audioSpatialEnabledStateForDevice.enabled}`);
};

audioSpatializationManager.on('headTrackingEnabledChangeForAnyDevice', headTrackingEnabledChangeForAnyDeviceCallback);

audioSpatializationManager.off('headTrackingEnabledChangeForAnyDevice', headTrackingEnabledChangeForAnyDeviceCallback);

updateSpatialDeviceState¹¹⁺

updateSpatialDeviceState(spatialDeviceState: AudioSpatialDeviceState): void

更新空间化设备状态，同步返回结果。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
spatialDeviceState	AudioSpatialDeviceState	是	需要更新的空间化设备状态。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

let spatialDeviceState: audio.AudioSpatialDeviceState = {
  address: "123",
  isSpatializationSupported: true,
  isHeadTrackingSupported: true,
  spatialDeviceType: audio.AudioSpatialDeviceType.SPATIAL_DEVICE_TYPE_IN_EAR_HEADPHONE
};

try {
  audioSpatializationManager.updateSpatialDeviceState(spatialDeviceState);
  console.info(`AudioSpatializationManager updateSpatialDeviceState success`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

setSpatializationSceneType¹²⁺

setSpatializationSceneType(spatializationSceneType: AudioSpatializationSceneType): void

设置空间音频渲染场景类型，同步返回结果。

需要权限： ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS

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

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

参数：

参数名	类型	必填	说明
spatializationSceneType	AudioSpatializationSceneType	是	需要设置的空间音频渲染场景类型。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Not system App.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  audioSpatializationManager.setSpatializationSceneType(audio.AudioSpatializationSceneType.DEFAULT);
  console.info(`AudioSpatializationManager setSpatializationSceneType success`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

getSpatializationSceneType¹²⁺

getSpatializationSceneType(): AudioSpatializationSceneType

查询当前空间音频渲染场景类型，同步返回结果。

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

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

返回值：

类型	说明
AudioSpatializationSceneType	返回当前空间音频渲染场景类型。

错误码：

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

错误码ID	错误信息
202	Not system App.

示例：

import { audio } from '@kit.AudioKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  let spatializationSceneType: audio.AudioSpatializationSceneType = audioSpatializationManager.getSpatializationSceneType();
  console.info(`AudioSpatializationManager spatializationSceneType: ${spatializationSceneType}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`ERROR: ${error}`);
}

AudioSpatialDeviceState¹¹⁺

空间化设备状态。

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

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

名称	类型	可读	可写	说明
address11+	string	是	是	空间化设备地址。
isSpatializationSupported11+	boolean	是	是	空间化设备是否支持空间音频渲染。
isHeadTrackingSupported11+	boolean	是	是	空间化设备是否支持头动跟踪。
spatialDeviceType11+	AudioSpatialDeviceType	是	是	空间化设备类型。

示例：

import { audio } from '@kit.AudioKit';

let spatialDeviceState: audio.AudioSpatialDeviceState = {
  address: "123",
  isSpatializationSupported: true,
  isHeadTrackingSupported: true,
  spatialDeviceType: audio.AudioSpatialDeviceType.SPATIAL_DEVICE_TYPE_IN_EAR_HEADPHONE
};

AudioSpatialDeviceType¹¹⁺

枚举，空间化设备类型。

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

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

名称	值	说明
SPATIAL_DEVICE_TYPE_NONE	0	无空间化设备类型。
SPATIAL_DEVICE_TYPE_IN_EAR_HEADPHONE	1	入耳式耳机。
SPATIAL_DEVICE_TYPE_HALF_IN_EAR_HEADPHONE	2	半入耳式耳机。
SPATIAL_DEVICE_TYPE_OVER_EAR_HEADPHONE	3	头戴式耳机。
SPATIAL_DEVICE_TYPE_GLASSES	4	眼镜式耳机。
SPATIAL_DEVICE_TYPE_OTHERS	5	其他空间化设备类型。

AudioSpatializationSceneType¹²⁺

枚举，空间音频渲染场景类型。

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

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

名称	值	说明
DEFAULT	0	空间音频默认渲染场景。
MUSIC	1	空间音频音乐渲染场景。
MOVIE	2	空间音频电影渲染场景。
AUDIOBOOK	3	空间音频有声读物渲染场景。

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_SUPERVISORY_CALL_HOLDING18+	108	呼叫保持音调。
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，双音多频）音调的方法，包括各种系统监听音调、专有音调，如拨号音、通话回铃音等。 在调用TonePlayer的接口前，需要先通过createTonePlayer创建实例。

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

load⁹⁺

load(type: ToneType, callback: AsyncCallback<void>): void

加载DTMF音调配置。使用callback方式异步返回结果。

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

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

参数：

参数名	类型	必填	说明
type	ToneType	是	配置的音调类型。
callback	AsyncCallback<void>	是	回调函数。当加载DTMF音调配置成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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<void>	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<void>	是	回调函数。当启动DTMF音调播放成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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<void>	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<void>	是	回调函数。当停止当前正在播放的音调成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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<void>	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<void>	是	回调函数。当释放与此TonePlayer对象关联的资源成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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<void>	Promise对象，无返回结果。

示例：

tonePlayer.release().then(() => {
  console.info('promise call release');
}).catch(() => {
  console.error('promise call release fail');
});

AsrProcessingController¹²⁺

ASR处理控制器

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

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

setAsrAecMode¹²⁺

setAsrAecMode(mode: AsrAecMode): boolean;

设置ASR AEC模式，同步返回结果。

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

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

参数：

参数名	类型	必填	说明
mode	AsrAecMode	是	ASR AEC 模式。

返回值：

类型	说明
boolean	返回设置ASR AEC模式结果，true为设置成功，false为设置失败。

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.
6800104	Operation not allowed.

示例：

let flag = asrProcessingController.setAsrAecMode(audio.AsrAecMode.BYPASS);

getAsrAecMode¹²⁺

getAsrAecMode(): AsrAecMode;

获取ASR AEC模式，同步返回结果。

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

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

返回值：

类型	说明
AsrAecMode	ASR AEC 模式

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
6800104	Operation not allowed.

示例：

let mode = asrProcessingController.getAsrAecMode();

setAsrNoiseSuppressionMode¹²⁺

setAsrNoiseSuppressionMode(mode: AsrNoiseSuppressionMode): boolean;

设置ASR 噪音抑制模式，同步返回结果。

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

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

参数：

参数名	类型	必填	说明
mode	AsrNoiseSuppressionMode	是	ASR 噪音抑制模式。

返回值：

类型	说明
boolean	返回设置ASR 噪音抑制模式结果，true为设置成功，false为设置失败。

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.
6800104	Operation not allowed.

示例：

let flag = asrProcessingController.setAsrNoiseSuppressionMode(audio.AsrNoiseSuppressionMode.BYPASS);

getAsrNoiseSuppressionMode¹²⁺

getAsrNoiseSuppressionMode(): AsrNoiseSuppressionMode;

获取ASR 噪音抑制模式，同步返回结果。

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

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

返回值：

类型	说明
AsrNoiseSuppressionMode	ASR 噪音抑制模式

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
6800104	Operation not allowed.

示例：

let mode = asrProcessingController.getAsrNoiseSuppressionMode();

isWhispering¹²⁺

isWhispering(): boolean;

查询耳语状态。

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

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

返回值：

类型	说明
boolean	返回耳语状态，true为开启，false为关闭。

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
6800104	Operation not allowed.

示例：

let flag = asrProcessingController.isWhispering();

setAsrWhisperDetectionMode¹²⁺

setAsrWhisperDetectionMode(mode: AsrWhisperDetectionMode): boolean

设置耳语检测模式。

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

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

参数：

参数名	类型	必填	说明
mode	AsrWhisperDetectionMode	是	耳语检测模式。

返回值：

类型	说明
boolean	返回设置耳语检测模式结果，true为设置成功，false为设置失败。

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
401	Parameter error. Possible causes: 1.Mandatory parameters unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.
6800104	Operation not allowed.

示例：

let flag = asrProcessingController.setAsrWhisperDetectionMode(audio.AsrWhisperDetectionMode.BYPASS);

getAsrWhisperDetectionMode¹²⁺

getAsrWhisperDetectionMode(): AsrWhisperDetectionMode

获取耳语检测模式，同步返回结果。

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

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

返回值：

类型	说明
AsrWhisperDetectionMode	耳语检测模式

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
6800104	Operation not allowed.

示例：

let mode = asrProcessingController.getAsrWhisperDetectionMode();

setAsrVoiceControlMode¹²⁺

setAsrVoiceControlMode(mode: AsrVoiceControlMode, enable: boolean): boolean

设置在系统通话中上报modem及通话录音的上行通路的ASR音频通路选择。

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

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

参数：

参数名	类型	必填	说明
mode	AsrVoiceControlMode	是	音频通路模式。
enable	boolean	是	开关状态

返回值：

类型	说明
boolean	返回设置在系统通话中上报modem及通话录音的上行通路的ASR音频通路选择的结果，true为设置成功，false为设置失败。

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
401	Parameter error. Possible causes: 1.Mandatory parameters unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.
6800104	Operation not allowed.

示例：

let flag = asrProcessingController.setAsrVoiceControlMode(audio.AsrVoiceControlMode.AUDIO_2_VOICE_TX, true);

setAsrVoiceMuteMode¹²⁺

setAsrVoiceMuteMode(mode: AsrVoiceMuteMode, enable: boolean): boolean

在系统通话中，对ASR音频通路进行静音控制。

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

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

参数：

参数名	类型	必填	说明
mode	AsrVoiceMuteMode	是	静音控制模式。
enable	boolean	是	开关状态。

返回值：

类型	说明
boolean	返回在系统通话中，对ASR音频通路进行静音控制的结果，true为设置成功，false为设置失败。

错误码：

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

错误码ID	错误信息
202	Caller is not a system application.
401	Parameter error. Possible causes: 1.Mandatory parameters unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.
6800104	Operation not allowed.

示例：

let flag = asrProcessingController.setAsrVoiceMuteMode(audio.AsrVoiceMuteMode.OUTPUT_MUTE, true);