Engine

EqualizerSoundEffect

Show Deprecated

An equalizer allows for control of the volume of various frequency ranges for the Sound or SoundGroup the effect is parented to. This can be used to highlight particular elements of audio or minimize or outright eliminate others. The EqualizerSoundEffect gives control over three ranges of frequency: Low, Mid, and High. Their specific frequencies are as follows:

  • Low: 0 - 400 Hz
  • Mid: 400 - 4000 Hz
  • High: 4000+ Hz

Summary

Properties

  • read parallel

    The output volume of frequencies greater than 4000 Hz.

  • read parallel

    The output volume of frequencies lower than 400 Hz.

  • read parallel

    The output volume of frequencies between 400 and 4000 Hz.

Properties inherited from SoundEffect
  • read parallel

    Toggles the effect on and off.

  • read parallel

    Determines the order the effect will be applied in relation to other effects.

Properties

HighGain

read parallel

Range: -80 to 10 (default 0) The output volume of frequencies greater than 4000 Hz. Measured in dB.

LowGain

read parallel

Range: -80 to 10 (default 0) The output volume of frequencies lower than 400 Hz. Measured in dB.

MidGain

read parallel

Range: -80 to 10 (default 0) The output volume of frequencies between 400 and 4000 Hz. Measured in dB.

Methods

Events