1. Epic GamesDeveloper
  3. FAudioEffectsManager

FAudioEffectsManager

Manager class to handle the interface to various audio effects

Unreal Engine C++ API Reference > Runtime > Engine

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/AudioEffect.h
Include #include "AudioEffect.h"

Syntax

class FAudioEffectsManager

Remarks

Manager class to handle the interface to various audio effects

Variables

  Type Name Description
Protected variable FAudioDevice * AudioDevice  
Protected variable bool bEffectsInitialised  
Protected variable bool bEQActive  
Protected variable bool bEQChanged  
Protected variable bool bReverbActive  
Protected variable bool bReverbChanged  
Protected variable FAudioEQEffect CurrentEQEffect  
Protected variable USoundMix * CurrentEQMix  
Protected variable TObjectPtr< UReverbEffect > CurrentReverbAsset  
Protected variable FAudioReverbEffect CurrentReverbEffect  
Protected variable FReverbSettings CurrentReverbSettings  
Protected variable FAudioEQEffect DestinationEQEffect  
Protected variable FAudioReverbEffect DestinationReverbEffect  
Protected variable FAudioReverbEffect PrevReverbEffect  
Protected variable FAudioEQEffect SourceEQEffect  
Protected variable FAudioReverbEffect SourceReverbEffect  

Constructors

  Type Name Description
Public function   Clear out any reverb and EQ settings

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void  
Public function void Clears the current SoundMix and any EQ settings it has applied
Public function void Platform dependent call to destroy any effect related data
Public function Const USoundMix * Gets the SoundMix currently controlling EQ.
Public function Const UReverbEffect *  
Protected function void Sets up default reverb and eq settings
Public function Virtual void *

InitEffect ( FSoundSource* Source
)

 Platform dependent call to init effect data on a sound source
Public function void Resets all interpolating values to defaults.
Public function Virtual void

SetEQEffectParameters ( const FAudioEffectParameters& InEffectParameters
)

 Calls the platform specific code to set the parameters that define EQ
Public function void

SetMixSettings ( USoundMix* Mix,
bool bIgnorePriority,
bool bForce
)

 Engine hook to handle setting and fading in of EQ effects and group ducking
Public function Virtual void

SetRadioEffectParameters ( const FAudioEffectParameters& InEffectParameters
)

 Calls the platform-specific code to set the parameters that define a radio effect.
Public function Virtual void

SetReverbEffectParameters ( const FAudioEffectParameters& InEffectParameters
)

 Calls the platform specific code to set the parameters that define reverb
Public function void

SetReverbSettings ( const FReverbSettings& ReverbSettings,
bool bForce
)

 Engine hook to handle setting and fading in of reverb effects
Public function void

Update ()

 Feed in new settings to the audio effect system
Public function Virtual void * Platform dependent call to update the sound output with new parameters
Public function int64

VolumeToDeciBels ( float Volume
)

 Converts and volume (0.0f to 1.0f) to a deciBel value
Public function int64

VolumeToMilliBels ( float Volume,
int32 MaxMilliBels
)

 Converts and volume (0.0f to 1.0f) to a MilliBel value (a Hundredth of a deciBel)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page