EZ Web Audio / Sound

Class: Sound

Defined in: sound.ts:32

One-shot audio playback from an AudioBuffer.

Sound is the core class for playing audio files. Each .play() call creates a new AudioBufferSourceNode, allowing simultaneous overlapping playback. Use Track instead if you need pause/resume/seek functionality.

Sound extends BaseSound and inherits all audio parameter controls (gain, pan) and the fluent API for scheduling parameter changes.

Example

import { createSound } from 'ez-web-audio'

const sound = await createSound('click.mp3')
sound.play()

// Adjust volume before playing
sound.changeGainTo(0.5)
sound.play()

// Schedule a fade-in
sound.onPlaySet('gain').to(0).endingAt(1, 'exponential')
sound.play()

Extends

• BaseSound

Extended by

• Track

Constructors

Constructor

new Sound(audioContext, audioBuffer, opts?): Sound

Defined in: sound.ts:48

Create a Sound instance.

Note: Use createSound factory function instead of calling this directly.

Parameters

audioContext

AudioContext

The AudioContext to use for audio operations

audioBuffer

AudioBuffer

The decoded audio data to play

opts?

any

Optional configuration (name, setTimeout override)

Returns

Sound

Overrides

BaseSound.constructor

Properties

_analyzer

protected _analyzer: Analyzer | null = null

Defined in: base-sound.ts:114

Inherited from

BaseSound._analyzer

---

_destination

protected _destination: AudioNode

Defined in: base-sound.ts:107

Inherited from

BaseSound._destination

---

_isPlaying

protected _isPlaying: boolean = false

Defined in: base-sound.ts:70

Inherited from

BaseSound._isPlaying

---

audioContext

audioContext: AudioContext

Defined in: base-sound.ts:165

Inherited from

BaseSound.audioContext

---

audioSourceNode

audioSourceNode: AudioBufferSourceNode

Defined in: sound.ts:34

The underlying AudioBufferSourceNode that plays the audio.

Overrides

BaseSound.audioSourceNode

---

controller

protected controller: SoundController

Defined in: sound.ts:37

Controller for managing gain, pan, and other audio parameters.

Overrides

BaseSound.controller

---

debug?

optional debug: boolean

Defined in: base-sound.ts:163

Default

undefined (follows global debug mode)

Example

sound.debug = true  // enable debug for this sound
sound.debug = false // silence this sound even when global debug is on

Inherited from

BaseSound.debug

---

effectChainInput

protected effectChainInput: GainNode

Defined in: base-sound.ts:100

Inherited from

BaseSound.effectChainInput

---

effects

protected effects: Effect[] = []

Defined in: base-sound.ts:93

Inherited from

BaseSound.effects

---

gainNode

protected gainNode: GainNode

Defined in: base-sound.ts:78

The GainNode controlling this sound's volume.

For simple volume control, use changeGainTo() or update('gain'). For advanced routing, use getGainNode().

Inherited from

BaseSound.gainNode

---

name

name: string

Defined in: base-sound.ts:149

Inherited from

BaseSound.name

---

pannerNode

protected pannerNode: StereoPannerNode

Defined in: base-sound.ts:80

Inherited from

BaseSound.pannerNode

---

setTimeout()

protected setTimeout: (fn, delayMillis) => number

Defined in: base-sound.ts:81

Parameters

fn

() => void

delayMillis

number

Returns

number

Inherited from

BaseSound.setTimeout

---

startedPlayingAt

protected startedPlayingAt: number = 0

Defined in: base-sound.ts:82

Inherited from

BaseSound.startedPlayingAt

---

startOffset

protected startOffset: number = 0

Defined in: base-sound.ts:123

Offset in seconds from the beginning of the audio buffer where playback starts. Used internally by Track for seek/resume functionality.

Default

0

See

https://developer.mozilla.org/en-US/docs/Web/API/AudioScheduledSourceNode/start

Inherited from

BaseSound.startOffset

Accessors

duration

Get Signature

get duration(): TimeObject

Defined in: sound.ts:124

Get the duration of the audio buffer.

Returns a TimeObject with the duration in multiple formats:

