PokéRogue
    Preparing search index...

    Interface OscillatorNode

    The OscillatorNode interface represents a periodic waveform, such as a sine wave.

    MDN Reference

    interface OscillatorNode {
        channelCount: number;
        channelCountMode: ChannelCountMode;
        channelInterpretation: ChannelInterpretation;
        context: BaseAudioContext;
        detune: AudioParam;
        frequency: AudioParam;
        numberOfInputs: number;
        numberOfOutputs: number;
        onended: ((this: AudioScheduledSourceNode, ev: Event) => any) | null;
        type: OscillatorType;
        addEventListener<K extends "ended">(
            type: K,
            listener: (
                this: OscillatorNode,
                ev: AudioScheduledSourceNodeEventMap[K],
            ) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        connect(
            destinationNode: AudioNode,
            output?: number,
            input?: number,
        ): AudioNode;
        connect(destinationParam: AudioParam, output?: number): void;
        disconnect(): void;
        disconnect(output: number): void;
        disconnect(destinationNode: AudioNode): void;
        disconnect(destinationNode: AudioNode, output: number): void;
        disconnect(destinationNode: AudioNode, output: number, input: number): void;
        disconnect(destinationParam: AudioParam): void;
        disconnect(destinationParam: AudioParam, output: number): void;
        dispatchEvent(event: Event): boolean;
        removeEventListener<K extends "ended">(
            type: K,
            listener: (
                this: OscillatorNode,
                ev: AudioScheduledSourceNodeEventMap[K],
            ) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        setPeriodicWave(periodicWave: PeriodicWave): void;
        start(when?: number): void;
        stop(when?: number): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    channelCount channelCountMode channelInterpretation context detune frequency numberOfInputs numberOfOutputs onended type

    Methods

    addEventListener connect disconnect dispatchEvent removeEventListener setPeriodicWave start stop

    Properties

    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

    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

    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.

    MDN Reference

    context: BaseAudioContext

    The read-only context property of the the node is participating in.

    MDN Reference

    detune: AudioParam

    The detune property of the OscillatorNode interface is an a-rate AudioParam representing detuning of oscillation in cents.

    MDN Reference

    frequency: AudioParam

    The frequency property of the OscillatorNode interface is an a-rate AudioParam representing the frequency of oscillation in hertz.

    MDN Reference

    numberOfInputs: number

    The numberOfInputs property of the AudioNode interface returns the number of inputs feeding the node.

    MDN Reference

    numberOfOutputs: number

    The numberOfOutputs property of the AudioNode interface returns the number of outputs coming out of the node.

    MDN Reference

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

    MDN Reference

    type: OscillatorType

    The type property of the OscillatorNode interface specifies what shape of waveform the oscillator will output.

    MDN Reference

    Methods

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

      Returns void

    • Parameters

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      Returns boolean

    • The setPeriodicWave() method of the OscillatorNode interface is used to point to a PeriodicWave defining a periodic waveform that can be used to shape the oscillator's output, when js-nolint setPeriodicWave(wave) - wave - : A PeriodicWave object representing the waveform to use as the shape of the oscillator's output.

      MDN Reference

      Parameters

      Returns void

    • The start() method on AudioScheduledSourceNode schedules a sound to begin playback at the specified time.

      MDN Reference

      Parameters

      • Optionalwhen: number

      Returns void

    • The stop() method on AudioScheduledSourceNode schedules a sound to cease playback at the specified time.

      MDN Reference

      Parameters

      • Optionalwhen: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods