Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Engine > FAudioEffectsManager

Light Theme

Dark Theme

FAudioEffectsManager

Manager class to handle the interface to various audio effects

Choose your operating system:

Windows

macOS

Linux

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

		Name	Description
	FAudioDevice &#...	AudioDevice
	bool	bEffectsInitialised
	bool	bEQActive
	bool	bEQChanged
	bool	bReverbActive
	bool	bReverbChanged
	FAudioEQEffect	CurrentEQEffect
	USoundMix *	CurrentEQMix
	UReverbEffect &...	CurrentReverbAsset
	FAudioReverbEff...	CurrentReverbEffect
	FReverbSettings	CurrentReverbSettings
	FAudioEQEffect	DestinationEQEffect
	FAudioReverbEff...	DestinationReverbEffect
	FAudioReverbEff...	PrevReverbEffect
	FAudioEQEffect	SourceEQEffect
	FAudioReverbEff...	SourceReverbEffect

Constructors

	Name	Description
	FAudioEffectsManager ( FAudioDevice* Device )	Clear out any reverb and EQ settings

Destructors

	Name	Description
	~FAudioEffectsManager()

Functions

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )
	void	ClearMixSettings()	Clears the current SoundMix and any EQ settings it has applied
	void	DestroyEffect ( FSoundSource* Source )	Platform dependent call to destroy any effect related data
	USoundMix &#...	GetCurrentEQMix()	Gets the SoundMix currently controlling EQ.
	UReverbEffec...	GetCurrentReverbEffect()
	void	InitAudioEffects()	Sets up default reverb and eq settings
	void *	InitEffect ( FSoundSource* Source )	Platform dependent call to init effect data on a sound source
	void	ResetInterpolation()	Resets all interpolating values to defaults.
	void	SetEQEffectParameters ( const FAudioEffectParameters& InEf... )	Calls the platform specific code to set the parameters that define EQ
	void	SetMixSettings ( USoundMix* Mix, bool bIgnorePriority, bool bForce )	Engine hook to handle setting and fading in of EQ effects and group ducking
	void	SetRadioEffectParameters ( const FAudioEffectParameters& InEf... )	Calls the platform-specific code to set the parameters that define a radio effect.
	void	SetReverbEffectParameters ( const FAudioEffectParameters& InEf... )	Calls the platform specific code to set the parameters that define reverb
	void	SetReverbSettings ( const FReverbSettings& ReverbSetti..., bool bForce )	Engine hook to handle setting and fading in of reverb effects
	void	Update()	Feed in new settings to the audio effect system
	void *	UpdateEffect ( FSoundSource* Source )	Platform dependent call to update the sound output with new parameters
	int64	VolumeToDeciBels ( float Volume )	Converts and volume (0.0f to 1.0f) to a deciBel value
	int64	VolumeToMilliBels ( float Volume, int32 MaxMilliBels )	Converts and volume (0.0f to 1.0f) to a MilliBel value (a Hundredth of a deciBel)