API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceAudioGeneratorOptions

@codexo/exojs / audio / stable

Construction options for AudioGenerator.

9
props
0
methods
0
events
Import
import { AudioGeneratorOptions } from '@codexo/exojs'

Construction options for AudioGenerator.

Properties9
detune?: number
Pitch detune in cents. Default 0.
envelope?: EnvelopeADSR (Attack-Decay-Sustain-Release) envelope generator. Schedules a gain curve on a target `AudioParam`: attack: 0 → 1.0 (peak) over attack decay: 1.0 → sustai… | null
Optional ADSR envelope. Default null (no envelope).
frequency?: number
Oscillator frequency in Hz. Default 440 (A4).
muted?: boolean
Default muted flag (starts a voice at volume 0). Default false.
poolSize?: number
Maximum concurrent voices. Default 8.
poolStrategy?: SoundPoolStrategyEviction strategy used when the pool is full and a new play is requested. At the per-Sound level all pooled instances share the same priority, so `LowestPriori…
Eviction strategy when the pool is full. Default FirstInFirstOut.
priority?: number
Priority for the LowestPriority strategy. Default 0.
type?: OscillatorType
Oscillator waveform. Default 'sine'.
volume?: number
Default volume applied to new voices. Range [0, 1]. Default 1.
Source
src/audio/AudioGenerator.ts