Interface (AudioStreamManager)

This interface implements audio stream management.

Before calling any API in AudioStreamManager, you must use getStreamManager to obtain an AudioStreamManager instance.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The initial APIs of this interface are supported since API version 9.

Modules to Import

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

getCurrentAudioRendererInfoArray⁹⁺

getCurrentAudioRendererInfoArray(callback: AsyncCallback<AudioRendererChangeInfoArray>): void

Obtains the information about this audio renderer. This API uses an asynchronous callback to return the result.

NOTE

The audio renderer information returned by this API may include internal audio playback streams, such as cellular calls and ultrasonic streams.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<AudioRendererChangeInfoArray>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is the audio renderer information obtained; otherwise, err is an error object.

Example

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

audioStreamManager.getCurrentAudioRendererInfoArray((err: BusinessError, audioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray) => {
  if (err) {
    console.error(`Failed to get current audio renderer info array. Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`Succeeded in getting current audio renderer info array, AudioRendererChangeInfoArray: ${JSON.stringify(audioRendererChangeInfoArray)}.`);
  }
});

getCurrentAudioRendererInfoArray⁹⁺

getCurrentAudioRendererInfoArray(): Promise<AudioRendererChangeInfoArray>

Obtains the information about this audio renderer. This API uses a promise to return the result.

NOTE

The audio renderer information returned by this API may include internal audio playback streams, such as cellular calls and ultrasonic streams.

System capability: SystemCapability.Multimedia.Audio.Renderer

Return value

Type	Description
Promise<AudioRendererChangeInfoArray>	Promise used to return the audio renderer information.

Example

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

audioStreamManager.getCurrentAudioRendererInfoArray().then((audioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray) => {
  console.info(`Succeeded in getting current audio renderer info array, AudioRendererChangeInfoArray: ${JSON.stringify(audioRendererChangeInfoArray)}.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get current audio renderer info array. Code: ${err.code}, message: ${err.message}`);
});

getCurrentAudioRendererInfoArraySync¹⁰⁺

getCurrentAudioRendererInfoArraySync(): AudioRendererChangeInfoArray

Obtains the information about this audio renderer. This API returns the result synchronously.

NOTE

The audio renderer information returned by this API may include internal audio playback streams, such as cellular calls and ultrasonic streams.

System capability: SystemCapability.Multimedia.Audio.Renderer

Return value

Type	Description
AudioRendererChangeInfoArray	Audio renderer information.

Example

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

try {
  let audioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray = audioStreamManager.getCurrentAudioRendererInfoArraySync();
  console.info(`Succeeded in getting current audio renderer info array, AudioRendererChangeInfoArray: ${JSON.stringify(audioRendererChangeInfoArray)}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to get current audio renderer info array. Code: ${error.code}, message: ${error.message}`);
}

getCurrentAudioCapturerInfoArray⁹⁺

getCurrentAudioCapturerInfoArray(callback: AsyncCallback<AudioCapturerChangeInfoArray>): void

Obtains the information about this audio capturer. This API uses an asynchronous callback to return the result.

NOTE

The audio capturer information returned by this API may include internal audio recording streams, such as voice wakeup and cellular calls.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<AudioCapturerChangeInfoArray>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is the audio capturer information obtained; otherwise, err is an error object.

Example

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

audioStreamManager.getCurrentAudioCapturerInfoArray((err: BusinessError, audioCapturerChangeInfoArray: audio.AudioCapturerChangeInfoArray) => {
  if (err) {
    console.error(`Failed to get current audio capturer info array. Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`Succeeded in getting current audio capturer info array, AudioCapturerChangeInfoArray: ${JSON.stringify(audioCapturerChangeInfoArray)}.`);
  }
});

getCurrentAudioCapturerInfoArray⁹⁺

getCurrentAudioCapturerInfoArray(): Promise<AudioCapturerChangeInfoArray>

Obtains the information about this audio capturer. This API uses a promise to return the result.

NOTE

The audio capturer information returned by this API may include internal audio recording streams, such as voice wakeup and cellular calls.

System capability: SystemCapability.Multimedia.Audio.Renderer

Return value

Type	Description
Promise<AudioCapturerChangeInfoArray>	Promise used to return the audio capturer information.

Example

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

audioStreamManager.getCurrentAudioCapturerInfoArray().then((audioCapturerChangeInfoArray: audio.AudioCapturerChangeInfoArray) => {
  console.info(`Succeeded in getting current audio capturer info array, AudioCapturerChangeInfoArray: ${JSON.stringify(audioCapturerChangeInfoArray)}.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get current audio capturer info array. Code: ${err.code}, message: ${err.message}`);
});