• raw: Duration in seconds
• string: Formatted as 'MM:SS'
• pojo: Object with minutes and seconds properties

Example

const sound = await createSound('song.mp3')
console.log(sound.duration.raw)    // 180.5
console.log(sound.duration.string) // '3:00'
console.log(sound.duration.pojo)   // { minutes: 3, seconds: 0 }

Returns

TimeObject

Overrides

BaseSound.duration

---

isPlaying

Get Signature

get isPlaying(): boolean

Defined in: base-sound.ts:1082

Whether the sound is currently playing.

Example

if (sound.isPlaying) {
  await sound.stop()
}

Returns

boolean

Inherited from

BaseSound.isPlaying

---

percentGain

Get Signature

get percentGain(): number

Defined in: base-sound.ts:1094

Current gain as a percentage (0-100).

Example

console.log(`Volume: ${sound.percentGain}%`) // "Volume: 50%"

Returns

number

Inherited from

BaseSound.percentGain

Methods

_onPlaybackStarted()

protected _onPlaybackStarted(): void

Defined in: base-sound.ts:986

Hook method called after playback starts. Override in subclasses to add behavior that runs for all play variants.

Returns

void

Inherited from

BaseSound._onPlaybackStarted

---

addEffect()

addEffect(effect, position?): this

Defined in: base-sound.ts:344

Add an effect to the effect chain. Effects persist across multiple play() calls.

Parameters

effect

Effect

The Effect instance to add

position?

number

Optional index to insert at (defaults to end of chain)

Returns

this

this for chaining

Example

const filter = createFilterEffect(audioContext, 'lowpass', { frequency: 1000 })
sound.addEffect(filter)

Inherited from

BaseSound.addEffect

---

addEffects()

addEffects(effects, position?): this

Defined in: base-sound.ts:414

Add multiple effects to the effect chain in one call. The chain is rewired only once after all effects are added, which is more efficient than calling addEffect() multiple times.

Parameters

effects

Effect[]

Array of Effect instances to add

position?

number

Optional index to insert at (defaults to end of chain)

Returns

this

this for chaining

Example

const filter = createFilterEffect('lowpass', { frequency: 800 })
const boost = createGainEffect(1.5)
sound.addEffects([filter, boost])

Inherited from

BaseSound.addEffects

---

addEventListener()

Call Signature

addEventListener<K>(type, listener, options?): void

Defined in: base-sound.ts:555

Add a typed event listener for sound lifecycle events. Overloaded to provide type safety for known event types while remaining compatible with EventTarget.

Type Parameters

K

K extends keyof SoundEventMap

Parameters

type

K

The event type ('play', 'stop', 'end', etc.)

listener

(event) => void

The event handler function

options?

Standard addEventListener options

boolean | AddEventListenerOptions

Returns

void

Inherited from

BaseSound.addEventListener

Call Signature

addEventListener(type, listener, options?): void

Defined in: base-sound.ts:560

Add a typed event listener for sound lifecycle events. Overloaded to provide type safety for known event types while remaining compatible with EventTarget.

Parameters

type

string

The event type ('play', 'stop', 'end', etc.)

listener

The event handler function

EventListenerOrEventListenerObject | null

options?

Standard addEventListener options

boolean | AddEventListenerOptions

Returns

void

Inherited from

BaseSound.addEventListener

---

changeGainTo()

changeGainTo(value): this

Defined in: base-sound.ts:750

Set the gain (volume) immediately.

Convenience method for update('gain').to(value).as('ratio').

Parameters

value

number

Gain from 0 (silent) to 1 (full volume)

Returns

this

this for chaining

Example

sound.changeGainTo(0.5)  // Half volume
sound.changeGainTo(0)    // Muted
sound.changeGainTo(1)    // Full volume

Inherited from

BaseSound.changeGainTo

---

changePanTo()

changePanTo(value): this

Defined in: base-sound.ts:730

Set the pan position immediately.

Convenience method for update('pan').to(value).as('ratio').

Parameters

value

number

Pan position from -1 (left) to 1 (right), 0 is center

Returns

this

this for chaining

Example

sound.changePanTo(-1)  // Hard left
sound.changePanTo(0)   // Center
sound.changePanTo(1)   // Hard right

