Class BiquadFilterEffect

A sound effect which applies a biquad filter.

See

https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode

Alias

foundry.audio.BiquadFilterEffect

Hierarchy

  • BiquadFilterNode
    • BiquadFilterEffect

Constructors

constructor

Properties

type #type #intensity #ALLOWED_TYPES

Accessors

intensity

Methods

update

Constructors

constructor

  • new BiquadFilterEffect(context, options?): BiquadFilterEffect

  • A ConvolverEffect is constructed by passing the following parameters.

    Parameters

    • context: AudioContext

      The audio context required by the BiquadFilterNode

    • Optional options: {
          type: BiquadFilterType;
          intensity: number;
      } = {}

      Additional options which modify the BiquadFilterEffect behavior

      • type: BiquadFilterType

        The filter type to apply

      • intensity: number

        The initial intensity of the effect

    Returns BiquadFilterEffect

Properties

type

type: BiquadFilterType

Private #type

#type: BiquadFilterType

The original configured type of the effect.

Private #intensity

#intensity: number

Static Private #ALLOWED_TYPES

#ALLOWED_TYPES: string[] = ...

The allowed filter types supported by this effect class.

Accessors

intensity

  • get intensity(): number

  • Adjust the intensity of the effect on a scale of 0 to 10.

    Returns number

  • set intensity(intensity): void

  • Parameters

    • intensity: number

    Returns void

Methods

update

  • update(options?): void

  • Update the state of the effect node given the active flag and numeric intensity.

    Parameters

    • options: {
          intensity: number;
          type: BiquadFilterType;
      } = {}

      Options which are updated

      • intensity: number

        A new effect intensity

      • type: BiquadFilterType

        A new filter type

    Returns void

Settings

Member Visibility

Theme

On This Page