getCurrentAudioCapturerInfoArraySync¹⁰⁺

getCurrentAudioCapturerInfoArraySync(): AudioCapturerChangeInfoArray

Obtains the information about this audio capturer. This API returns the result synchronously.

NOTE

The audio capturer information returned by this API may include internal audio recording streams, such as voice wakeup and cellular calls.

System capability: SystemCapability.Multimedia.Audio.Capturer

Return value

Type	Description
AudioCapturerChangeInfoArray	Audio capturer information.

Example

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

try {
  let audioCapturerChangeInfoArray = audioStreamManager.getCurrentAudioCapturerInfoArraySync();
  console.info(`Succeeded in getting current audio capturer info array, AudioCapturerChangeInfoArray: ${JSON.stringify(audioCapturerChangeInfoArray)}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to get current audio capturer info array. Code: ${error.code}, message: ${error.message}`);
}

on('audioRendererChange')⁹⁺

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

Subscribes to the audio renderer change event, which is triggered when the audio playback stream status or device is changed. This API uses an asynchronous callback to return the result.

NOTE

The audio renderer information returned by this API may include internal audio playback streams, such as cellular calls and ultrasonic streams.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'audioRendererChange' is triggered when the audio playback stream status or device is changed.
callback	Callback<AudioRendererChangeInfoArray>	Yes	Callback used to return the audio renderer information.

Error codes

For details about the error codes, see Universal Error Codes and Audio Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

Example

audioStreamManager.on('audioRendererChange',  (audioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray) => {
  console.info(`Succeeded in using on function, AudioRendererChangeInfoArray: ${JSON.stringify(audioRendererChangeInfoArray)}.`);
});

off('audioRendererChange')⁹⁺

off(type: 'audioRendererChange', callback?: Callback<AudioRendererChangeInfoArray>): void

Unsubscribes from the audio renderer change event. This API uses an asynchronous callback to return the result.

NOTE

The audio renderer information returned by this API may include internal audio playback streams, such as cellular calls and ultrasonic streams.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'audioRendererChange' is triggered when the audio playback stream status or device is changed.
callback¹⁸⁺	Callback<AudioRendererChangeInfoArray>	No	Callback used to return the audio renderer information.

Error codes

For details about the error codes, see Audio Error Codes.

ID	Error Message
6800101	Parameter verification failed.

Example

// For the same event, if the callback parameter passed to the off API is the same as that passed to the on API, the off API cancels the subscription registered with the specified callback parameter.
// When there are multiple listeners for this event, you can use audioStreamManager.off('audioRendererChange'); to unregister all of them.
let audioRendererChangeCallback = (audioRendererChangeInfoArray: audio.AudioRendererChangeInfoArray) => {
  console.info(`Succeeded in using on or off function, AudioRendererChangeInfoArray: ${JSON.stringify(audioRendererChangeInfoArray)}.`);
};

audioStreamManager.on('audioRendererChange', audioRendererChangeCallback);

audioStreamManager.off('audioRendererChange', audioRendererChangeCallback);

on('audioCapturerChange')⁹⁺

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

Subscribes to the audio capturer change event, which is triggered when the audio recording stream status or device is changed. This API uses an asynchronous callback to return the result.

NOTE

The audio capturer information returned by this API may include internal audio recording streams, such as voice wakeup and cellular calls.

System capability: SystemCapability.Multimedia.Audio.Capturer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'audioCapturerChange' is triggered when the audio recording stream status or device is changed.
callback	Callback<AudioCapturerChangeInfoArray>	Yes	Callback used to return the audio capturer information.

Error codes

For details about the error codes, see Universal Error Codes and Audio Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

Example

audioStreamManager.on('audioCapturerChange', (audioCapturerChangeInfoArray: audio.AudioCapturerChangeInfoArray) =>  {
  console.info(`Succeeded in using on function, AudioCapturerChangeInfoArray: ${JSON.stringify(audioCapturerChangeInfoArray)}.`);
});

off('audioCapturerChange')⁹⁺

off(type: 'audioCapturerChange', callback?: Callback<AudioCapturerChangeInfoArray>): void

Unsubscribes from the audio capturer change event. This API uses an asynchronous callback to return the result.

NOTE

The audio capturer information returned by this API may include internal audio recording streams, such as voice wakeup and cellular calls.

System capability: SystemCapability.Multimedia.Audio.Capturer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'audioCapturerChange' is triggered when the audio capturer is changed.
callback¹⁸⁺	Callback<AudioCapturerChangeInfoArray>	No	Callback used to return the audio capturer information.

Error codes

For details about the error codes, see Audio Error Codes.

