Class Synth

The base interface for any sound-producing entity, including individual sounds, groups, and playbacks. BaseSound

Hierarchy

  • PlaybackContainer<typeof FilterManager, this> & FilterManager<this>
    • Synth

Implements

Constructors

constructor

Properties

_filters _oscillatorOptions _position _routeTarget _sends _stereoPan _threeDOptions _volume cacophony? context eventEmitter globalGainNode panType playbacks soundType

Accessors

detune filters frequency isPlaying oscillatorOptions position stereoPan threeDOptions type volume

Methods

_addSend _onBusDrained _resolveBusArg _resolveRouteTargetNode _setPrimary addFilter addFilters applyFilters cleanup clone createPlayback emit emitAsync fadeIn fadeOut fadeTo off on pause play preplay removeFilter removeFilters resume routeTo stop stopWithFade

Constructors

constructor

  • new Synth(context, globalGainNode, soundType?, panType?, oscillatorOptions?, cacophony?): Synth

  • Parameters

    Returns Synth

Properties

_filters

_filters: BiquadFilterNode[] = []

_oscillatorOptions

_oscillatorOptions: Partial<OscillatorOptions>

_position

_position: Position = ...

Private _routeTarget

_routeTarget: null | Bus = null

Primary route target. null means master. See Sound for full notes.

Private _sends

_sends: Map<Bus, number> = ...

Send target → send gain value. See Sound._sends for notes.

_stereoPan

_stereoPan: number = 0

_threeDOptions

_threeDOptions: ThreeDOptions = ...

Canonical 3D-audio configuration storage. Always holds a fully-populated HRTF variant (ThreeDOptions with panType: "HRTF") so callers reading via the getter never see undefined fields. Setting the stereo variant replaces this with the stereo shape (no stale HRTF fields).

_volume

_volume: number = 1

Private Optional cacophony

cacophony?: Cacophony

context

context: BaseContext

Private eventEmitter

eventEmitter: TypedEventEmitter<SynthEvents> = ...

Private globalGainNode

globalGainNode: GainNode

panType

panType: PanType = "HRTF"

playbacks

playbacks: SynthPlayback[] = []

soundType

soundType: SoundType = "oscillator"

Accessors

detune

filters

frequency

  • get frequency(): number

  • Returns number

  • set frequency(frequency): void

  • Parameters

    • frequency: number

    Returns void

isPlaying

  • get isPlaying(): boolean

  • Returns a boolean indicating whether the object is currently playing. an object is playing if any of its playbacks are currently playing.

    Returns boolean

oscillatorOptions

  • get oscillatorOptions(): Partial<OscillatorOptions>

  • Returns Partial<OscillatorOptions>

  • set oscillatorOptions(options): void

  • Parameters

    • options: Partial<OscillatorOptions>

    Returns void

position

  • get position(): Position

  • Retrieves the current 3D spatial position of the sound in the audio context. The position is returned as an array of three values[x, y, z].

    Returns Position

  • set position(position): void

  • Sets the 3D spatial position of the sound in the audio context. The position is an array of three values[x, y, z]. This method updates the position of all active playbacks of the sound.

    Parameters

    Returns void

stereoPan

  • get stereoPan(): number

  • Returns number

  • set stereoPan(value): void

  • Parameters

    • value: number

    Returns void

threeDOptions

  • get threeDOptions(): ThreeDOptions

  • Returns a fresh copy of the canonical 3D-audio configuration. The clone prevents callers from mutating the container's internal state via the returned reference (previously the raw _threeDOptions object leaked).

    Returns ThreeDOptions

  • set threeDOptions(options): void

  • Accepts either a full canonical ThreeDOptions value, or a partial HRTF-options override (legacy ergonomics). When a partial is provided the existing variant is merged in place — and if the existing variant is stereo, the partial is interpreted as a switch back to HRTF defaults plus the override (no stale stereo fields). When a full variant is provided with a different panType, the storage is replaced wholesale so stale fields from the previous variant cannot be observed via the getter.

    Parameters

    Returns void

type

  • get type(): OscillatorType

  • Returns OscillatorType

  • set type(type): void

  • Parameters

    • type: OscillatorType

    Returns void

volume

  • get volume(): number

  • Returns number

  • set volume(volume): void

  • Parameters

    • volume: number

    Returns void

Methods

Private _addSend

  • _addSend(bus, gainValue): void

  • Parameters

    • bus: Bus
    • gainValue: number

    Returns void

_onBusDrained

  • _onBusDrained(bus, target): void

  • Parameters

    Returns void

Private _resolveBusArg

Private _resolveRouteTargetNode

Private _setPrimary

addFilter

  • addFilter(filter): void

  • Adds a BiquadFilterNode to the container's filter chain. Filters are cloned when creating new playbacks - existing playbacks are not affected. Each playback gets independent filter instances for isolated processing.

    Parameters

    Returns void

addFilters

applyFilters

cleanup

  • cleanup(): void

  • Returns void

