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 _stereoPan _threeDOptions _volume context globalGainNode panType playbacks soundType

Accessors

detune filters frequency isPlaying oscillatorOptions position stereoPan threeDOptions type volume

Methods

addFilter addFilters applyFilters clone pause play preplay removeFilter removeFilters stop

Constructors

constructor

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

  • Parameters

    • context: IAudioContext
    • globalGainNode: GainNode
    • soundType: SoundType = SoundType.Oscillator
    • panType: PanType = "HRTF"
    • oscillatorOptions: Partial<OscillatorOptions> = {}

    Returns Synth

Properties

_filters

_filters: BiquadFilterNode[] = []

_oscillatorOptions

_oscillatorOptions: Partial<OscillatorOptions>

_position

_position: Position = ...

_stereoPan

_stereoPan: number = 0

_threeDOptions

_threeDOptions: PannerOptions = ...

_volume

_volume: number = 1

context

context: IAudioContext

Private globalGainNode

globalGainNode: GainNode

panType

panType: PanType = "HRTF"

playbacks

playbacks: SynthPlayback[] = []

soundType

soundType: SoundType = SoundType.Oscillator

Accessors

detune

  • get detune(): number

  • Returns number

  • set detune(detune): void

  • Parameters

    • detune: number

    Returns void

filters

  • get filters(): BiquadFilterNode[]

  • Returns BiquadFilterNode[]

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

    True if the object is playing, false otherwise.

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

    The current position of the sound.

  • 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

    • position: Position

      The new position of the sound.

    Returns void

stereoPan

  • get stereoPan(): null | number

  • Returns null | number

  • set stereoPan(value): void

  • Parameters

    • value: number

    Returns void

threeDOptions

  • get threeDOptions(): PannerOptions

  • Returns PannerOptions

  • set threeDOptions(options): void

  • Parameters

    • options: Partial<PannerOptions>

    Returns void

type

  • get type(): OscillatorType

  • Returns OscillatorType

  • set type(type): void

  • Parameters

    • type: OscillatorType

    Returns void

volume

  • get volume(): number

  • Gets the volume of the sound. This volume level affects all current and future playbacks of this sound instance. The volume is specified as a linear value between 0 (silent) and 1 (full volume).

    Returns number

    The current volume of the sound.

  • set volume(volume): void

  • Sets the volume of the sound. This volume level affects all current and future playbacks of this sound instance. The volume is specified as a linear value between 0 (silent) and 1 (full volume).

    Parameters

    • volume: number

      The new volume level for the sound.

    Returns void

Methods

addFilter

  • addFilter(filter): void

  • Adds a BiquadFilterNode to the container's filter chain. Filters are applied in the order they are added.

    Parameters

    • filter: BiquadFilterNode

      The filter to add to the chain.

    Returns void

addFilters

  • addFilters(filters): void

  • Parameters

    • filters: BiquadFilterNode[]

    Returns void

applyFilters

  • applyFilters(connection): any

  • Parameters

    • connection: any

    Returns any

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

    A new Sound instance that is a clone of the current sound.

pause

  • pause(): void

  • Pauses all current playbacks of the sound.

    Returns void

play

  • play(): BasePlayback[]

  • Starts playback of the sound and returns a Playback instance representing this particular playback. Multiple Playback instances can be created by calling this method multiple times, allowing for the same sound to be played concurrently with different settings.

    Returns BasePlayback[]

    An array containing the Playback instances that have been started.

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[]

    An array of SynthPlayback instances that are ready to be played.

removeFilter

  • removeFilter(filter): void

  • Removes a BiquadFilterNode from the container's filter chain. If the filter is not part of the chain, the method has no effect.

    Parameters

    • filter: BiquadFilterNode

      The filter to remove from the chain.

    Returns void

removeFilters

  • removeFilters(filters): void

  • Parameters

    • filters: BiquadFilterNode[]

    Returns void

stop

  • stop(): void

  • Stops all current playbacks of the sound immediately. This will halt the sound regardless of how many times it has been played.

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor_filters_oscillatorOptions_position_stereoPan_threeDOptions_volumecontextglobalGainNodepanTypeplaybackssoundTypedetunefiltersfrequencyisPlayingoscillatorOptionspositionstereoPanthreeDOptionstypevolumeaddFilteraddFiltersapplyFiltersclonepauseplaypreplayremoveFilterremoveFiltersstop