Inherited from

BaseSound.changePanTo

---

emit()

protected emit<K>(type, detail): void

Defined in: base-sound.ts:606

Emit a typed event with the given detail.

Type Parameters

K

K extends keyof SoundEventMap

Parameters

type

K

The event type to emit

detail

SoundEventMap[K]["detail"]

The event detail object

Returns

void

Inherited from

BaseSound.emit

---

getAnalyzer()

getAnalyzer(): Analyzer | null

Defined in: base-sound.ts:521

Get the currently attached analyzer, if any.

Returns

Analyzer | null

The attached Analyzer instance, or null if none attached

Inherited from

BaseSound.getAnalyzer

---

getEffects()

getEffects(): readonly Effect[]

Defined in: base-sound.ts:457

Get a readonly copy of the current effects array.

Returns

readonly Effect[]

Shallow copy of the effects array

Inherited from

BaseSound.getEffects

---

getGainNode()

getGainNode(): GainNode

Defined in: base-sound.ts:540

Get the GainNode for this sound.

Provides controlled access to the underlying GainNode for advanced audio routing scenarios (e.g., crossfading between tracks). For simple volume control, use changeGainTo() or update('gain').

Returns

GainNode

The GainNode controlling this sound's volume

Example

const node = sound.getGainNode()
node.gain.linearRampToValueAtTime(0, ctx.currentTime + 2)

Inherited from

BaseSound.getGainNode

---

later()

protected later(fn): void

Defined in: base-sound.ts:1098

Parameters

fn

() => void

Returns

void

Inherited from

BaseSound.later

---

off()

off<K>(type, listener): this

Defined in: base-sound.ts:681

Unsubscribe from an event.

Note: Due to native EventTarget limitations, you must provide the same listener function reference that was used when subscribing. To remove listeners, store the function reference when adding it.

Type Parameters

K

K extends keyof SoundEventMap

Parameters

type

K

The event type to unsubscribe from

listener

(event) => void

The event handler function to remove

Returns

this

this for chaining

Example

const handler = (e) => console.log(e.detail);
sound.on('play', handler);
// later...
sound.off('play', handler);

Inherited from

BaseSound.off

---

on()

on<K>(type, listener): this

Defined in: base-sound.ts:629

Subscribe to one or more events. Supports chaining.

Type Parameters

K

K extends keyof SoundEventMap

Parameters

type

The event type(s) to subscribe to

K | K[]

listener

(event) => void

The event handler function

Returns

this

this for chaining

Example

sound.on('play', handlePlay).on('stop', handleStop);
sound.on(['play', 'stop'], handleBoth);

Inherited from

BaseSound.on

---

once()

once<K>(type, listener): this

Defined in: base-sound.ts:654

Subscribe to an event once. Handler is removed after first invocation.

Type Parameters

K

K extends keyof SoundEventMap

Parameters

type

K

The event type to subscribe to

listener

(event) => void

The event handler function

Returns

this

this for chaining

Example

sound.once('end', () => console.log('Playback finished'));

Inherited from

BaseSound.once

---

onPlayRamp()

onPlayRamp(type, rampType?): object

Defined in: base-sound.ts:812

Schedule a parameter ramp when play() is called.

Use this for smooth transitions like vibrato, tremolo, or automation.

Parameters

type

ControlType

The parameter to ramp ('gain' or 'pan')

rampType?

RampType

Type of ramp curve ('linear' or 'exponential')

Returns

object

Fluent builder for setting start value, end value, and duration

from()

from: (startValue) => object

Parameters

startValue

number

Returns

object

to()

to: (endValue) => object

Parameters

endValue

number

Returns

object

in()

in: (endTime) => void

Parameters

endTime

number

Returns

void

Example

// Fade out over 2 seconds
sound.onPlayRamp('gain', 'linear').from(1).to(0).in(2)
sound.play()

// Pan sweep from left to right over 4 seconds
sound.onPlayRamp('pan', 'linear').from(-1).to(1).in(4)
sound.play()

Inherited from

BaseSound.onPlayRamp

---

onPlaySet()

onPlaySet(type): object

Defined in: base-sound.ts:783

