Class Synth

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

Hierarchy

RoutableSource
- Synth

Implements

BaseSound

Constructors

constructor

new Synth(
    context: BaseContext,
    globalGainNode: GainNode,
    soundType?: SoundType,
    panType?: PanType,
    oscillatorOptions?: Partial<OscillatorOptions>,
    _cacophony?: Cacophony,
): Synth
Parameters
- context: BaseContext
- globalGainNode: GainNode
- soundType: SoundType = "oscillator"
- panType: PanType = "HRTF"
- oscillatorOptions: Partial<OscillatorOptions> = {}
- Optional_cacophony: Cacophony
Returns Synth
Overrides RoutableSource.constructor
- Defined in src/synth.ts:41

Properties

_filters

_filters: BiquadFilterNode[] = []

_oscillatorOptions

_oscillatorOptions: Partial<OscillatorOptions>

_position

_position: Position

`Protected`_routeTarget

_routeTarget: Bus | null = null

Primary route target. null is the canonical master route.

`Protected`_sends

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

Additional send target to gain-value mappings.

_stereoPan

_stereoPan: number

_threeDOptions

_threeDOptions: ThreeDOptions

_volume

_volume: number

context

context: BaseContext

`Protected`globalGainNode

globalGainNode: GainNode

panType

panType: PanType = "HRTF"

playbacks

playbacks: SynthPlayback[] = []

soundType

soundType: SoundType = "oscillator"

Accessors

cacophony

get cacophony(): Cacophony | undefined
Returns Cacophony | undefined
Overrides RoutableSource.cacophony
- Defined in src/synth.ts:54

detune

get detune(): number
Returns number
- Defined in src/synth.ts:192
set detune(detune: number): void
Parameters
- detune: number
Returns void
- Defined in src/synth.ts:196

filters

get filters(): BiquadFilterNode[]
Returns BiquadFilterNode[]
Inherited from RoutableSource.filters
- Defined in src/filters.ts:38

frequency

get frequency(): number
Returns number
- Defined in src/synth.ts:182
set frequency(frequency: number): void
Parameters
- frequency: number
Returns void
- Defined in src/synth.ts:186

isPlaying

get isPlaying(): boolean
Returns boolean
Implementation of BaseSound.isPlaying

Inherited from RoutableSource.isPlaying
- Defined in src/container.ts:56

oscillatorOptions

get oscillatorOptions(): Partial<OscillatorOptions>
Returns Partial<OscillatorOptions>
- Defined in src/synth.ts:167
set oscillatorOptions(options: Partial<OscillatorOptions>): void
Parameters
- options: Partial<OscillatorOptions>
Returns void
- Defined in src/synth.ts:171

position

get position(): Position
Returns Position
Implementation of BaseSound.position

Inherited from RoutableSource.position
- Defined in src/container.ts:57
set position(position: Position): void
Parameters
- position: Position
Returns void
Implementation of BaseSound.position

Inherited from RoutableSource.position
- Defined in src/container.ts:58

stereoPan

get stereoPan(): number
Returns number
Inherited from RoutableSource.stereoPan
- Defined in src/container.ts:61
set stereoPan(value: number): void
Parameters
- value: number
Returns void
Inherited from RoutableSource.stereoPan
- Defined in src/container.ts:62

threeDOptions

get threeDOptions(): ThreeDOptions
Returns ThreeDOptions
Implementation of BaseSound.threeDOptions

Inherited from RoutableSource.threeDOptions
- Defined in src/container.ts:59
set threeDOptions(options: ThreeDOptions | Partial<HrtfPannerOptions>): void
Parameters
- options: ThreeDOptions | Partial<HrtfPannerOptions>
Returns void
Implementation of BaseSound.threeDOptions

Inherited from RoutableSource.threeDOptions
- Defined in src/container.ts:60

type

get type(): OscillatorType
Returns OscillatorType
- Defined in src/synth.ts:202
set type(type: OscillatorType): void
Parameters
- type: OscillatorType
Returns void
- Defined in src/synth.ts:206

volume

get volume(): number
Returns number
Implementation of BaseSound.volume

Overrides RoutableSource.volume
- Defined in src/synth.ts:158
set volume(volume: number): void
Parameters
- volume: number
Returns void
Implementation of BaseSound.volume

Overrides RoutableSource.volume
- Defined in src/synth.ts:162

Methods

_onBusDrained

