AI Noise Suppression

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

Call setAINSMode to enable AI Noise Suppression and select a noise suppression mode:

// Noise reduction modes:
// 0: Balanced mode
// 1: Aggressive mode
// 2: Aggressive mode with low latency
int mode = 1;
int result = rtcEngine.setAINSMode(true, mode);

// Noise reduction modes:
// 0: Balanced mode
// 1: Aggressive mode
// 2: Aggressive mode with low latency
val mode = 1
val result = rtcEngine.setAINSMode(true, mode)

Reference

API reference

• setAINSMode

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

Call setAINSMode to enable AI Noise Suppression and select a noise suppression mode:

// Set AINS mode to AINS_MODE_BALANCED (0)
// Set AINS mode to AINS_MODE_AGGRESSIVE (1)
// Set AINS mode to AINS_MODE_ULTRALOWLATENCY (2)
let result = agoraKit.setAINSMode(true, mode: 2)

When AI Noise Suppression is enabled, if Video SDK detects that device performance is insufficient, it:

• Disables AI Noise Suppression.
• Enables traditional noise reduction.
• Throws the WARN_APM_AINS_CLOSED (-1054) error code.

Reference

Minimum device requirements

• iPhone 6S
• iPad Pro (2nd generation)
• iPad mini (5th generation)
• iPad Air (3rd generation)
• MacBook Pro 2015

API reference

• setAINSMode

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

Call setAINSMode to enable AI Noise Suppression and select a noise suppression mode:

// Set AINS mode to AINS_MODE_BALANCED (0)
// Set AINS mode to AINS_MODE_AGGRESSIVE (1)
// Set AINS mode to AINS_MODE_ULTRALOWLATENCY (2)
let result = agoraKit.setAINSMode(true, mode: 2)

Reference

API reference

• setAINSMode

Try the AI Noise Suppression online demo.

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

1. Install the AI Noise Suppression extension.

   The AI Noise Suppression extension (agora-extension-ai-denoiser) requires Web SDK v4.15.1 or later. In the root of your project, run the following command to install the extension. By default, this installs the latest version (v2.0.2):

   npm install agora-extension-ai-denoiser

   To install a specific extension version, use one of the following commands:

   • v2.0.2 — Adds background voice removal, which further isolates the target voice in noisy or multi-speaker scenarios.

     npm install agora-extension-ai-denoiser@2.0.2

   • v2.0.1 — Supports low-latency mode and log-level configuration. If you need background voice removal, use v2.0.2.

     npm install agora-extension-ai-denoiser@2.0.1

2. Import AI Noise Suppression in your JavaScript or TypeScript file.

   import { AIDenoiserExtension } from 'agora-extension-ai-denoiser';

3. Dynamically load the Wasm dependencies.

   Publish the files in node_modules/agora-extension-ai-denoiser/external to your CDN or static resource server, and pass the public path URL when creating an AIDenoiserExtension instance.

   If the Wasm files are not hosted on the same origin as the web application, enable CORS.

   Do not serve the Wasm files over HTTP when your page runs over HTTPS.

4. Register the AI Noise Suppression extension.

   const denoiser = new AIDenoiserExtension({ assetsPath: './external' });
   
   if (!denoiser.checkCompatibility()) {
     console.error('This browser does not support AI Denoiser.');
   }
   
   AgoraRTC.registerExtensions([denoiser]);
   
   denoiser.onloaderror = (error) => {
     console.log(error);
   };

5. Create an IAIDenoiserProcessor instance.

   const processor = denoiser.createProcessor();
   processor.enable();

6. Inject the extension into the audio processing pipeline.

   const audioTrack = await AgoraRTC.createMicrophoneAudioTrack();
   audioTrack.pipe(processor).pipe(audioTrack.processorDestination);
   await processor.enable();

7. Enable or disable the extension as needed.

   if (processor.enabled) {
     await processor.disable();
   } else {
     await processor.enable();
   }

8. Set the noise suppression mode and level.

   processor.on('overload', async () => {
     await processor.setMode('STATIONARY_NS');
   });

Reference

Considerations

• If only some audio tracks on the current web page enable AI Noise Suppression, audio tracks that do not enable AI Noise Suppression may be affected because the extension turns on AEC and AGC and turns off browser NS.
• Although AI Noise Suppression supports Safari 14.1 and later, Safari may have performance issues. Best practice is not to support Safari.
• AI Noise Suppression does not support browsers on mobile devices.

Sample project

• AI Denoiser web demo
• AI Denoiser source code

API reference

• AgoraRTC.registerExtensions
• IMicrophoneAudioTrack.pipe

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