ID	Error Message
6800101	Parameter verification failed.

Example

// For the same event, if the callback parameter passed to the off API is the same as that passed to the on API, the off API cancels the subscription registered with the specified callback parameter.
// When there are multiple listeners for this event, you can use audioStreamManager.off('audioCapturerChange'); to unregister all of them.
let audioCapturerChangeCallback = (audioCapturerChangeInfoArray: audio.AudioCapturerChangeInfoArray) =>  {
  console.info(`Succeeded in using on or off function, AudioCapturerChangeInfoArray: ${JSON.stringify(audioCapturerChangeInfoArray)}.`);
};

audioStreamManager.on('audioCapturerChange', audioCapturerChangeCallback);

audioStreamManager.off('audioCapturerChange', audioCapturerChangeCallback);

isActive^(deprecated)

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

Checks whether a stream is active. This API uses an asynchronous callback to return the result.

NOTE This API is supported since API version 9 and deprecated since API version 20. You are advised to use isStreamActive instead.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
volumeType	AudioVolumeType	Yes	Audio stream types.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is true if the stream is active or false if not active; otherwise, err is an error object.

Example

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

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^(deprecated)

isActive(volumeType: AudioVolumeType): Promise<boolean>

Checks whether a stream is active. This API uses a promise to return the result.

NOTE This API is supported since API version 9 and deprecated since API version 20. You are advised to use isStreamActive instead.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
volumeType	AudioVolumeType	Yes	Audio stream types.

Return value

Type	Description
Promise<boolean>	Promise used to return the result, indicating whether the stream is active. true if active, false otherwise.

Example

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^(deprecated)

isActiveSync(volumeType: AudioVolumeType): boolean

Checks whether a stream is active. This API returns the result synchronously.

NOTE This API is supported since API version 10 and deprecated since API version 20. You are advised to use isStreamActive instead.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
volumeType	AudioVolumeType	Yes	Audio stream types.

Return value

Type	Description
boolean	Check result for whether the stream is active. true if active, false otherwise.

Error codes

For details about the error codes, see Universal Error Codes and Audio Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

Example

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

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

isStreamActive²⁰⁺

isStreamActive(streamUsage: StreamUsage): boolean

Checks whether a stream is active. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
streamUsage	StreamUsage	Yes	Audio stream usage.

Return value

Type	Description
boolean	Check result for whether the stream is active. true if active, false otherwise.

Error codes

For details about the error codes, see Audio Error Codes.

ID	Error Message
6800101	Parameter verification failed.

Example

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

try {
  let isStreamActive = audioStreamManager.isStreamActive(audio.StreamUsage.STREAM_USAGE_MUSIC);
  console.info(`Succeeded in using isStreamActive function, IsStreamActive: ${isStreamActive}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to use isStreamActive function. code: ${error.code}, message: ${error.message}`);
}

getAudioEffectInfoArray¹⁰⁺

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

Obtains information about the audio effect mode in use. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
usage	StreamUsage	Yes	Audio stream usage.
callback	AsyncCallback<AudioEffectInfoArray>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is the information about the audio effect mode obtained; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Audio Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed. Return by callback.

Example

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

