The Automatic Gain Control effect performs the same task as a studio compressor – evening out the audio dynamic range of an input sound. More...
#include <soundeffect.h>
Inheritance diagram for FIFE::Compressor:
Collaboration diagram for FIFE::Compressor:
Public Member Functions | |
| Compressor () | |
| Constructor. More... | |
| void | setCompressor (bool value) |
| Sets compressor on or off. More... | |
| bool | isCompressor () const |
| Return true if compressor is on, false otherwise. More... | |
| Public Member Functions inherited from FIFE::SoundEffect | |
| SoundEffect () | |
| Constructor. More... | |
| virtual | ~SoundEffect () |
| Destructor. More... | |
| ALuint | getEffectId () const |
| Return the OpenAL effect handle. More... | |
| void | setSlotId (ALuint slot) |
| Sets the OpenAL auxiliary slot handle. More... | |
| ALuint | getSlotId () |
| Return the OpenAL auxiliary slot handle. More... | |
| SoundEffectType | getEffectType () const |
| Return sound effect type. More... | |
| void | setEnabled (bool enabled) |
| Enables or disables the effect. More... | |
| bool | isEnabled () const |
| Return true if the effect is enabled, false otherwise. More... | |
| void | setFilter (SoundFilter *filter) |
| Sets the additional sound filter. More... | |
| SoundFilter * | getFilter () |
| Return sound filter or NULL. More... | |
Private Attributes | |
| bool | m_active |
Additional Inherited Members | |
| Protected Attributes inherited from FIFE::SoundEffect | |
| ALuint | m_effect |
| Effect object id. More... | |
| ALuint | m_slot |
| Effect slot id;. More... | |
| SoundEffectType | m_effectType |
| Sound effect type. More... | |
| bool | m_enabled |
| Effect enabled. More... | |
| SoundFilter * | m_filter |
| Additional filter effect. More... | |
Detailed Description
The Automatic Gain Control effect performs the same task as a studio compressor – evening out the audio dynamic range of an input sound.
Definition at line 788 of file soundeffect.h.
Constructor & Destructor Documentation
◆ Compressor()
| FIFE::Compressor::Compressor | ( | ) |
Constructor.
Definition at line 791 of file soundeffect.cpp.
References FIFE::alEffecti, FIFE::SoundEffect::m_effect, FIFE::SoundEffect::m_effectType, and FIFE::SE_EFFECT_COMPRESSOR.
Member Function Documentation
◆ isCompressor()
| bool FIFE::Compressor::isCompressor | ( | ) | const |
Return true if compressor is on, false otherwise.
Definition at line 802 of file soundeffect.cpp.
References m_active.
◆ setCompressor()
| void FIFE::Compressor::setCompressor | ( | bool | value | ) |
Sets compressor on or off.
- Parameters
-
value True or false, default is true.
Definition at line 797 of file soundeffect.cpp.
References FIFE::alEffecti, m_active, and FIFE::SoundEffect::m_effect.
Member Data Documentation
◆ m_active
|
private |
Definition at line 804 of file soundeffect.h.
Referenced by isCompressor(), and setCompressor().
The documentation for this class was generated from the following files:
- engine/core/audio/effects/soundeffect.h
- engine/core/audio/effects/soundeffect.cpp
