useKrispNoiseFilter

note

This feature is under active development and may change based on developer feedback and real-world usage.

Enable the Krisp enhanced noise cancellation feature for local audio tracks.

Defaults to the localParticipant's microphone track publication, but you can override this behavior by passing in a different track reference.

Import

import { useKrispNoiseFilter } from "@livekit/components-react/krisp";

Remarks

This filter requires that you install the @livekit/krisp-noise-filter package and is supported only on LiveKit Cloud.

Usage

const krisp = useKrispNoiseFilter();
return (
  <input
    type="checkbox"
    onChange={(ev) => krisp.setNoiseFilterEnabled(ev.target.checked)}
    checked={krisp.isNoiseFilterEnabled}
    disabled={krisp.isNoiseFilterPending}
  />
);

Properties

options.trackRef?TrackReferenceOrPlaceholder

The track reference to use for the noise filter (defaults: local microphone track)

Returns

Use setIsNoiseFilterEnabled to enable/disable the noise filter.

{
  setNoiseFilterEnabled: (enable: boolean) => Promise<void>;
  isNoiseFilterEnabled: boolean;
  isNoiseFilterPending: boolean;
  processor: KrispNoiseFilterProcessor | undefined;
}