twilio-krisp-audio-plugin

twilio-krisp-audio-plugin

This plugin can be used with twilio-video to provide noise cancellation. In order to use this plugin,

1. download necessary files

  npm install twilio-krisp-audio-plugin

1. Host ./node_modules/twilio-krisp-audio-plugin/dist/ directory from your webserver.

2. Update your twilio-video application code to provide the path to the dist directory as sdkAssetsPath when creating a local audio track as shown below.

const { connect, createLocalAudioTrack } = require('twilio-video');

// create a local audio track and have it
// use 3rd party library for noise cancellation processing.
const localAudioTrack = await Video.createLocalAudioTrack({
  noiseCancellationOptions: { vendor: 'krisp', sdkAssetsPath: '/path_to_dist' }
});

// publish the track to a room
const room = await connect( token, {
  tracks: [localAudioTrack]
  // ... any other connect options
});

// you can enable/disable noise cancellation at runtime
// using noiseCancellation interface exposed by localAudioTrack
function updateNoiseCancellation(enable: boolean) {
  const noiseCancellation = localAudioTrack.noiseCancellation;

  if (noiseCancellation) {
    enable ? noiseCancellation.enable() : noiseCancellation.disable();
  }
}