Schedule a parameter value to be set when play() is called.

Use this for fade-ins, fade-outs, or precise parameter timing. The value is applied relative to when play() is called.

Parameters

type

ControlType

The parameter to control ('gain' or 'pan')

Returns

object

Fluent builder for setting value and timing

to()

to: (value) => object

Parameters

value

number

Returns

object

at()

at: (time) => void

Parameters

time

number

Returns

void

endingAt()

endingAt: (time, rampType?) => void

Parameters

time

number

rampType?

RampType

Returns

void

Example

// Fade in: start at 0, ramp to 1 over 0.5 seconds
sound.onPlaySet('gain').to(0).at(0)
sound.onPlaySet('gain').to(1).endingAt(0.5, 'linear')
sound.play()

// Start panned left, move to center over 2 seconds
sound.onPlaySet('pan').to(-1).at(0)
sound.onPlaySet('pan').to(0).endingAt(2, 'linear')
sound.play()

Inherited from

BaseSound.onPlaySet

---

play()

play(): Promise<void>

Defined in: base-sound.ts:837

Play the sound immediately.

Resumes the AudioContext if suspended, sets up the audio source, and starts playback. For finite-duration sounds (Sound, Track), automatically schedules an 'end' event when playback completes.

Returns

Promise<void>

Promise that resolves when playback begins

Example

const sound = await createSound('click.mp3')
await sound.play()

Inherited from

BaseSound.play

---

playAt()

playAt(time): Promise<void>

Defined in: base-sound.ts:913

Play the audio source at a specific time.

This is the underlying method for all play variants. Time is measured in seconds from when the AudioContext was created (audioContext.currentTime).

Parameters

time

number

The AudioContext time when playback should start

Returns

Promise<void>

Example

// Play immediately
sound.playAt(audioContext.currentTime)

// Play in 2 seconds
sound.playAt(audioContext.currentTime + 2)

// Sync multiple sounds
const startTime = audioContext.currentTime + 0.1
sound1.playAt(startTime)
sound2.playAt(startTime)

Inherited from

BaseSound.playAt

---

playFor()

playFor(duration): void

Defined in: base-sound.ts:867

Play for a specific duration, then stop automatically.

Parameters

duration

number

Seconds of playback before stopping

Returns

void

Example

// Play for 3 seconds
sound.playFor(3)

Inherited from

BaseSound.playFor

---

playIn()

playIn(when): void

Defined in: base-sound.ts:852

Schedule playback after a delay.

Parameters

when

number

Seconds from now until playback starts

Returns

void

Example

// Play in 2 seconds
sound.playIn(2)

Inherited from

BaseSound.playIn

---

playInAndStopAfter()

playInAndStopAfter(playIn, stopAfter): void

Defined in: base-sound.ts:886

Play after a delay, then stop after a duration.

Combines playIn() and stopIn() for precise timed playback.

Parameters

playIn

number

Seconds from now until playback starts

stopAfter

number

Seconds of playback before stopping (from play start)

Returns

void

Example

// Start in 1 second, play for 3 seconds
sound.playInAndStopAfter(1, 3)

Inherited from

BaseSound.playInAndStopAfter

---

removeEffect()

removeEffect(effect): this

Defined in: base-sound.ts:378

Remove an effect from the effect chain.

Parameters

effect

Effect

The Effect instance to remove

Returns

this

this for chaining

Example

sound.removeEffect(filter)

Inherited from

BaseSound.removeEffect

---

removeEventListener()

Call Signature

removeEventListener<K>(type, listener, options?): void

Defined in: base-sound.ts:582

Remove a typed event listener for sound lifecycle events. Overloaded to provide type safety for known event types while remaining compatible with EventTarget.

Type Parameters

K

K extends keyof SoundEventMap

Parameters

type

K

The event type ('play', 'stop', 'end', etc.)

listener

(event) => void

The event handler function to remove

options?

Standard removeEventListener options

boolean | EventListenerOptions

Returns

void

Inherited from

BaseSound.removeEventListener

Call Signature

removeEventListener(type, listener, options?): void

Defined in: base-sound.ts:587

