@ai-coustics/livekit-extras

中文文档
0.25.2发布于 2026/10/27Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 2962

ai-coustics voice activity detection and audio analysis for LiveKit Agents

原始使用文档
文档目录9 节
  1. Feature Availability
  2. Installation
  3. Using this plugin next to the official plugin
  4. Model provisioning
  5. Usage
  6. Voice activity detection
  7. Audio Insight
  8. Combining frame processors
  9. Configuration

ai-coustics LiveKit extras for Node.js

Voice activity detection and Audio Insight for LiveKit Agents, backed by the @ai-coustics/aic-sdk package.

[!IMPORTANT] Use the official LiveKit plugin for ai-coustics speech enhancement. ai-coustics LiveKit extras adds product categories that the official plugin does not support yet. Features here can change between releases. Usage is billed through ai-coustics.

Feature Availability

Feature@ai-coustics/livekit-extras@livekit/plugins-ai-coustics
Speech EnhancementNoYes
Voice Activity Detection (VAD)Dedicated ModelsLegacy
Audio Insight (Tyto Analyzer)YesNo

Installation

npm install @ai-coustics/livekit-extras
export AIC_SDK_LICENSE=...

Using this plugin next to the official plugin

You can install this package and the official @livekit/plugins-ai-coustics package in the same project.

npm install @livekit/plugins-ai-coustics @ai-coustics/livekit-extras

RoomIO has one noiseCancellation slot. FrameProcessorChain lets vad.processor and analyzer.collector share it. Install the official enhancement in that slot on its own, because FrameProcessorChain does not pass LiveKit Cloud credentials to its processors.

This package needs its own ai-coustics license, even if the official plugin uses LiveKit Cloud. Set AIC_SDK_LICENSE or pass licenseKey.

Model provisioning

Download models during deployment or container setup:

import { Model } from "@ai-coustics/livekit-extras";

const vadPath = await Model.download("vad-2.1-xxs-16khz", "./models");
const analysisPath = await Model.download("tyto-1.1-l-16khz", "./models");

VAD and analysis models are different model types. Make the returned paths available to your worker, then load each model once per worker process:

const vadModel = Model.fromFile(vadPath);
const analysisModel = Model.fromFile(analysisPath);

Usage

RoomIO accepts one frame processor in its noiseCancellation slot. Install vad.processor or analyzer.collector there directly, or combine them with FrameProcessorChain as described in Combining frame processors.

Voice activity detection

Create a VAD for each agent session:

import { voice } from "@livekit/agents";
import { VAD } from "@ai-coustics/livekit-extras";

const vad = new VAD({ model: vadModel });

const session = new voice.AgentSession({
  vad,
  // ... stt, llm, tts
});

await session.start({
  // ... agent, room
  inputOptions: { noiseCancellation: vad.processor },
});

vad.processor must be installed in the noiseCancellation path whenever the VAD is used. All VAD streams read the immutable metadata it attaches to each frame, so the SDK model runs only once per audio block.

Audio Insight

Create an Analyzer, install its collector in RoomIO's audio path, and subscribe to its results:

import { Analyzer } from "@ai-coustics/livekit-extras";

const analyzer = new Analyzer({
  model: analysisModel,
  analysisInterval: 5, // seconds; 5 is the default
});

analyzer.on("analysisResult", (event) => {
  console.log(event.result.riskScore);
});

await session.start({
  // ... agent, room
  inputOptions: { noiseCancellation: analyzer.collector },
});

The Analyzer receives audio through analyzer.collector; constructing the analyzer without installing its collector does not feed it any room audio. RoomIO closes the collector, and with it the analyzer, when the input stream ends.

Results are not logged by the plugin; log or handle them in the callback.

Combining frame processors

Use FrameProcessorChain to run any number of processors in the same RoomIO audio path. For example, this runs VAD inference and analysis in one session:

import { FrameProcessorChain } from "@ai-coustics/livekit-extras";

const frameProcessor = new FrameProcessorChain(vad.processor, analyzer.collector);

await session.start({
  // ... agent, room
  inputOptions: { noiseCancellation: frameProcessor },
});

FrameProcessorChain runs its processors in order. Keep vad.processor first: it annotates the original frame while preserving its audio. We recommend placing analyzer.collector before any processor that changes the audio; measuring raw input makes it easier to understand how input audio quality affects the rest of the pipeline.

This still uses LiveKit's noiseCancellation slot as a temporary integration. RoomIO owns the chain and closes vad.processor, the collector, and the analyzer together.

Configuration

Configure all SDK VAD parameters on the VAD factory:

vad.setParameters({
  sensitivity: 0.5,
  speechHoldDuration: 0.25,
  minimumSpeechDuration: 0.05,
});

SDK VAD parameter durations (speechHoldDuration and minimumSpeechDuration) are specified in seconds. The VAD constructor options prefixPaddingDuration and maxBufferedSpeech are specified in milliseconds. See the Node.js SDK reference and VAD guide for parameter ranges, model support, and further details.

Set AIC_SDK_LICENSE or pass licenseKey to the constructor. Create a new VAD or Analyzer for each concurrent room; RoomIO closes its frame processor with the input stream.

Models must be provisioned explicitly. This package does not support npx livekit-agents download-files.

版本与发布记录

@ai-coustics/livekit-extras 共发布 4 个版本,首次发布于 2026/10/07;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.25.2latest2026/10/2711 天前
0.25.12026/10/1622 天前
0.25.02026/10/071 个月前
0.0.0-stage2026/10/071 个月前

关于 @ai-coustics/livekit-extras 的常见问题

@ai-coustics/livekit-extras 是什么?

ai-coustics voice activity detection and audio analysis for LiveKit Agents

如何安装 @ai-coustics/livekit-extras?

在项目目录运行 npm install @ai-coustics/livekit-extras,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@livekit/agents(>=1.0.43 <2)、@livekit/rtc-node(^0.13.24 || ^1.1.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@ai-coustics/livekit-extras 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@ai-coustics/livekit-extras 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@ai-coustics/livekit-extras 可以商用吗?

@ai-coustics/livekit-extras 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@ai-coustics/livekit-extras 的下载量有多少?

根据 npm 官方下载统计,@ai-coustics/livekit-extras 在 2026/10/05 – 2026/11/03 这 30 天内被下载 2,962 次,日均约 99 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@ai-coustics/livekit-extras 还在维护吗?

最新版本 0.25.2 发布于 2026/10/27(11 天前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/10/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。