useKrispNoiseFilter
function useKrispNoiseFilter(_options?): {
setNoiseFilterEnabled: (enable) => Promise<void>;
isNoiseFilterEnabled: boolean;
isNoiseFilterPending: boolean;
processor: unknown;
};Defined in: packages/react/src/hooks/device/useKrispNoiseFilter.ts:44
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
Parameters
| Parameter | Type |
|---|---|
_options? | UseKrispNoiseFilterOptions |
Returns
{
setNoiseFilterEnabled: (enable) => Promise<void>;
isNoiseFilterEnabled: boolean;
isNoiseFilterPending: boolean;
processor: unknown;
}setNoiseFilterEnabled
setNoiseFilterEnabled: (enable) => Promise<void>;Parameters
| Parameter | Type |
|---|---|
enable | boolean |
Returns
Promise<void>
isNoiseFilterEnabled
isNoiseFilterEnabled: boolean;isNoiseFilterPending
isNoiseFilterPending: boolean;processor
processor: unknown;Example
// Basic — toggle Krisp noise filtering for the local microphone.
const krisp = useKrispNoiseFilter();
return <input type="checkbox" checked={krisp.isNoiseFilterEnabled} />;
// Advanced — combine Krisp with local microphone status.
function KrispToggle() {
const { isMicrophoneEnabled } = useLocalParticipant();
const krisp = useKrispNoiseFilter();
return (
<input
type="checkbox"
onChange={(ev) => krisp.setNoiseFilterEnabled(ev.target.checked)}
checked={krisp.isNoiseFilterEnabled}
disabled={!isMicrophoneEnabled || krisp.isNoiseFilterPending}
/>
);
}
function KrispControl() {
return <VoiceRoom agent={agent}><KrispToggle /></VoiceRoom>;
}