clone

  • clone(overrides?): Synth

  • Clones the current Synth instance, creating a deep copy with the option to override specific properties. This method allows for the creation of a new, independent Synth instance based on the current one, with the flexibility to modify certain attributes through the overrides parameter. This is particularly useful for creating variations of a synth without affecting the original instance. The cloned instance includes all properties, playback settings, and filters of the original, unless explicitly overridden.

    Parameters

    • overrides: Partial<SynthCloneOverrides> = {}

      An object specifying properties to override in the cloned instance. This can include audio settings like volume, playback rate, and spatial positioning, as well as more complex configurations like 3D audio options and filter adjustments.

    Returns Synth

Private createPlayback

Protected emit

  • emit<K>(event, data): void

  • Type Parameters

    • K extends "stop" | "play" | "pause" | "resume" | "ended" | "volumeChange" | "error" | "fadeStart" | "fadeEnd" | "fadeCancel" | "frequencyChange" | "typeChange" | "detuneChange"

    Parameters

    Returns void

Protected emitAsync

  • emitAsync<K>(event, data): Promise<void>

  • Type Parameters

    • K extends "stop" | "play" | "pause" | "resume" | "ended" | "volumeChange" | "error" | "fadeStart" | "fadeEnd" | "fadeCancel" | "frequencyChange" | "typeChange" | "detuneChange"

    Parameters

    Returns Promise<void>

fadeIn

  • fadeIn(duration, type?): Promise<void>

  • Fades in all playbacks from silence to their current volume.

    Parameters

    • duration: number

      The fade duration in milliseconds.

    • Optional type: FadeType

      The fade curve type. Defaults to "linear".

    Returns Promise<void>

    Resolves when all fades complete.

fadeOut

  • fadeOut(duration, type?): Promise<void>

  • Fades out all playbacks from their current volume to silence.

    Parameters

    • duration: number

      The fade duration in milliseconds.

    • Optional type: FadeType

      The fade curve type. Defaults to "linear".

    Returns Promise<void>

    Resolves when all fades complete.

fadeTo

  • fadeTo(value, duration, type?): Promise<void>

  • Fades the volume of all playbacks to a target value over a duration.

    Parameters

    • value: number

      The target volume (0 to 1).

    • duration: number

      The fade duration in milliseconds.

    • Optional type: FadeType

      The fade curve type. Defaults to "linear".

    Returns Promise<void>

    Resolves when all fades complete.

off

  • off<K>(event, listener): void

  • Remove event listener.

    Type Parameters

    • K extends "stop" | "play" | "pause" | "resume" | "ended" | "volumeChange" | "error" | "fadeStart" | "fadeEnd" | "fadeCancel" | "frequencyChange" | "typeChange" | "detuneChange"

    Parameters

    • event: K
    • listener: ((data) => void)

    Returns void

on

  • on<K>(event, listener): (() => void)

  • Register event listener.

    Type Parameters

    • K extends "stop" | "play" | "pause" | "resume" | "ended" | "volumeChange" | "error" | "fadeStart" | "fadeEnd" | "fadeCancel" | "frequencyChange" | "typeChange" | "detuneChange"

    Parameters

    • event: K
    • listener: ((data) => void)

    Returns (() => void)

    Cleanup function

      • (): void

      • Returns void

pause

play

  • play(): SynthPlayback[]

  • Returns SynthPlayback[]

preplay

  • preplay(): SynthPlayback[]

  • Generates a Playback instance for the synth without starting playback. This allows for pre-configuration of playback properties such as volume and position before the synth is actually played.

    Returns SynthPlayback[]

removeFilter

  • removeFilter(filter): void

  • Removes a BiquadFilterNode from the container's filter chain. Only affects future playbacks - existing playbacks retain their cloned filters.

    Parameters

    Returns void

    Throws

    If the filter was never added to this container.

removeFilters

  • removeFilters(filters): void

  • Parameters

    Returns void

resume

routeTo

  • routeTo(target, sendGain?): void

  • Routes this Synth to a Bus (or back to master). See Sound.routeTo for full semantics — Synth mirrors the behavior exactly.

    Parameters

    • target: string | Bus
    • Optional sendGain: number

    Returns void

stop

stopWithFade

  • stopWithFade(duration, type?): Promise<void>

  • Fades out all playbacks then stops them.

    Parameters

    • duration: number

      The fade-out duration in milliseconds.

    • Optional type: FadeType

      The fade curve type. Defaults to "linear".

    Returns Promise<void>

    Resolves when the fade completes and all playbacks are stopped.

Settings

Member Visibility

Theme

On This Page

constructor_filters_oscillatorOptions_position_routeTarget_sends_stereoPan_threeDOptions_volumecacophonycontexteventEmitterglobalGainNodepanTypeplaybackssoundTypedetunefiltersfrequencyisPlayingoscillatorOptionspositionstereoPanthreeDOptionstypevolume_addSend_onBusDrained_resolveBusArg_resolveRouteTargetNode_setPrimaryaddFilteraddFiltersapplyFilterscleanupclonecreatePlaybackemitemitAsyncfadeInfadeOutfadeTooffonpauseplaypreplayremoveFilterremoveFiltersresumerouteTostopstopWithFade