Class UnisonOscillator

A group of oscillators playing in unison slightly spread in frequency.

Hierarchy

Constructors

constructor

Properties

_gain _mus _spread context mode voices

Accessors

channelCount channelCountMode channelInterpretation detune frequency numberOfInputs numberOfOutputs numberOfVoices onended spread type

Methods

addEventListener connect disconnect dispatchEvent dispose removeEventListener setPeriodicWave start stop

Constructors

constructor

Properties

Protected _gain

_gain: GainNode

Private _mus

_mus: GainNode[]

Private _spread

_spread: ConstantSourceNode

context

context: BaseAudioContext

Private mode

mode: "detune" | "frequency"

voices

voices: OscillatorNode[]

Accessors

channelCount

  • get channelCount(): number

  • Returns number

channelCountMode

  • get channelCountMode(): ChannelCountMode

  • Returns ChannelCountMode

channelInterpretation

  • get channelInterpretation(): ChannelInterpretation

  • Returns ChannelInterpretation

detune

  • get detune(): AudioParam

  • An a-rate AudioParam representing detuning of oscillation in cents (though the AudioParam returned is read-only, the value it represents is not). The default value is 0.

    Returns AudioParam

frequency

  • get frequency(): AudioParam

  • An a-rate AudioParam representing the frequency of oscillation in hertz (though the AudioParam returned is read-only, the value it represents is not). The default value is 440 Hz (a standard middle-A note).

    Returns AudioParam

numberOfInputs

  • get numberOfInputs(): number

  • Returns number

numberOfOutputs

  • get numberOfOutputs(): number

  • Returns number

numberOfVoices

  • set numberOfVoices(newValue): void

  • Set the number of voices in this MultiOscillator group. Allocates and auto-connects new voices as necessary.

    Parameters

    • newValue: number

    Returns void

onended

  • get onended(): null | ((this, ev) => any)

  • Returns null | ((this, ev) => any)

spread

  • get spread(): AudioParam

  • An a-rate AudioParam representing spread of oscillation in Hertz (though the AudioParam returned is read-only, the value it represents is not). The default value is 0.

    Returns AudioParam

type

  • get type(): OscillatorType

  • A string which specifies the shape of waveform to play; this can be one of a number of standard values, or "custom" to use a PeriodicWave to describe a custom waveform. Different waves will produce different tones. Standard values are "sine", "square", "sawtooth", "triangle" and "custom". The default is "sine".

    Returns OscillatorType

  • set type(newValue): void

  • A string which specifies the shape of waveform to play; this can be one of a number of standard values, or "custom" to use a PeriodicWave to describe a custom waveform. Different waves will produce different tones. Standard values are "sine", "square", "sawtooth", "triangle" and "custom". The default is "sine".

    Parameters

    • newValue: OscillatorType

    Returns void

Methods

addEventListener

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

  • Type Parameters

    • K extends "ended"

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: OscillatorNode
          • ev: AudioScheduledSourceNodeEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

connect

  • connect(destinationNode, output?, input?): AudioNode

  • Parameters

    • destinationNode: AudioNode
    • Optional output: number
    • Optional input: number

    Returns AudioNode

  • connect(destinationParam, output?): void

  • Parameters

    • destinationParam: AudioParam
    • Optional output: number

    Returns void

disconnect

dispatchEvent

dispose

removeEventListener

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

  • Type Parameters

    • K extends "ended"

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: OscillatorNode
          • ev: AudioScheduledSourceNodeEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

setPeriodicWave

  • setPeriodicWave(wave): void

  • Sets a PeriodicWave which describes a periodic waveform to be used instead of one of the standard waveforms; calling this sets the type to "custom".

    Parameters

    • wave: PeriodicWave

      A PeriodicWave object representing the waveform to use as the shape of the oscillator's output.

    Returns void

start

  • start(when?): void

  • Specifies the exact time to start playing the tone.

    Parameters

    • Optional when: number

      The time, in seconds, at which the sound should begin to play. This value is specified in the same time coordinate system as the AudioContext is using for its currentTime attribute. A value of 0 (or omitting the when parameter entirely) causes the sound to start playback immediately.

    Returns void

stop

  • stop(when?): void

  • Specifies the time to stop playing the tone.

    Parameters

    • Optional when: number

      The time, in seconds, at which the sound should stop playing. This value is specified in the same time coordinate system as the AudioContext is using for its currentTime attribute. Omitting this parameter, specifying a value of 0, or passing a negative value causes the sound to stop playback immediately.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc