Interface ScriptProcessorNode

    Allows the generation, processing, or analyzing of audio using JavaScript.

    Deprecated

    As of the August 29 2014 Web Audio API spec publication, this feature has been marked as deprecated, and was replaced by AudioWorklet (see AudioWorkletNode).

    MDN Reference

    interface ScriptProcessorNode {
        bufferSize: number;
        channelCount: number;
        channelCountMode: ChannelCountMode;
        channelInterpretation: ChannelInterpretation;
        context: BaseAudioContext;
        numberOfInputs: number;
        numberOfOutputs: number;
        onaudioprocess: ((this: ScriptProcessorNode, ev: AudioProcessingEvent) => any);
        addEventListener<K>(type: K, listener: ((this: ScriptProcessorNode, ev: ScriptProcessorNodeEventMap[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>(type: K, listener: ((this: ScriptProcessorNode, ev: ScriptProcessorNodeEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
    }
    Hierarchy

    Properties

    bufferSize channelCount channelCountMode channelInterpretation context numberOfInputs numberOfOutputs onaudioprocess

    Methods

    addEventListener connect disconnect dispatchEvent removeEventListener

    Properties

    ReadonlybufferSize

    bufferSize: number

    Deprecated

    MDN Reference

    channelCount

    channelCount: number

    MDN Reference

    channelCountMode

    channelCountMode: ChannelCountMode

    MDN Reference

    channelInterpretation

    channelInterpretation: ChannelInterpretation

    MDN Reference

    Readonlycontext

    context: BaseAudioContext

    MDN Reference

    ReadonlynumberOfInputs

    numberOfInputs: number

    MDN Reference

    ReadonlynumberOfOutputs

    numberOfOutputs: number

    MDN Reference

    onaudioprocess

    onaudioprocess: ((this: ScriptProcessorNode, ev: AudioProcessingEvent) => any)

    Deprecated

    MDN Reference

    Methods

    addEventListener

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

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Type Parameters

      • K extends "audioprocess"

      Parameters

      Returns void

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

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      Returns void

    connect

    disconnect

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      Returns boolean

    removeEventListener

    Settings

    Member Visibility

    On This Page

    Properties
    Methods