aperiodic-oscillator
    Preparing search index...

    Class AperiodicOscillator

    Aperiodic oscillator with an inharmonic frequency spectrum.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _gain: GainNode
    context: BaseAudioContext

    The read-only context property of the AudioNode interface returns the associated BaseAudioContext, that is the object representing the processing graph the node is participating in.

    MDN Reference

    voices: OscillatorNode[]

    Accessors

    • get channelCount(): number

      The channelCount property of the AudioNode interface represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

      MDN Reference

      Returns number

    • get channelCountMode(): ChannelCountMode

      The channelCountMode property of the AudioNode interface represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

      MDN Reference

      Returns ChannelCountMode

    • get channelInterpretation(): ChannelInterpretation

      The channelInterpretation property of the AudioNode interface represents an enumerated value describing how input channels are mapped to output channels when the number of inputs/outputs is different. For example, this setting defines how a mono input will be up-mixed to a stereo or 5.1 channel output, or how a quad channel input will be down-mixed to a stereo or mono output.

      MDN Reference

      Returns ChannelInterpretation

    • 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

    • 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

    • get numberOfInputs(): number

      The numberOfInputs property of the AudioNode interface returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

      MDN Reference

      Returns number

    • get numberOfOutputs(): number

      The numberOfOutputs property of the AudioNode interface returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

      MDN Reference

      Returns number

    • get numberOfVoices(): number

      Get the number of voices in this MultiOscillator group.

      Returns number

    • set numberOfVoices(newValue: number): void

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

      Parameters

      • newValue: number

      Returns void

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

      Returns ((this: AudioScheduledSourceNode, ev: Event) => any) | null

    • 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: OscillatorType): 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

    • Type Parameters

      • K extends "ended"

      Parameters

      • type: K
      • listener: (this: OscillatorNode, ev: AudioScheduledSourceNodeEventMap[K]) => any
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The connect() method of the AudioNode interface lets you connect one of the node's outputs to a target, which may be either another AudioNode (thereby directing the sound data to the specified node) or an AudioParam, so that the node's output data is automatically used to change the value of that parameter over time.

      MDN Reference

      Parameters

      • destinationNode: AudioNode
      • Optionaloutput: number
      • Optionalinput: number

      Returns AudioNode

    • Parameters

      • destinationParam: AudioParam
      • Optionaloutput: number

      Returns void

    • The disconnect() method of the AudioNode interface lets you disconnect one or more nodes from the node on which the method is called.

      MDN Reference

      Returns void

    • Parameters

      • output: number

      Returns void

    • Parameters

      • destinationNode: AudioNode

      Returns void

    • Parameters

      • destinationNode: AudioNode
      • output: number

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      • destinationParam: AudioParam

      Returns void

    • Parameters

      • destinationParam: AudioParam
      • output: number

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Type Parameters

      • K extends "ended"

      Parameters

      • type: K
      • listener: (this: OscillatorNode, ev: AudioScheduledSourceNodeEventMap[K]) => any
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Sets an AperiodicWave which describes an aperiodic waveform to be used.

      Parameters

      Returns 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

    • Specifies the exact time to start playing the tone.

      Parameters

      • Optionalwhen: 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

    • Specifies the time to stop playing the tone.

      Parameters

      • Optionalwhen: 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