EZ Web Audio

Appearance

EZ Web Audio / SampledNote

Class: SampledNote ​

Defined in: sampled-note.ts:30

A Sound with musical identity.

SampledNote extends Sound with musical properties (letter, accidental, octave, frequency) via the MusicallyAware mixin. Used in Font collections where each sound represents a specific musical note.

Example ​

typescript
import { createFont } from 'ez-web-audio'

// SampledNote is typically created via createFont(), not directly
const piano = await createFont('piano.js')
const noteA4 = piano.getNote('A4')

// Access musical properties
console.log(noteA4?.frequency)   // 440
console.log(noteA4?.identifier)  // "A4"
console.log(noteA4?.letter)      // "A"
console.log(noteA4?.octave)      // "4"

// Use Sound methods
noteA4?.changeGainTo(0.5)
noteA4?.play()

Extends ​

Indexable ​

[key: string]: any

Constructors ​

Constructor ​

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

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 ​

SampledNote

Inherited from ​

MusicallyAware(Sound).constructor

Properties ​

_analyzer ​

protected _analyzer: Analyzer | null = null

Defined in: base-sound.ts:114

Inherited from ​

MusicallyAware(Sound)._analyzer

_destination ​

protected _destination: AudioNode

Defined in: base-sound.ts:107

Inherited from ​

MusicallyAware(Sound)._destination

_isPlaying ​

protected _isPlaying: boolean = false

Defined in: base-sound.ts:70

Inherited from ​

MusicallyAware(Sound)._isPlaying

accidental ​

accidental: Accidental = ''

Defined in: musical-identity.ts:92

The accidental: "" (natural), "b" (flat), or "#" (sharp). For note "Ab5", this would be "b".

Inherited from ​

MusicallyAware(Sound).accidental

audioContext ​

audioContext: AudioContext

Defined in: base-sound.ts:165

Inherited from ​

MusicallyAware(Sound).audioContext

audioSourceNode ​

audioSourceNode: AudioBufferSourceNode

Defined in: sound.ts:34

The underlying AudioBufferSourceNode that plays the audio.

Inherited from ​

MusicallyAware(Sound).audioSourceNode

controller ​

protected controller: SoundController

Defined in: sound.ts:37

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

Inherited from ​

MusicallyAware(Sound).controller

debug? ​

optional debug: boolean

Defined in: base-sound.ts:163

Default ​

ts
undefined (follows global debug mode)

Example ​

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

Inherited from ​

MusicallyAware(Sound).debug

effectChainInput ​

protected effectChainInput: GainNode

Defined in: base-sound.ts:100

Inherited from ​

MusicallyAware(Sound).effectChainInput

effects ​

protected effects: Effect[] = []

Defined in: base-sound.ts:93

Inherited from ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).gainNode

letter ​

letter: NoteLetter = 'A'

Defined in: musical-identity.ts:86

The note letter (A-G). For note "Ab5", this would be "A".

Inherited from ​

MusicallyAware(Sound).letter

name ​

name: string

Defined in: musical-identity.ts:103

Inherited from ​

Note.name

octave ​

octave: Octave = '0'

Defined in: musical-identity.ts:97

The octave (0-8). For note "Ab5", this would be "5".

Inherited from ​

MusicallyAware(Sound).octave

pannerNode ​

protected pannerNode: StereoPannerNode

Defined in: base-sound.ts:80

Inherited from ​

MusicallyAware(Sound).pannerNode

setTimeout() ​

protected setTimeout: (fn, delayMillis) => number

Defined in: base-sound.ts:81

Parameters ​

fn ​

() => void

delayMillis ​

number

Returns ​

number

Inherited from ​

MusicallyAware(Sound).setTimeout

startedPlayingAt ​

protected startedPlayingAt: number = 0

Defined in: base-sound.ts:82

Inherited from ​

MusicallyAware(Sound).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 ​

ts
0

See ​

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

Inherited from ​

MusicallyAware(Sound).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 ​
typescript
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

Inherited from ​

MusicallyAware(Sound).duration

frequency ​

Get Signature ​

get frequency(): number

Defined in: musical-identity.ts:126

The frequency of the note in hertz.

Computed from the note identifier using standard piano frequencies. Setting this value updates all other properties to match.

Example ​
typescript
note.frequency = 440 // Sets to A4
console.log(note.identifier) // "A4"
Returns ​

number

Set Signature ​

set frequency(value): void

Defined in: musical-identity.ts:134

Parameters ​
value ​

number

Returns ​

void

Inherited from ​

MusicallyAware(Sound).frequency

identifier ​

Get Signature ​

get identifier(): "C0" | "Db0" | "D0" | "Eb0" | "E0" | "F0" | "Gb0" | "G0" | "Ab0" | "A0" | "Bb0" | "B0" | "C1" | "Db1" | "D1" | "Eb1" | "E1" | "F1" | "Gb1" | "G1" | "Ab1" | "A1" | "Bb1" | "B1" | "C2" | "Db2" | "D2" | "Eb2" | "E2" | "F2" | "Gb2" | "G2" | "Ab2" | "A2" | "Bb2" | "B2" | "C3" | "Db3" | "D3" | "Eb3" | "E3" | "F3" | "Gb3" | "G3" | "Ab3" | "A3" | "Bb3" | "B3" | "C4" | "Db4" | "D4" | "Eb4" | "E4" | "F4" | "Gb4" | "G4" | "Ab4" | "A4" | "Bb4" | "B4" | "C5" | "Db5" | "D5" | "Eb5" | "E5" | "F5" | "Gb5" | "G5" | "Ab5" | "A5" | "Bb5" | "B5" | "C6" | "Db6" | "D6" | "Eb6" | "E6" | "F6" | "Gb6" | "G6" | "Ab6" | "A6" | "Bb6" | "B6" | "C7" | "Db7" | "D7" | "Eb7" | "E7" | "F7" | "Gb7" | "G7" | "Ab7" | "A7" | "Bb7" | "B7" | "C8" | "Db8" | "D8" | "Eb8"

