API Reference

Complete reference for the decibri-web browser API. For installation and basic usage, see Getting Started.

Constructor

new Decibri(options?)

Creates a new capture instance. Does not start capture. Call start() to begin.

import { Decibri } from 'decibri-web';
const mic = new Decibri(options?);

Methods

mic.start()

Returns Promise<void>. Requests microphone permission and begins capture. Must be called from a user gesture in Safari. No-op if already started. Rejects with a clear error on permission denial.

mic.stop()

Stops capture and releases all resources (tracks, context, nodes). Safe to call anytime, including before start() or multiple times. Emits 'end' then 'close'.

Properties

mic.isOpen

boolean (read-only). Returns true while actively capturing audio.

Static methods

Decibri.devices()

Returns Promise<DeviceInfo[]>. Lists available audio input devices. Labels may be empty before microphone permission is granted.

const devices = await Decibri.devices();
console.log(devices);
// [
//   { deviceId: 'abc123', label: 'Built-in Microphone', groupId: 'g1' },
//   ...
// ]

Decibri.version()

Returns version information for decibri-web.

Decibri.version();
// { decibriWeb: '0.1.0' }

Events

Types

// DeviceInfo
{
  deviceId: string,
  label: string,
  groupId: string,
}

// VersionInfo
{
  decibriWeb: string,
}

Differences from decibri (Node.js)