_onBusDrained(bus: Bus, target: Bus): void
Called by Bus.drainTo to move this source off the draining bus onto target. The source reroutes its primary route and/or any send that targeted bus.
Parameters
- bus: Bus
- target: Bus
Returns void
Inherited from RoutableSource._onBusDrained
- Defined in src/routableSource.ts:205

`Protected`_preparePlayback

_preparePlayback(playback: BasePlayback): void
Materialize all declared recipes, then establish this playback's sends.
Parameters
- playback: BasePlayback
Returns void
Inherited from RoutableSource._preparePlayback
- Defined in src/routableSource.ts:125

_resolveRouteTargetNode

_resolveRouteTargetNode(): GainNode
Resolve the node used by future playbacks for their primary output. Sources left on a subsequently destroyed bus fall back to master.

Returns GainNode
Inherited from RoutableSource._resolveRouteTargetNode
- Defined in src/routableSource.ts:93

`Protected`_wireRouteSends

_wireRouteSends(playback: BasePlayback): void
Establish every configured send on a newly created playback.
Parameters
- playback: BasePlayback
Returns void
Inherited from RoutableSource._wireRouteSends
- Defined in src/routableSource.ts:109

addEffect

addEffect(effect: CacophonyEffect): void
Parameters
- effect: CacophonyEffect
Returns void
Inherited from RoutableSource.addEffect
- Defined in src/routableSource.ts:32

addFilter

addFilter(filter: BiquadFilterNode): void
Adds a BiquadFilterNode to the filter chain.
Parameters
- filter: BiquadFilterNode
Returns void

Throws
If the same filter instance is added twice.
Implementation of BaseSound.addFilter

Inherited from RoutableSource.addFilter
- Defined in src/routableSource.ts:47

addFilters

addFilters(filters: BiquadFilterNode[]): void
Parameters
- filters: BiquadFilterNode[]
Returns void
Inherited from RoutableSource.addFilters
- Defined in src/filters.ts:42

cleanup

cleanup(): void
Returns void
Inherited from RoutableSource.cleanup
- Defined in src/routableSource.ts:229

clone

clone(overrides?: Partial<SynthCloneOverrides>): 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
- Defined in src/synth.ts:69

`Protected`emit

emit<
    K extends
        | "play"
        | "stop"
        | "pause"
        | "resume"
        | "ended"
        | "volumeChange"
        | "error"
        | "fadeStart"
        | "fadeEnd"
        | "fadeCancel"
        | "frequencyChange"
        | "typeChange"
        | "detuneChange",
>(
    event: K,
    data: SynthEvents[K],
): void
Type Parameters
- K extends
      | "play"
      | "stop"
      | "pause"
      | "resume"
      | "ended"
      | "volumeChange"
      | "error"
      | "fadeStart"
      | "fadeEnd"
      | "fadeCancel"
      | "frequencyChange"
      | "typeChange"
      | "detuneChange"
Parameters
- event: K
- data: SynthEvents[K]
Returns void
- Defined in src/synth.ts:33

`Protected`emitAsync

emitAsync<
    K extends
        | "play"
        | "stop"
        | "pause"
        | "resume"
        | "ended"
        | "volumeChange"
        | "error"
        | "fadeStart"
        | "fadeEnd"
        | "fadeCancel"
        | "frequencyChange"
        | "typeChange"
        | "detuneChange",
>(
    event: K,
    data: SynthEvents[K],
): Promise<void>
Type Parameters
- K extends
      | "play"
      | "stop"
      | "pause"
      | "resume"
      | "ended"
      | "volumeChange"
      | "error"
      | "fadeStart"
      | "fadeEnd"
      | "fadeCancel"
      | "frequencyChange"
      | "typeChange"
      | "detuneChange"
Parameters
- event: K
- data: SynthEvents[K]
Returns Promise<void>
- Defined in src/synth.ts:37

fadeIn

