API reference

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

C

classEnvelope

@codexo/exojs / audio / stable

ADSR (Attack-Decay-Sustain-Release) envelope generator. Schedules a gain curve on a target `AudioParam`: attack: 0 → 1.0 (peak) over attackMs decay: 1.0 → sustainLevel over decayMs sustain: held at sustainLevel release: current → 0 over releaseMs (triggered by `release()`) Use `trigger()` to start the attack/decay/sustain phase, and `release()` to start the release phase. Multiple envelopes can target the same AudioParam; the latest schedule wins (cancel via `gain.cancelScheduledValues` if needed).

5
props
3
methods
0
events
Import
import { Envelope } from '@codexo/exojs'

ADSR (Attack-Decay-Sustain-Release) envelope generator. Schedules a gain curve on a target `AudioParam`:

attack: 0 → 1.0 (peak) over attackMs decay: 1.0 → sustainLevel over decayMs sustain: held at sustainLevel release: current → 0 over releaseMs (triggered by `release()`)

Use `trigger()` to start the attack/decay/sustain phase, and `release()` to start the release phase. Multiple envelopes can target the same AudioParam; the latest schedule wins (cancel via `gain.cancelScheduledValues` if needed).

Constructors 1
new(options: EnvelopeOptions): Envelope
Methods 3
destroy(): void
release(gainParam: AudioParam, atTime: number): void
trigger(gainParam: AudioParam, atTime: number): void
Properties 5
attackMs: number
decayMs: number
releaseMs: number
sustainLevel: number
totalDurationMs: number
Source
src/audio/Envelope.ts