PokéRogue
    Preparing search index...

    Interface BiquadFilterNode

    The BiquadFilterNode interface represents a simple low-order filter, and is created using the BaseAudioContext/createBiquadFilter method. It is an AudioNode that can represent different kinds of filters, tone control devices, and graphic equalizers. A BiquadFilterNode always has exactly one input and one output.

    MDN Reference

    interface BiquadFilterNode {
        channelCount: number;
        channelCountMode: ChannelCountMode;
        channelInterpretation: ChannelInterpretation;
        context: BaseAudioContext;
        detune: AudioParam;
        frequency: AudioParam;
        gain: AudioParam;
        numberOfInputs: number;
        numberOfOutputs: number;
        Q: AudioParam;
        type: BiquadFilterType;
        addEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            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;
        getFrequencyResponse(
            frequencyHz: Float32Array<ArrayBuffer>,
            magResponse: Float32Array<ArrayBuffer>,
            phaseResponse: Float32Array<ArrayBuffer>,
        ): void;
        removeEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | EventListenerOptions,
        ): void;
    }

    Hierarchy (View Summary)

    Index

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

    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

    detune: AudioParam

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

    MDN Reference

    frequency: AudioParam

    The frequency property of the BiquadFilterNode interface is an a-rate AudioParam — a double representing a frequency in the current filtering algorithm measured in hertz (Hz).

    MDN Reference

    The gain property of the BiquadFilterNode interface is an a-rate AudioParam — a double representing the gain used in the current filtering algorithm.

    MDN Reference

    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

    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

    The Q property of the BiquadFilterNode interface is an a-rate AudioParam, a double representing a Q factor, or quality factor.

    MDN Reference

    The type property of the BiquadFilterNode interface is a string (enum) value defining the kind of filtering algorithm the node is implementing.

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

      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. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      Returns void