fadeIn(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Implementation of BaseSound.fadeIn

Inherited from RoutableSource.fadeIn
- Defined in src/container.ts:66

fadeOut

fadeOut(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Implementation of BaseSound.fadeOut

Inherited from RoutableSource.fadeOut
- Defined in src/container.ts:67

fadeTo

fadeTo(value: number, duration: number, type?: FadeType): Promise<void>
Parameters
- value: number
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Implementation of BaseSound.fadeTo

Inherited from RoutableSource.fadeTo
- Defined in src/container.ts:65

off

off<
    K extends
        | "play"
        | "stop"
        | "pause"
        | "resume"
        | "ended"
        | "volumeChange"
        | "error"
        | "fadeStart"
        | "fadeEnd"
        | "fadeCancel"
        | "frequencyChange"
        | "typeChange"
        | "detuneChange",
>(
    event: K,
    listener: (data: SynthEvents[K]) => void,
): void
Remove event listener.
Type Parameters
- K extends
      | "play"
      | "stop"
      | "pause"
      | "resume"
      | "ended"
      | "volumeChange"
      | "error"
      | "fadeStart"
      | "fadeEnd"
      | "fadeCancel"
      | "frequencyChange"
      | "typeChange"
      | "detuneChange"
Parameters
- event: K
- listener: (data: SynthEvents[K]) => void
Returns void
- Defined in src/synth.ts:29

on

on<
    K extends
        | "play"
        | "stop"
        | "pause"
        | "resume"
        | "ended"
        | "volumeChange"
        | "error"
        | "fadeStart"
        | "fadeEnd"
        | "fadeCancel"
        | "frequencyChange"
        | "typeChange"
        | "detuneChange",
>(
    event: K,
    listener: (data: SynthEvents[K]) => void,
): () => void
Register event listener.
Type Parameters
- K extends
      | "play"
      | "stop"
      | "pause"
      | "resume"
      | "ended"
      | "volumeChange"
      | "error"
      | "fadeStart"
      | "fadeEnd"
      | "fadeCancel"
      | "frequencyChange"
      | "typeChange"
      | "detuneChange"
Parameters
- event: K
- listener: (data: SynthEvents[K]) => void
Returns () => void
Cleanup function
- Defined in src/synth.ts:22

pause

pause(): void
Returns void
Implementation of BaseSound.pause

Overrides RoutableSource.pause
- Defined in src/synth.ts:148

play

play(options?: PlayOptions): SynthPlayback[]
Parameters
- Optionaloptions: PlayOptions
Returns SynthPlayback[]
Implementation of BaseSound.play

Overrides RoutableSource.play
- Defined in src/synth.ts:134

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[]
Overrides RoutableSource.preplay
- Defined in src/synth.ts:107

removeEffect

removeEffect(effect: CacophonyEffect): void
Parameters
- effect: CacophonyEffect
Returns void
Inherited from RoutableSource.removeEffect
- Defined in src/routableSource.ts:39

removeFilter

removeFilter(filter: BiquadFilterNode): void
Removes a BiquadFilterNode from the filter chain by object identity.
Parameters
- filter: BiquadFilterNode
Returns void

Throws
If the filter was never added to this container.
Implementation of BaseSound.removeFilter

Inherited from RoutableSource.removeFilter
- Defined in src/routableSource.ts:55

resume

resume(): void
Returns void
- Defined in src/synth.ts:153

routeTo

routeTo(target: string | Bus, sendGain?: number): void
Route this source to a bus, or add an independent send when sendGain is provided.
Parameters
- target: string | Bus
- OptionalsendGain: number
Returns void
Inherited from RoutableSource.routeTo
- Defined in src/routableSource.ts:69

stop

stop(): void
Returns void
Implementation of BaseSound.stop

Overrides RoutableSource.stop
- Defined in src/synth.ts:143

stopWithFade

stopWithFade(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Implementation of BaseSound.stopWithFade

Inherited from RoutableSource.stopWithFade
- Defined in src/container.ts:68

Class Synth

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Synth

Properties

_filters

_oscillatorOptions

_position

Protected_routeTarget

Protected_sends

_stereoPan

_threeDOptions

_volume

context

ProtectedglobalGainNode

panType

playbacks

soundType

Accessors

cacophony

Returns Cacophony | undefined

detune

Returns number

Parameters

Returns void

filters

Returns BiquadFilterNode[]

frequency

Returns number

Parameters

Returns void

isPlaying

Returns boolean

oscillatorOptions

Returns Partial<OscillatorOptions>

Parameters

Returns void

position

Returns Position

Parameters

Returns void

stereoPan

Returns number

Parameters

Returns void

threeDOptions

Returns ThreeDOptions

Parameters

Returns void

type

Returns OscillatorType

Parameters

Returns void

volume

Returns number

Parameters

Returns void

Methods

_onBusDrained

Parameters

Returns void

Protected_preparePlayback

Parameters

Returns void

_resolveRouteTargetNode

Returns GainNode

Protected_wireRouteSends

Parameters

Returns void

addEffect

Parameters

Returns void

`Protected`_routeTarget

`Protected`_sends

`Protected`globalGainNode

`Protected`_preparePlayback

`Protected`_wireRouteSends

`Protected`emit

`Protected`emitAsync