Skip to content

Add notes about official plugins #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andresovela merged 5 commits into from
Sep 2, 2026
Merged

Add notes about official plugins #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
539971c
Add notes about official plugins
andresovela Sep 2, 2026
8cbaef2
framework -> ecosystem
andresovela Sep 2, 2026
38df33b
Add IMPORTANT sections
andresovela Sep 2, 2026
cdc0130
Add links to official plugins
andresovela Sep 2, 2026
b85d955
package -> packages
andresovela Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ 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.

> [!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

| Runtime | Package | Documentation |
Expand All @@ -25,9 +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 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`](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 packages for
> your runtime and do not mix objects from the two implementations.

## Repository contents

Expand Down
18 changes: 16 additions & 2 deletions node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,25 @@
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.
> [!IMPORTANT]
> 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
> 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.

```bash
npm uninstall @livekit/plugins-ai-coustics
npm install @ai-coustics/livekit-plugin
Expand Down
17 changes: 15 additions & 2 deletions python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,24 @@
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.
> [!IMPORTANT]
> 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
> 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.

```bash
pip uninstall livekit-plugins-ai-coustics
pip install ai-coustics-livekit-plugin
Expand Down
Loading