Remove a typed event listener for sound lifecycle events. Overloaded to provide type safety for known event types while remaining compatible with EventTarget.

Parameters

type

string

The event type ('play', 'stop', 'end', etc.)

listener

The event handler function to remove

EventListenerOrEventListenerObject | null

options?

Standard removeEventListener options

boolean | EventListenerOptions

Returns

void

Inherited from

BaseSound.removeEventListener

---

rewireEffects()

rewireEffects(): void

Defined in: base-sound.ts:483

Re-wire the effect chain. Call this after toggling effect.bypass to update the audio routing.

Returns

void

Inherited from

BaseSound.rewireEffects

---

setAnalyzer()

setAnalyzer(analyzer): this

Defined in: base-sound.ts:510

Attach an analyzer to this sound for visualization. The analyzer is inserted at the end of the signal chain (after effects and panner, before destination), showing the fully processed signal.

The analyzer is a passthrough node - audio flows through it unchanged while providing frequency and waveform data for visualization.

Parameters

analyzer

The Analyzer instance to attach, or null to detach

Analyzer | null

Returns

this

this for chaining

Example

const analyzer = createAnalyzer(audioContext, { fftSize: 2048 })
sound.setAnalyzer(analyzer)

function draw() {
  const freqData = analyzer.getFrequencyData()
  // Draw frequency bars
  requestAnimationFrame(draw)
}

Inherited from

BaseSound.setAnalyzer

---

setDestination()

setDestination(node): this

Defined in: base-sound.ts:473

Set a custom destination for audio output instead of audioContext.destination. Useful for routing to sub-mixes, analyzers, or other processing chains.

Parameters

node

AudioNode

The AudioNode to route output to

Returns

this

this for chaining

Example

const analyzer = audioContext.createAnalyser()
analyzer.connect(audioContext.destination)
sound.setDestination(analyzer)

Inherited from

BaseSound.setDestination

---

setup()

protected setup(): void

Defined in: sound.ts:65

Set up a new AudioBufferSourceNode for playback. Called automatically before each play() - creates fresh source nodes since AudioBufferSourceNode is single-use.

Returns

void

Overrides

BaseSound.setup

---

stop()

stop(): Promise<void>

Defined in: base-sound.ts:1068

Stop the sound immediately.

Emits a 'stop' event. Safe to call when not playing (no-op).

Returns

Promise<void>

Promise that resolves when the stop is processed

Example

await sound.stop()

Inherited from

BaseSound.stop

---

stopAt()

stopAt(time): Promise<void>

Defined in: base-sound.ts:1023

Stop the audio source at a specific time.

This is the underlying method for all stop variants. Time is measured in seconds from when the AudioContext was created (audioContext.currentTime).

Parameters

time

number

The AudioContext time when playback should stop

Returns

Promise<void>

Example

// Stop immediately
sound.stopAt(audioContext.currentTime)

// Stop in 5 seconds
sound.stopAt(audioContext.currentTime + 5)

Inherited from

BaseSound.stopAt

---

stopIn()

stopIn(seconds): Promise<void>

Defined in: base-sound.ts:1002

Stop the audio source after a delay.

Parameters

seconds

number

Seconds from now until playback stops

Returns

Promise<void>

Example

sound.play()
// Stop after 5 seconds
sound.stopIn(5)

Inherited from

BaseSound.stopIn

---

update()

update(type): object

Defined in: base-sound.ts:707

Update an audio parameter immediately.

Returns a fluent builder for setting the parameter value. Use .to(value) to set the value, then .as(unit) for unit interpretation.

Parameters

type

ControlType

The parameter to update ('gain' or 'pan')

Returns

object

Fluent builder for setting the value

to()

to: (value) => object

Parameters

value

number

Returns

object

as()

as: (method) => void

Parameters

method

RatioType

Returns

void

Example

// Set gain to 50%
sound.update('gain').to(0.5).as('ratio')

// Set pan to left
sound.update('pan').to(-1).as('ratio')

Inherited from

BaseSound.update

---

wireConnections()

protected wireConnections(): void

Defined in: sound.ts:102

Wire audio source to the effect chain input.

Returns

void

Overrides

BaseSound.wireConnections