From 539971cbb7e21e213e2b712de858a347c938607e Mon Sep 17 00:00:00 2001 From: andresovela Date: Wed, 2 Sep 2026 15:43:39 +0200 Subject: [PATCH 1/5] Add notes about official plugins --- README.md | 20 +++++++++++++++++--- node/README.md | 18 ++++++++++++++++-- python/README.md | 17 +++++++++++++++-- 3 files changed, 48 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 15f53d5..d5b60e1 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,19 @@ Applications choose and provision the SDK models themselves. This keeps model se and deployment under application control while the plugins handle LiveKit audio formats, stream lifecycle, observability, and error recovery. +## Which integration should I use? + +The official LiveKit plugins are the recommended integration path for most applications. They +support LiveKit Cloud, integrate more deeply with the LiveKit framework and tooling, and offer +stronger stability guarantees. Avoiding breaking changes is an explicit goal of the official +plugins. + +The ai-coustics-maintained plugins in this repository follow a faster release cadence and are +designed for teams that want early access to the latest ai-coustics models and product features. +Some of those capabilities may be experimental and subject to change, and use of these plugins is +billed separately through ai-coustics. Choose them when early adoption of new ai-coustics +capabilities is important for your application. + ## Packages | Runtime | Package | Documentation | @@ -25,9 +38,10 @@ The runtime guides cover migration from the official plugins, model provisioning integration, Processor enhancement settings, VAD parameters, authentication, and operational constraints. -> These packages replace LiveKit's official `livekit-plugins-ai-coustics` and -> `@livekit/plugins-ai-coustics` packages; they are not extensions of them. Uninstall the official -> package for your runtime before migrating, and do not mix objects from the two implementations. +> These packages are alternatives to LiveKit's official `livekit-plugins-ai-coustics` and +> `@livekit/plugins-ai-coustics` packages, not extensions of them. If you choose to migrate, +> uninstall the official package for your runtime and do not mix objects from the two +> implementations. ## Repository contents diff --git a/node/README.md b/node/README.md index 0b20e22..518bbc3 100644 --- a/node/README.md +++ b/node/README.md @@ -3,8 +3,22 @@ Audio enhancement, voice activity detection, and audio-quality analysis for LiveKit Agents, backed by the public `@ai-coustics/aic-sdk` package. -> This package replaces `@livekit/plugins-ai-coustics`. Uninstall the official package before -> migrating, and do not mix objects from the two implementations. +## Which integration should I use? + +The official `@livekit/plugins-ai-coustics` package is the recommended integration path for most +applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit framework and +tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal +of the official plugin. + +This ai-coustics-maintained package follows a faster release cadence and is designed for teams that +want early access to the latest ai-coustics models and product features. Some of those capabilities +may be experimental and subject to change, and use of this package is billed separately through +ai-coustics. Choose it when early adoption of new ai-coustics capabilities is important for +your application. + +> This package is an alternative to `@livekit/plugins-ai-coustics`, not an extension of it. If you +> choose to migrate, uninstall the official package and do not mix objects from the two +> implementations. ## Installation diff --git a/python/README.md b/python/README.md index 897a830..eb5b38e 100644 --- a/python/README.md +++ b/python/README.md @@ -3,8 +3,21 @@ Audio enhancement, voice activity detection, and audio-quality analysis for LiveKit Agents, backed by the public `aic-sdk` package. -> This package replaces `livekit-plugins-ai-coustics`. Do not install both packages because they -> provide the same `livekit.plugins.ai_coustics` import path. +## Which integration should I use? + +The official `livekit-plugins-ai-coustics` package is the recommended integration path for most +applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit framework and +tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal +of the official plugin. + +This ai-coustics-maintained package follows a faster release cadence and is designed for teams that +want early access to the latest ai-coustics models and product features. Some of those capabilities +may be experimental and subject to change, and use of this package is billed separately through +ai-coustics. Choose it when early adoption of new ai-coustics capabilities is important for +your application. + +> This package is an alternative to `livekit-plugins-ai-coustics`, not an extension of it. Do not +> install both packages because they provide the same `livekit.plugins.ai_coustics` import path. ## Installation From 8cbaef2c3af3fee1e857c3b79643a5934111c571 Mon Sep 17 00:00:00 2001 From: andresovela Date: Wed, 2 Sep 2026 15:55:27 +0200 Subject: [PATCH 2/5] framework -> ecosystem --- README.md | 2 +- node/README.md | 2 +- python/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d5b60e1..fe60b03 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ lifecycle, observability, and error recovery. ## Which integration should I use? The official LiveKit plugins are the recommended integration path for most applications. They -support LiveKit Cloud, integrate more deeply with the LiveKit framework and tooling, and offer +support LiveKit Cloud, integrate more deeply with the LiveKit ecosystem and tooling, and offer stronger stability guarantees. Avoiding breaking changes is an explicit goal of the official plugins. diff --git a/node/README.md b/node/README.md index 518bbc3..00b2e45 100644 --- a/node/README.md +++ b/node/README.md @@ -6,7 +6,7 @@ Audio enhancement, voice activity detection, and audio-quality analysis for Live ## Which integration should I use? The official `@livekit/plugins-ai-coustics` package is the recommended integration path for most -applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit framework and +applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit ecosystem and tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal of the official plugin. diff --git a/python/README.md b/python/README.md index eb5b38e..aaa3314 100644 --- a/python/README.md +++ b/python/README.md @@ -6,7 +6,7 @@ Audio enhancement, voice activity detection, and audio-quality analysis for Live ## Which integration should I use? The official `livekit-plugins-ai-coustics` package is the recommended integration path for most -applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit framework and +applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit ecosystem and tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal of the official plugin. From 38df33b4ea4dfea2618cc786eafb810f05330bf7 Mon Sep 17 00:00:00 2001 From: andresovela Date: Wed, 2 Sep 2026 15:57:24 +0200 Subject: [PATCH 3/5] Add IMPORTANT sections --- README.md | 23 +++++++++++------------ node/README.md | 25 ++++++++++++------------- python/README.md | 25 ++++++++++++------------- 3 files changed, 35 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index fe60b03..3071894 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,17 @@ Applications choose and provision the SDK models themselves. This keeps model se and deployment under application control while the plugins handle LiveKit audio formats, stream lifecycle, observability, and error recovery. -## Which integration should I use? - -The official LiveKit plugins are the recommended integration path for most applications. They -support LiveKit Cloud, integrate more deeply with the LiveKit ecosystem and tooling, and offer -stronger stability guarantees. Avoiding breaking changes is an explicit goal of the official -plugins. - -The ai-coustics-maintained plugins in this repository follow a faster release cadence and are -designed for teams that want early access to the latest ai-coustics models and product features. -Some of those capabilities may be experimental and subject to change, and use of these plugins is -billed separately through ai-coustics. Choose them when early adoption of new ai-coustics -capabilities is important for your application. +> [!IMPORTANT] +> The official LiveKit plugins are the recommended integration path for most applications. They +> support LiveKit Cloud, integrate more deeply with the LiveKit ecosystem and tooling, and offer +> stronger stability guarantees. Avoiding breaking changes is an explicit goal of the official +> plugins. +> +> The ai-coustics-maintained plugins in this repository follow a faster release cadence and are +> designed for teams that want early access to the latest ai-coustics models and product features. +> Some of those capabilities may be experimental and subject to change, and use of these plugins is +> billed separately through ai-coustics. Choose them when early adoption of new ai-coustics +> capabilities is important for your application. ## Packages diff --git a/node/README.md b/node/README.md index 00b2e45..e01e7fd 100644 --- a/node/README.md +++ b/node/README.md @@ -3,25 +3,24 @@ Audio enhancement, voice activity detection, and audio-quality analysis for LiveKit Agents, backed by the public `@ai-coustics/aic-sdk` package. -## Which integration should I use? +> [!IMPORTANT] +> The official `@livekit/plugins-ai-coustics` package is the recommended integration path for most +> applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit ecosystem and +> tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal +> of the official plugin. +> +> This ai-coustics-maintained package follows a faster release cadence and is designed for teams +> that want early access to the latest ai-coustics models and product features. Some of those +> capabilities may be experimental and subject to change, and use of this package is billed +> separately through ai-coustics. Choose it when early adoption of new ai-coustics capabilities is +> important for your application. -The official `@livekit/plugins-ai-coustics` package is the recommended integration path for most -applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit ecosystem and -tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal -of the official plugin. - -This ai-coustics-maintained package follows a faster release cadence and is designed for teams that -want early access to the latest ai-coustics models and product features. Some of those capabilities -may be experimental and subject to change, and use of this package is billed separately through -ai-coustics. Choose it when early adoption of new ai-coustics capabilities is important for -your application. +## Installation > This package is an alternative to `@livekit/plugins-ai-coustics`, not an extension of it. If you > choose to migrate, uninstall the official package and do not mix objects from the two > implementations. -## Installation - ```bash npm uninstall @livekit/plugins-ai-coustics npm install @ai-coustics/livekit-plugin diff --git a/python/README.md b/python/README.md index aaa3314..86c445b 100644 --- a/python/README.md +++ b/python/README.md @@ -3,24 +3,23 @@ Audio enhancement, voice activity detection, and audio-quality analysis for LiveKit Agents, backed by the public `aic-sdk` package. -## Which integration should I use? +> [!IMPORTANT] +> The official `livekit-plugins-ai-coustics` package is the recommended integration path for most +> applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit ecosystem and +> tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal +> of the official plugin. +> +> This ai-coustics-maintained package follows a faster release cadence and is designed for teams +> that want early access to the latest ai-coustics models and product features. Some of those +> capabilities may be experimental and subject to change, and use of this package is billed +> separately through ai-coustics. Choose it when early adoption of new ai-coustics capabilities is +> important for your application. -The official `livekit-plugins-ai-coustics` package is the recommended integration path for most -applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit ecosystem and -tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal -of the official plugin. - -This ai-coustics-maintained package follows a faster release cadence and is designed for teams that -want early access to the latest ai-coustics models and product features. Some of those capabilities -may be experimental and subject to change, and use of this package is billed separately through -ai-coustics. Choose it when early adoption of new ai-coustics capabilities is important for -your application. +## Installation > This package is an alternative to `livekit-plugins-ai-coustics`, not an extension of it. Do not > install both packages because they provide the same `livekit.plugins.ai_coustics` import path. -## Installation - ```bash pip uninstall livekit-plugins-ai-coustics pip install ai-coustics-livekit-plugin From cdc0130429c0198c5905f43aa195810aac10666c Mon Sep 17 00:00:00 2001 From: andresovela Date: Wed, 2 Sep 2026 16:04:32 +0200 Subject: [PATCH 4/5] Add links to official plugins --- README.md | 9 +++++---- node/README.md | 9 +++++---- python/README.md | 9 +++++---- 3 files changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3071894..daea091 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,11 @@ The runtime guides cover migration from the official plugins, model provisioning integration, Processor enhancement settings, VAD parameters, authentication, and operational constraints. -> These packages are alternatives to LiveKit's official `livekit-plugins-ai-coustics` and -> `@livekit/plugins-ai-coustics` packages, not extensions of them. If you choose to migrate, -> uninstall the official package for your runtime and do not mix objects from the two -> implementations. +> These packages are alternatives to LiveKit's official +> [`livekit-plugins-ai-coustics`](https://pypi.org/project/livekit-plugins-ai-coustics/) and +> [`@livekit/plugins-ai-coustics`](https://www.npmjs.com/package/@livekit/plugins-ai-coustics) +> packages, not extensions of them. If you choose to migrate, uninstall the official package for +> your runtime and do not mix objects from the two implementations. ## Repository contents diff --git a/node/README.md b/node/README.md index e01e7fd..ef1dd89 100644 --- a/node/README.md +++ b/node/README.md @@ -4,10 +4,11 @@ Audio enhancement, voice activity detection, and audio-quality analysis for Live `@ai-coustics/aic-sdk` package. > [!IMPORTANT] -> The official `@livekit/plugins-ai-coustics` package is the recommended integration path for most -> applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit ecosystem and -> tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal -> of the official plugin. +> The official +> [`@livekit/plugins-ai-coustics`](https://www.npmjs.com/package/@livekit/plugins-ai-coustics) +> package is the recommended integration path for most applications. It supports LiveKit Cloud, +> integrates more deeply with the LiveKit ecosystem and tooling, and offers stronger stability +> guarantees. Avoiding breaking changes is an explicit goal of the official plugin. > > This ai-coustics-maintained package follows a faster release cadence and is designed for teams > that want early access to the latest ai-coustics models and product features. Some of those diff --git a/python/README.md b/python/README.md index 86c445b..9acb102 100644 --- a/python/README.md +++ b/python/README.md @@ -4,10 +4,11 @@ Audio enhancement, voice activity detection, and audio-quality analysis for Live `aic-sdk` package. > [!IMPORTANT] -> The official `livekit-plugins-ai-coustics` package is the recommended integration path for most -> applications. It supports LiveKit Cloud, integrates more deeply with the LiveKit ecosystem and -> tooling, and offers stronger stability guarantees. Avoiding breaking changes is an explicit goal -> of the official plugin. +> The official +> [`livekit-plugins-ai-coustics`](https://pypi.org/project/livekit-plugins-ai-coustics/) package is +> the recommended integration path for most applications. It supports LiveKit Cloud, integrates +> more deeply with the LiveKit ecosystem and tooling, and offers stronger stability guarantees. +> Avoiding breaking changes is an explicit goal of the official plugin. > > This ai-coustics-maintained package follows a faster release cadence and is designed for teams > that want early access to the latest ai-coustics models and product features. Some of those From b85d955d615cbfc33bbde855dc90b83d4fa13bc2 Mon Sep 17 00:00:00 2001 From: andresovela Date: Wed, 2 Sep 2026 16:05:34 +0200 Subject: [PATCH 5/5] package -> packages --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index daea091..0cdfe7c 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ constraints. > These packages are alternatives to LiveKit's official > [`livekit-plugins-ai-coustics`](https://pypi.org/project/livekit-plugins-ai-coustics/) and > [`@livekit/plugins-ai-coustics`](https://www.npmjs.com/package/@livekit/plugins-ai-coustics) -> packages, not extensions of them. If you choose to migrate, uninstall the official package for +> packages, not extensions of them. If you choose to migrate, uninstall the official packages for > your runtime and do not mix objects from the two implementations. ## Repository contents