anchorPrerequisites

To set up BNR for your Webex calls using the Web SDK:

1. The webex version should be 3.0.0 or higher.
2. The @webex/calling should be 3.0.1 or higher.
3. A valid Webex access token is required.

anchorCreate LocalAudioStream

To add the Background Noise Reduction (BNR) effect to Webex calls, create a LocalAudioStream with the code below and the specified constraints:

const constraints = {audio: true}

const localAudioStream = await Calling.createMicrophoneStream(constraints);

Include the SDK via a CDN or import it as shown:

import Calling from 'webex';

For more details on importing Calling, see Quickstart Guide.

Parameters

anchorCreating & Adding Noise Reduction Effect

With localAudioStream established, create a noise reduction effect with the specified options and attach it to the stream:

const effect = await Calling.createNoiseReductionEffect(options);

Options

For more details on options listed above, see https://github.com/webex/web-media-effects?tab=readme-ov-file#noise-reduction

After creating the effect, add it to the LocalAudioStream:

Before webex 3.0.0-next.4 or @webex/calling 3.0.1-next.2

await localAudioStream.addEffect('background-noise-removal', effect); 

After webex 3.0.0-next.4 or @webex/calling 3.0.1-next.2

await localAudioStream.addEffect(effect); 

Parameters

anchorEnabling Background Noise Reduction

BNR effect has been added to the LocalAudioStream so you can enable it as shown below:

let bnrEffect = await localAudioStream.getEffectByKind('noise-reduction-effect');

if (bnrEffect) {
    await bnrEffect.enable();
}

anchorDisabling Background Noise Reduction

To disable the BNR effect:

let bnrEffect = await localAudioStream.getEffectByKind('noise-reduction-effect');

if (bnrEffect) {
    await bnrEffect.disable();
}

anchorRemove the BNR Effect

Dispose of the effect when it's no longer needed or during stream cleanup to prevent memory leaks. This is crucial when switching streams mid-call or when the microphone changes during a call.

To remove BNR:

await localAudioStream.disposeEffects()

This action clears all the effects from the LocalAudioStream simultaneously.