Navigation
API > API/Runtime > API/Runtime/Engine
Manager class to handle the interface to various audio effects
| Name | FAudioEffectsManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/AudioEffect.h |
| Include Path | #include "AudioEffect.h" |
Syntax
class FAudioEffectsManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAudioEffectsManager
(
FAudioDevice* Device |
Clear out any reverb and EQ settings | AudioEffect.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAudioEffectsManager() |
AudioEffect.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddReferencedObjects
(
FReferenceCollector& Collector |
AudioEffect.h | ||
void ClearMixSettings () |
Clears the current SoundMix and any EQ settings it has applied | AudioEffect.h | |
void DestroyEffect
(
FSoundSource* Source |
Platform dependent call to destroy any effect related data | AudioEffect.h | |
USoundMix * GetCurrentEQMix() |
Gets the SoundMix currently controlling EQ. | AudioEffect.h | |
UReverbEffect * GetCurrentReverbEffect() |
AudioEffect.h | ||
virtual void * InitEffect
(
FSoundSource* Source |
Platform dependent call to init effect data on a sound source | AudioEffect.h | |
void ResetInterpolation() |
Resets all interpolating values to defaults. | AudioEffect.h | |
virtual void SetEQEffectParameters
(
const FAudioEffectParameters& InEffectParameters |
Calls the platform specific code to set the parameters that define EQ | AudioEffect.h | |
void SetMixSettings
(
USoundMix* Mix, |
Engine hook to handle setting and fading in of EQ effects and group ducking | AudioEffect.h | |
virtual void SetRadioEffectParameters
(
const FAudioEffectParameters& InEffectParameters |
Calls the platform-specific code to set the parameters that define a radio effect. | AudioEffect.h | |
virtual void SetReverbEffectParameters
(
const FAudioEffectParameters& InEffectParameters |
Calls the platform specific code to set the parameters that define reverb | AudioEffect.h | |
void SetReverbSettings
(
const FReverbSettings& ReverbSettings, |
Engine hook to handle setting and fading in of reverb effects | AudioEffect.h | |
void Update() |
Feed in new settings to the audio effect system | AudioEffect.h | |
virtual void * UpdateEffect
(
FSoundSource* Source |
Platform dependent call to update the sound output with new parameters | AudioEffect.h | |
int64 VolumeToDeciBels
(
float Volume |
Converts and volume (0.0f to 1.0f) to a deciBel value | AudioEffect.h | |
int64 VolumeToMilliBels
(
float Volume, |
Converts and volume (0.0f to 1.0f) to a MilliBel value (a Hundredth of a deciBel) | AudioEffect.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void InitAudioEffects() |
Sets up default reverb and eq settings | AudioEffect.h |