Livekit plugin for noise cancellation of inbound AudioStream
Project description
Enhanced Noise Cancellation Plugin for LiveKit
Add realtime enhanced noise cancellation to inbound AudioStream
. Fully compatible with LiveKit Agents.
Requires LiveKit Cloud.
Read more in the documentation
Usage
In LiveKit Agents
Include the filter in RoomInputOptions
when starting your AgentSession
:
from livekit.plugins import noise_cancellation
# ...
await session.start(
# ...,
room_input_options=room_io.RoomInputOptions(
noise_cancellation=noise_cancellation.BVC(),
),
)
# ...
On AudioStream
Noise cancellation can also be applied to any individual inbound AudioStream
:
stream = rtc.AudioStream.from_track(
track=track,
noise_cancellation=noise_cancellation.NC(),
)
Available Models
noise_cancellation.NC()
noise_cancellation.BVC()
noise_cancellation.BVCTelephony()
Notes
Noise cancellation only needs to be applied once, so if you choose to apply it here you should disable noise cancellation / Krisp filter in your frontend clients.
If you experience crashes when using noise_cancellation
(especially on AMD CPUs), it may be due to a failure in OpenBLAS's CPU detection. Manually setting the OPENBLAS_CORETYPE
environment variable to a more conservative value (e.g., Haswell
) may resolve the issue.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
File details
Details for the file livekit_plugins_noise_cancellation-0.2.5-py3-none-win_amd64.whl
.
File metadata
- Download URL: livekit_plugins_noise_cancellation-0.2.5-py3-none-win_amd64.whl
- Upload date:
- Size: 65.8 MB
- Tags: Python 3, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
5879d28120a6b47a7d557832d9432683710987f79e9b514171898be36534380b
|
|
MD5 |
3aadae389282c96a8ff2bbd9dc4e8356
|
|
BLAKE2b-256 |
9f4d37be8da861607f392d07bb0f1c6b57c635db249095084abcbfaaaab6d7b5
|
File details
Details for the file livekit_plugins_noise_cancellation-0.2.5-py3-none-manylinux_2_28_x86_64.whl
.
File metadata
- Download URL: livekit_plugins_noise_cancellation-0.2.5-py3-none-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 73.3 MB
- Tags: Python 3, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
535e510d92e0a36e33f60c2ddd4de0da3cbfd21fe02d767f5839b421b5bea9fb
|
|
MD5 |
0f5690ee89cae2acb95c6cf89a26b2e4
|
|
BLAKE2b-256 |
c7b82f7a56b1c15220988fb4ac3e73483cf611a7547ab16b867b25d373eddbc7
|
File details
Details for the file livekit_plugins_noise_cancellation-0.2.5-py3-none-manylinux_2_28_aarch64.whl
.
File metadata
- Download URL: livekit_plugins_noise_cancellation-0.2.5-py3-none-manylinux_2_28_aarch64.whl
- Upload date:
- Size: 70.2 MB
- Tags: Python 3, manylinux: glibc 2.28+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
47050db446693e1a260339f5c45b025cd2b6030516a80e976d90ebaa4eef687c
|
|
MD5 |
85f2fcff0a8b913fe6d8d103c61c285c
|
|
BLAKE2b-256 |
902ecf86f21b338c6571b95e18bd9d96b33d64bf2fb1123f796cc7033bda821d
|
File details
Details for the file livekit_plugins_noise_cancellation-0.2.5-py3-none-macosx_11_0_arm64.whl
.
File metadata
- Download URL: livekit_plugins_noise_cancellation-0.2.5-py3-none-macosx_11_0_arm64.whl
- Upload date:
- Size: 64.6 MB
- Tags: Python 3, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
584211137dc732ac882fb11a40c35888250c74a8806e46a21ce1fd57a05c1c1e
|
|
MD5 |
2cc726b8ff503dceed1ebaea5cdd0d3e
|
|
BLAKE2b-256 |
1b753758aeba5964b826482786c044866e353823d6d5ff1736106584ae7d3b06
|
File details
Details for the file livekit_plugins_noise_cancellation-0.2.5-py3-none-macosx_10_9_x86_64.whl
.
File metadata
- Download URL: livekit_plugins_noise_cancellation-0.2.5-py3-none-macosx_10_9_x86_64.whl
- Upload date:
- Size: 66.1 MB
- Tags: Python 3, macOS 10.9+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
b327424a70a4d4f2ce9a52144fa62f68372b644951a738b12c104cb4f2a15b6b
|
|
MD5 |
2cf1655ee2590daf5525be6bb514d8aa
|
|
BLAKE2b-256 |
362a2782bc35b0fee188d362a4628f1c0595a61fe76d56c527bc5de4df8fddfc
|