Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Class BiquadFilterEffect

    A sound effect which applies a biquad filter.

    Hierarchy

    • BiquadFilterNode
      • BiquadFilterEffect
    Index

    Constructors

    Accessors

    Methods

    Constructors

    • A ConvolverEffect is constructed by passing the following parameters.

      Parameters

      • context: AudioContext

        The audio context required by the BiquadFilterNode

      • Optionaloptions: { intensity?: number; type?: BiquadFilterType } = {}

        Additional options which modify the BiquadFilterEffect behavior

        • Optionalintensity?: number

          The initial intensity of the effect

        • Optionaltype?: BiquadFilterType

          The filter type to apply

      Returns BiquadFilterEffect

    Accessors

    • get intensity(): number

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

      Returns number

    Methods

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

      Parameters

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

        Options which are updated

        • Optionalintensity?: number

          A new effect intensity

        • Optionaltype?: BiquadFilterType

          A new filter type

      Returns void