Koala Noise Suppression
Web Quick Start

Platforms

• Chrome & Chromium-based browsers
• Edge
• Firefox
• Safari

Requirements

• Picovoice Account and AccessKey
• Node.js 16+
• npm

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Install Node.js.

2. Install the Web Voice Processor and Koala Noise Suppression Web packages:

npm install @picovoice/web-voice-processor @picovoice/koala-web

Usage

Create an instance of KoalaWorker:

import { KoalaWorker } from "@picovoice/koala-web";
import koalaParams from "${KOALA_PARAMS_BASE64_PATH}";

function processCallback(enhancedPcm: Int16Array) {
  // do something with enhancedPcm
}

const koala = await KoalaWorker.create(
  "${ACCESS_KEY}",
  processCallback,
  {
    base64: koalaParams,
    // or
    publicPath: "${MODEL_RELATIVE_PATH}",
  }
);

Subscribe KoalaWorker to WebVoiceProcessor to start processing audio frames:

import { WebVoiceProcessor } from "@picovoice/web-voice-processor"

WebVoiceProcessor.subscribe(koala);

Once done, unsubscribe to stop processing audio frames:

import { WebVoiceProcessor } from "@picovoice/web-voice-processor";

WebVoiceProcessor.unsubscribe(koala);

In case the next audio frame does not directly follow the previous one, reset Koala Noise Suppression's internal state:

import { WebVoiceProcessor } from "@picovoice/web-voice-processor"

await koala.reset();
WebVoiceProcessor.subscribe(koala);

Release resources explicitly when done with Koala Noise Suppression:

await koala.release()

Demo

For the Koala Noise Suppression Web SDK, there is a Web demo project available on the Koala Noise Suppression GitHub repository.

Setup

Clone the Koala Noise Suppression repository from GitHub:

git clone --recurse-submodules https://github.com/Picovoice/koala.git

Usage

1. Install dependencies and run:

cd koala/demo/web
npm install
npm run start

2. Open http://localhost:5000 to view it in the browser.

Resources