Defined in: musical-identity.ts:158

The full note identifier (e.g., "A4", "Bb3", "C#5").

Computed from letter, accidental, and octave. Setting this value updates all other properties to match.

Example ​
typescript
note.identifier = 'Bb3'
console.log(note.letter)     // "B"
console.log(note.accidental) // "b"
console.log(note.octave)     // "3"
console.log(note.frequency)  // 233.08
Returns ​

"C0" | "Db0" | "D0" | "Eb0" | "E0" | "F0" | "Gb0" | "G0" | "Ab0" | "A0" | "Bb0" | "B0" | "C1" | "Db1" | "D1" | "Eb1" | "E1" | "F1" | "Gb1" | "G1" | "Ab1" | "A1" | "Bb1" | "B1" | "C2" | "Db2" | "D2" | "Eb2" | "E2" | "F2" | "Gb2" | "G2" | "Ab2" | "A2" | "Bb2" | "B2" | "C3" | "Db3" | "D3" | "Eb3" | "E3" | "F3" | "Gb3" | "G3" | "Ab3" | "A3" | "Bb3" | "B3" | "C4" | "Db4" | "D4" | "Eb4" | "E4" | "F4" | "Gb4" | "G4" | "Ab4" | "A4" | "Bb4" | "B4" | "C5" | "Db5" | "D5" | "Eb5" | "E5" | "F5" | "Gb5" | "G5" | "Ab5" | "A5" | "Bb5" | "B5" | "C6" | "Db6" | "D6" | "Eb6" | "E6" | "F6" | "Gb6" | "G6" | "Ab6" | "A6" | "Bb6" | "B6" | "C7" | "Db7" | "D7" | "Eb7" | "E7" | "F7" | "Gb7" | "G7" | "Ab7" | "A7" | "Bb7" | "B7" | "C8" | "Db8" | "D8" | "Eb8"

Set Signature ​

set identifier(value): void

Defined in: musical-identity.ts:180

Parameters ​
value ​

"C0" | "Db0" | "D0" | "Eb0" | "E0" | "F0" | "Gb0" | "G0" | "Ab0" | "A0" | "Bb0" | "B0" | "C1" | "Db1" | "D1" | "Eb1" | "E1" | "F1" | "Gb1" | "G1" | "Ab1" | "A1" | "Bb1" | "B1" | "C2" | "Db2" | "D2" | "Eb2" | "E2" | "F2" | "Gb2" | "G2" | "Ab2" | "A2" | "Bb2" | "B2" | "C3" | "Db3" | "D3" | "Eb3" | "E3" | "F3" | "Gb3" | "G3" | "Ab3" | "A3" | "Bb3" | "B3" | "C4" | "Db4" | "D4" | "Eb4" | "E4" | "F4" | "Gb4" | "G4" | "Ab4" | "A4" | "Bb4" | "B4" | "C5" | "Db5" | "D5" | "Eb5" | "E5" | "F5" | "Gb5" | "G5" | "Ab5" | "A5" | "Bb5" | "B5" | "C6" | "Db6" | "D6" | "Eb6" | "E6" | "F6" | "Gb6" | "G6" | "Ab6" | "A6" | "Bb6" | "B6" | "C7" | "Db7" | "D7" | "Eb7" | "E7" | "F7" | "Gb7" | "G7" | "Ab7" | "A7" | "Bb7" | "B7" | "C8" | "Db8" | "D8" | "Eb8"

Returns ​

void

Inherited from ​

MusicallyAware(Sound).identifier

isPlaying ​

Get Signature ​

get isPlaying(): boolean

Defined in: base-sound.ts:1082

Whether the sound is currently playing.

Example ​
typescript
if (sound.isPlaying) {
  await sound.stop()
}
Returns ​

boolean

Inherited from ​

MusicallyAware(Sound).isPlaying

percentGain ​

Get Signature ​

get percentGain(): number

Defined in: base-sound.ts:1094

Current gain as a percentage (0-100).

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

number

Inherited from ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound)._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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).getGainNode

later() ​

protected later(fn): void

Defined in: base-sound.ts:1098

Parameters ​

fn ​

() => void

Returns ​

void

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

typescript
// 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 ​

MusicallyAware(Sound).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 ​

typescript
// 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 ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

typescript
// 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 ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

ts
sound.removeEffect(filter)

Inherited from ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).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 ​

MusicallyAware(Sound).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 ​

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

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

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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

Inherited from ​

MusicallyAware(Sound).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 ​

typescript
await sound.stop()

Inherited from ​

MusicallyAware(Sound).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 ​

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

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

Inherited from ​

MusicallyAware(Sound).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 ​

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

Inherited from ​

MusicallyAware(Sound).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 ​

typescript
// 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 ​

MusicallyAware(Sound).update

wireConnections() ​

protected wireConnections(): void

Defined in: sound.ts:102

Wire audio source to the effect chain input.

Returns ​

void

Inherited from ​

MusicallyAware(Sound).wireConnections