W3cubDocs

/Godot 3.0

AudioEffectEQ

Inherits: AudioEffect < Resource < Reference < Object

Inherited By: AudioEffectEQ6, AudioEffectEQ21, AudioEffectEQ10

Category: Core

Brief Description

Base class for audio equalizers. Gives you control over frequencies.

Use it to create a custom equalizer if AudioEffectEQ6, AudioEffectEQ10 or AudioEffectEQ21 don’t fit your needs.

Member Functions

int get_band_count ( ) const
float get_band_gain_db ( int band_idx ) const
void set_band_gain_db ( int band_idx, float volume_db )

Description

AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQ are very useful on the Master Bus to completely master a mix and give it character. They are also very useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged).

Member Function Description

int get_band_count ( ) const

Returns the number of bands of the equalizer.

float get_band_gain_db ( int band_idx ) const

Returns the band’s gain at the specified index, in dB.

void set_band_gain_db ( int band_idx, float volume_db )

Sets band’s gain at the specified index, in dB.

© 2014–2018 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.0/classes/class_audioeffecteq.html