audioStreamManager.getAudioEffectInfoArray(audio.StreamUsage.STREAM_USAGE_MUSIC, (err: BusinessError, audioEffectInfoArray: audio.AudioEffectInfoArray) => {
  if (err) {
    console.error(`Failed to get audio effect info array. Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`Succeeded in getting effect info array, AudioEffectInfoArray: ${JSON.stringify(audioEffectInfoArray)}.`);
  }
});

getAudioEffectInfoArray¹⁰⁺

getAudioEffectInfoArray(usage: StreamUsage): Promise<AudioEffectInfoArray>

Obtains information about the audio effect mode in use. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
usage	StreamUsage	Yes	Audio stream usage.

Return value

Type	Description
Promise<AudioEffectInfoArray>	Promise used to return the information about the audio effect mode obtained.

Error codes

For details about the error codes, see Universal Error Codes and Audio Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed. Return by promise.

Example

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

audioStreamManager.getAudioEffectInfoArray(audio.StreamUsage.STREAM_USAGE_MUSIC).then((audioEffectInfoArray: audio.AudioEffectInfoArray) => {
  console.info(`Succeeded in getting effect info array, AudioEffectInfoArray: ${JSON.stringify(audioEffectInfoArray)}.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get audio effect info array. Code: ${err.code}, message: ${err.message}`);
});

getAudioEffectInfoArraySync¹⁰⁺

getAudioEffectInfoArraySync(usage: StreamUsage): AudioEffectInfoArray

Obtains information about the audio effect mode in use. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Audio.Renderer

Parameters

Name	Type	Mandatory	Description
usage	StreamUsage	Yes	Audio stream usage.

Return value

Type	Description
AudioEffectInfoArray	Information about the audio effect mode.

Error codes

For details about the error codes, see Universal Error Codes and Audio Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
6800101	Parameter verification failed.

Example

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

try {
  let audioEffectInfoArray = audioStreamManager.getAudioEffectInfoArraySync(audio.StreamUsage.STREAM_USAGE_MUSIC);
  console.info(`Succeeded in getting effect info array, AudioEffectInfoArray: ${JSON.stringify(audioEffectInfoArray)}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to get audio effect info array. Code: ${error.code}, message: ${error.message}`);
}

isAcousticEchoCancelerSupported²⁰⁺

isAcousticEchoCancelerSupported(sourceType: SourceType): boolean

Checks whether the specified audio source type supports echo cancellation.

System capability: SystemCapability.Multimedia.Audio.Capturer

Parameters

Name	Type	Mandatory	Description
sourceType	SourceType	Yes	Audio source type.

Return value

Type	Description
boolean	Check result for whether echo cancellation is supported. true if supported, false otherwise.

Error codes

For details about the error codes, see Audio Error Codes.

ID	Error Message
6800101	Parameter verification failed.

Example

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

try {
  let isAcousticEchoCancelerSupported = audioStreamManager.isAcousticEchoCancelerSupported(audio.SourceType.SOURCE_TYPE_LIVE);
  console.info(`Succeeded in using isAcousticEchoCancelerSupported function, IsAcousticEchoCancelerSupported: ${isAcousticEchoCancelerSupported}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to use isAcousticEchoCancelerSupported function. code: ${error.code}, message: ${error.message}`);
}

isAudioLoopbackSupported²⁰⁺

isAudioLoopbackSupported(mode: AudioLoopbackMode): boolean

Checks whether the current system supports the specified audio loopback mode.

System capability: SystemCapability.Multimedia.Audio.Capturer

Parameters

Name	Type	Mandatory	Description
mode	AudioLoopbackMode	Yes	Audio loopback mode.

Return value

Type	Description
boolean	Check result for whether the audio loopback mode is supported. true if supported, false otherwise.

Error codes

For details about the error codes, see Audio Error Codes.

ID	Error Message
6800101	Parameter verification failed.

Example

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

try {
  let isAudioLoopbackSupported = audioStreamManager.isAudioLoopbackSupported(audio.AudioLoopbackMode.HARDWARE);
  console.info(`Succeeded in using isAudioLoopbackSupported function, IsAudioLoopbackSupported: ${isAudioLoopbackSupported}.`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to use isAudioLoopbackSupported function. code: ${error.code}, message: ${error.message}`);
}

isRecordingAvailable²⁰⁺

isRecordingAvailable(capturerInfo: AudioCapturerInfo): boolean

Checks whether recording can be started based on the audio source type in the audio capturer information.

System capability: SystemCapability.Multimedia.Audio.Capturer

Parameters

Name	Type	Mandatory	Description
capturerInfo	AudioCapturerInfo	Yes	Audio capturer information.

Return value

Type	Description
boolean	Check result for whether recording can be started. true if recording can be started, false otherwise. This API checks whether the specified audio source type in the capturer information can acquire focus. It should be called before starting audio recording to avoid conflicts with existing recording streams.

Error codes

For details about the error codes, see Audio Error Codes.

ID	Error Message
6800101	Parameter verification failed.

Example

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

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: BusinessError, audioCapturer: audio.AudioCapturer) => {
  if (err) {
    console.error(`Failed to create AudioCapturer. Code: ${err.code}, message: ${err.message}`);
  } else {
    console.info('Succeeded in creating AudioCapturer.');
    try {
      let isRecordingAvailable = audioStreamManager.isRecordingAvailable(audioCapturerInfo);
      console.info(`Succeeded in using isRecordingAvailable function, IsRecordingAvailable: ${isRecordingAvailable}.`);
    } catch (err) {
      let error = err as BusinessError;
      console.error(`Failed to use isRecordingAvailable function. code: ${error.code}, message: ${error.message}`);
    }
  }
});

isIntelligentNoiseReductionEnabledForCurrentDevice²¹⁺

isIntelligentNoiseReductionEnabledForCurrentDevice(sourceType: SourceType): boolean

Checks whether the intelligent noise reduction feature is enabled for the audio stream of the specified source type.

System capability: SystemCapability.Multimedia.Audio.Core

Parameters

Name	Type	Mandatory	Description
sourceType	SourceType	Yes	Audio source type.

