Reference

API

Generated by TypeDoc on every build from src/index.ts. The narrative concept pages are still the best way to learn — this index is for "I know the name, link me to it."

Class

AggregateDecodeError

Thrown when every URL in a fallback list fails to load. Subclass of DecodeError so existing
Bus

A Bus is a named mix bucket with its own gain stage, optional FX inserts, a voice-concurrency limit, and an optional sidechain key. Voices are connected to bus.input. The master receives bus.output. level/mute use 10ms ramps to avoid clicks; raw gain.value writes would pop audibly on browsers that don't smooth the parameter. Public time arguments (fadeTo) are seconds.
BusGroup

A logical handle that addresses several buses at once. Doesn't change the audio graph — applies operations (level, fade, mute, solo) to every member in parallel. Useful when several buses form a sub-mix that should always be controlled together: combat = weapons + enemies + environment; voice = dialogue + effort sounds; etc. Construct via
BusNotFoundError
Compressor

Dynamics compressor as a bus FX insert. Wraps DynamicsCompressorNode and a make-up gain node, and exposes
DecodeError
Ducker

Sidechain ducker. Inserts on the *target* bus (e.g. music) and listens to the level of a source bus (e.g. voice). When the source is loud, the target's gain drops; when quiet, it returns. Implementation: an envelope follower running on the source bus's RMS, driving an additional gain node spliced into the target's FX chain. The envelope follower runs on the main thread at ~60 Hz — fine for a speech ducker, not for sample-accurate audio-rate sidechaining. For that, use a custom AudioWorklet (planned).
EngineClosedError
Filter

Biquad filter as a bus FX insert. Bypass is a graph swap, not a parameter trick — when bypassed, input is connected directly to output, leaving the biquad fully detached so its delay-line state can't bleed into the dry signal.
Master

The Master stage. Headroom-aware gain into an optional soft limiter, then to destination. Buses connect their output to master.input. Headroom is a static gain offset; the limiter is a fast-attack DynamicsCompressorNode that catches most peaks the headroom can't tame when heavy FX stack on top of busy mixes. Note it is best-effort, not a true brick-wall limiter — with a finite attack and no lookahead, transient peaks above the threshold can still pass, so it does not guarantee a hard ceiling.
Music

Stinger → loop → outro music asset. The pattern every casino slot, action game, and rhythm game uses for combat/win/menu music: an intro that plays once, a body that loops cleanly until you ask it to stop, and an outro tail that plays once at the natural loop boundary so the music ends musically instead of cutting off mid-bar. Construct via
MusicVoice

One live playback instance of a
Parameter

A named float you can drive at runtime. Set it from anywhere; subscribers (bus levels, FX wet, voice gain) update immediately. Bind a target to a parameter with
PreloadError

Thrown by
Reverb

Convolution reverb. Mixes a dry signal with a wet path that runs through a ConvolverNode. If no impulse response is provided, a synthetic noise decay is generated — quick and free, but not as nice as a real IR.
Send

One configured send from a source bus to a target bus. Returned by
Snapshot

A captured mix-state preset. Capture it once with the engine in a known good state ("menu mood"), then
Sound

A loaded sample — owns one decoded AudioBuffer, spawns Voices on play(). Sound is created via engine.loadSound() / bank load; constructor is package-private.
SoundNotFoundError
Spatializer

PannerNode + occlusion biquad wrapper. Inserted between a Voice and its Bus when a play call passes a
Sprite

One buffer, many named regions, one fetch. Use for cascades, UI variants, low-latency one-shots — anything where the cost of N separate decodes outweighs the cost of N region offsets into a single buffer. Built on top of an underlying Sound (the buffer); regions are cooperative — overlapping regions just produce overlapping voices.
StreamSound

Stream a long media file through HTMLAudioElement → MediaElementAudioSource. Use for music tracks > 30s where decoding the whole file into RAM (the loadSound path) would waste memory and stall on iOS. The element handles progressive download and seek; we just route its output into the engine's bus graph so it picks up the same FX/sidechain as buffer-based voices. Created lazily — the underlying MediaElementAudioSource is only built on first play(), since it can't be reattached to a different bus once created.
StretchProcessor

Pitch-preserving time-stretch via overlap-add granular synthesis with cross-correlation alignment (a SOLA-style approximation). Used to render an offline stretched copy of an AudioBuffer at load time — not realtime. For realtime tempo control, see the (planned) AudioWorklet implementation. stretchFactor > 1 = play faster (shorter buffer). stretchFactor < 1 = not currently supported (use rate via PlaybackRate).
Variants

A bundle of N alternate sounds that play one at a time. The classic casino-slot pattern: every coin / win / reel-stop trigger plays a randomised variant so stacked SFX don't sound robotic. Construct via
Voice

One playback instance, returned from sound.play(). Owns its source node and gain stage; disposes itself on natural end, signal abort, or stop(). Voice constructor is package-private — callers obtain instances via Sound.play().
ZvukError

Function

Interface

TypeAlias