Call setAINSMode to enable AI Noise Suppression and select a noise suppression mode:

bool enableAINS = true;
AUDIO_AINS_MODE mode = AINS_MODE_BALANCED;

int result = rtcEngine->setAINSMode(enableAINS, mode);

Reference

API reference

• setAINSMode

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

Call setAINSMode to enable AI Noise Suppression and select a noise suppression mode:

const enabled = true;
const result = rtcEngine.setAINSMode(
  enabled,
  AudioAinsMode.AinsModeUltralowlatency,
);

if (result !== 0) {
  console.error('Failed to enable AI Noise Suppression');
}

Reference

API reference

• setAINSMode

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

Call setAINSMode to enable AI Noise Suppression and select a noise suppression mode:

Future<void> enableNoiseSuppression() async {
  const enabled = true;
  const mode = AudioAinsMode.AINS_MODE_ULTRALOWLATENCY;

  await _engine.setAINSMode(enabled: enabled, mode: mode);
}

Reference

API reference

• setAINSMode

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

Call setAINSMode to enable AI Noise Suppression and select a noise suppression mode:

const setAINSMode = () => {
  const enabled = true;
  const mode = AgoraRtcEngine.AudioAinsMode.AINS_MODE_ULTRALOWLATENCY;

  return rtcEngine.setAINSMode(enabled, mode);
};

Reference

API reference

• setAINSMode

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use-case. Contact support@agora.io for details.

Want to try out AI Noise Suppression? Use the online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

1. Configure the noise suppression extension

   This code initializes the AI Noise Suppression extension, checks compatibility, and sets up a noise reduction processor for the local microphone track. It registers the extension, checks compatibility, and initializes the AI noise processor.

   function AgoraExtensionComponent() {
     const extension = useRef(new AIDenoiserExtension({assetsPath:'./node_modules/agora-extension-ai-denoiser/external'}));
     const processor = useRef<IAIDenoiserProcessor>();
   
     useEffect(() => {
       const initializeAIDenoiserProcessor = async () => {
           AgoraRTC.registerExtensions([extension.current]);
           if (!extension.current.checkCompatibility()) {
               console.error("Does not support AI Denoiser!");
               return;
           }
           if (localMicrophoneTrack)
           {
               console.log("Initializing an ai noise processor...");
               try {
                   processor.current = extension.current.createProcessor();
                   localMicrophoneTrack.pipe(processor.current).pipe(localMicrophoneTrack.processorDestination);
                   await processor.current.enable();
               } catch (error) {
               console.error("Error applying noise reduction:", error);
               }
           }
       };
   
       void initializeAIDenoiserProcessor();
   
       return () => {
         const disableAIDenoiser = async () => {
           processor.current?.unpipe();
           localMicrophoneTrack?.unpipe();
           await processor.current?.disable();
         };
         void disableAIDenoiser();
       };
     }, [localMicrophoneTrack]);
   }

2. Change the noise reduction mode

   This function changes the noise reduction mode based on the provided mode.

   const changeNoiseReductionMode = (mode: AIDenoiserProcessorMode) => {
       processor.current.setMode(mode)
   }

3. Change the noise reduction level

   This function changes the noise reduction level based on the provided level.

   const changeNoiseReductionLevel = (level: AIDenoiserProcessorLevel) => {
       processor.current.setLevel(level)
   }

Reference

This section completes the information on this page, or points you to documentation that explains other aspects about this product.

AI Noise Suppression reduces the following types of noise:

• Television
• Kitchen
• Street, such as birds chirping, traffic, and subway sounds
• Machine, such as fans, air conditioners, vacuum cleaners, and copiers
• Office, such as keyboard and mouse clicks
• Household, such as doors opening, creaking chairs, crying babies, and house renovations
• Constant knocking
• Beeps and clapping
• Music

You can choose the following noise reduction strategies:

• Default: Reduces noise to a comfortable level without distorting human voice.
• Custom: A more enhanced or customized noise reduction strategy for your business use case. Contact support@agora.io for details.

Try the AI Noise Suppression online demo.

Understand the tech

In the pre-processing stage, AI Noise Suppression uses deep learning noise reduction algorithms to modify audio data in the extensions pipeline.

AI noise suppression

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Enable AI Noise Suppression

This section shows you how to integrate AI Noise Suppression into your app.

Call SetAINSMode to enable AI Noise Suppression and select a noise suppression mode:

bool enableAINS = true;
AUDIO_AINS_MODE mode = AUDIO_AINS_MODE.AINS_MODE_BALANCED;

int result = rtcEngine.SetAINSMode(enableAINS, mode);

Reference

API reference

• SetAINSMode