Return value

Type	Description
boolean	Check result for whether the intelligent noise reduction feature is enabled. true if enabled, false otherwise.

Error codes

For details about the error codes, see Audio Error Codes.

ID	Error Message
6800101	Parameter verification failed.

Example

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

try {
  let isSupport = audioStreamManager.isIntelligentNoiseReductionEnabledForCurrentDevice(audio.SourceType.SOURCE_TYPE_LIVE);
  console.info(`SourceType: ${audio.SourceType.SOURCE_TYPE_LIVE} intelligent noise reduction enabled is: ${isSupport}`);
} catch (err) {
  let error = err as BusinessError;
  console.error(`isIntelligentNoiseReductionEnabledForCurrentDevice ERROR: ${error}`);
}

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 capi-native-audiostreambuilder-h

openharmony 鸿蒙 capi-ohaudiosuite

openharmony 鸿蒙 js-apis-inner-multimedia-systemSoundPlayer

openharmony 鸿蒙 arkts-apis-audio-i

openharmony 鸿蒙 capi-ohaudio

openharmony 鸿蒙 capi-ohmidi

openharmony 鸿蒙 arkts-apis-audio-AudioManager

openharmony 鸿蒙 capi-ohaudiosuite-oh-audiosuite-spacerenderpositionparams

openharmony 鸿蒙 capi-ohaudio-oh-audiostreaminfo

openharmony 鸿蒙 errorcode-ringtone

openharmony 鸿蒙 arkts-apis-audio-AudioStreamManager

Interface (AudioStreamManager)

Modules to Import

getCurrentAudioRendererInfoArray⁹⁺

getCurrentAudioRendererInfoArray⁹⁺

getCurrentAudioRendererInfoArraySync¹⁰⁺

getCurrentAudioCapturerInfoArray⁹⁺

getCurrentAudioCapturerInfoArray⁹⁺

getCurrentAudioCapturerInfoArraySync¹⁰⁺

on('audioRendererChange')⁹⁺

off('audioRendererChange')⁹⁺

on('audioCapturerChange')⁹⁺

off('audioCapturerChange')⁹⁺

isActive^(deprecated)

isActive^(deprecated)

isActiveSync^(deprecated)

isStreamActive²⁰⁺

getAudioEffectInfoArray¹⁰⁺

getAudioEffectInfoArray¹⁰⁺

getAudioEffectInfoArraySync¹⁰⁺

isAcousticEchoCancelerSupported²⁰⁺

isAudioLoopbackSupported²⁰⁺

isRecordingAvailable²⁰⁺

isIntelligentNoiseReductionEnabledForCurrentDevice²¹⁺

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

Interface (AudioStreamManager)

Modules to Import

getCurrentAudioRendererInfoArray9+

getCurrentAudioRendererInfoArray9+

getCurrentAudioRendererInfoArraySync10+

getCurrentAudioCapturerInfoArray9+

getCurrentAudioCapturerInfoArray9+

getCurrentAudioCapturerInfoArraySync10+

on('audioRendererChange')9+

off('audioRendererChange')9+

on('audioCapturerChange')9+

off('audioCapturerChange')9+

isActive(deprecated)

isActive(deprecated)

isActiveSync(deprecated)

isStreamActive20+

getAudioEffectInfoArray10+

getAudioEffectInfoArray10+

getAudioEffectInfoArraySync10+

isAcousticEchoCancelerSupported20+

isAudioLoopbackSupported20+

isRecordingAvailable20+

isIntelligentNoiseReductionEnabledForCurrentDevice21+

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

getCurrentAudioRendererInfoArray⁹⁺

getCurrentAudioRendererInfoArray⁹⁺

getCurrentAudioRendererInfoArraySync¹⁰⁺

getCurrentAudioCapturerInfoArray⁹⁺

getCurrentAudioCapturerInfoArray⁹⁺

getCurrentAudioCapturerInfoArraySync¹⁰⁺

on('audioRendererChange')⁹⁺

off('audioRendererChange')⁹⁺

on('audioCapturerChange')⁹⁺

off('audioCapturerChange')⁹⁺

isActive^(deprecated)

isActive^(deprecated)

isActiveSync^(deprecated)

isStreamActive²⁰⁺

getAudioEffectInfoArray¹⁰⁺

getAudioEffectInfoArray¹⁰⁺

getAudioEffectInfoArraySync¹⁰⁺

isAcousticEchoCancelerSupported²⁰⁺

isAudioLoopbackSupported²⁰⁺

isRecordingAvailable²⁰⁺

isIntelligentNoiseReductionEnabledForCurrentDevice²¹⁺