Adds LiveKit's Krisp noise filter to Modular A/V's noise cancellation choice, next to RNNoise, Speex and GTCRN. It is offered only while the call goes through LiveKit Cloud, which licenses Krisp to its projects; on a self-hosted LiveKit server it isn't shown. Requires Modular A/V (modular-av) and Modular A/V: LiveKit (modular-av-livekit).
Using it
- Enable it in a world that calls through LiveKit Cloud.
- Each player picks Krisp (LiveKit Cloud) under Noise cancellation, in the dock's voice panel or in the voice and video settings.
- Krisp model quality (low, medium or high, per device) appears under the choice while Krisp is picked. Higher removes more noise and takes more of the computer.
What it downloads and reports
- Downloads: the module contains none of LiveKit's code. When a player turns Krisp on, their browser downloads
@livekit/krisp-noise-filter0.4.5 from npm through jsDelivr, and accepts it only if it matches a fixed SHA-384 hash. Krisp then downloads its models from LiveKit. Both are cached by the browser. - Your audio: Krisp runs in the player's browser. No audio leaves it for Krisp or LiveKit beyond the call itself.
- Usage reports: Krisp checks with your LiveKit Cloud project that it may run, and reports its use to that project: the room's name and id, the player's Foundry user id, and how long it ran. GMs who don't want that can leave this module off.
Good to know
- Requirements: Foundry VTT v14, Modular A/V and Modular A/V: LiveKit, on LiveKit Cloud. Tested in Chrome, Edge and other Chromium browsers.
- If Krisp can't load (a network that blocks jsDelivr or LiveKit, for example), the player is heard without it, and the dock says so.
- Licence: this module is MIT.
@livekit/krisp-noise-filteris LiveKit's and not open source. It isn't redistributed here, and LiveKit confirmed in writing that this module may load it for its users.
Links
- Documentation: https://github.com/Affid/modular-av/wiki/Noise-Cancellation
- Report an issue: https://github.com/Affid/modular-av/issues