UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAudioReverbEffect Struct Reference

#include <AudioEffect.h>

+ Inheritance diagram for FAudioReverbEffect:

Public Member Functions

ENGINE_API FAudioReverbEffect ()
 
ENGINE_API FAudioReverbEffect (float InRoom, float InRoomHF, float InRoomRolloffFactor, float InDecayTime, float InDecayHFRatio, float InReflections, float InReflectionsDelay, float InReverb, float InReverbDelay, float InDiffusion, float InDensity, float InAirAbsorption, bool bInBypassEarlyReflections, bool bInBypassLateReflections)
 
ENGINE_API FAudioReverbEffectoperator= (class UReverbEffect *InReverbEffect)
 
ENGINE_API bool Interpolate (const FAudioEffectParameters &InStart, const FAudioEffectParameters &InEnd)
 
ENGINE_API void PrintSettings () const override
 
- Public Member Functions inherited from FAudioEffectParameters
 FAudioEffectParameters ()
 
virtual ~FAudioEffectParameters ()
 

Public Attributes

double Time
 
float Volume
 
float Density
 
float Diffusion
 
float Gain
 
float GainHF
 
float DecayTime
 
float DecayHFRatio
 
float ReflectionsGain
 
float ReflectionsDelay
 
float LateGain
 
float LateDelay
 
float AirAbsorptionGainHF
 
float RoomRolloffFactor
 
bool bBypassEarlyReflections
 
bool bBypassLateReflections
 

Constructor & Destructor Documentation

◆ FAudioReverbEffect() [1/2]

FAudioReverbEffect::FAudioReverbEffect ( )

Sets the default values for a reverb effect

Default settings for a null reverb effect

◆ FAudioReverbEffect() [2/2]

FAudioReverbEffect::FAudioReverbEffect ( float  InRoom,
float  InRoomHF,
float  InRoomRolloffFactor,
float  InDecayTime,
float  InDecayHFRatio,
float  InReflections,
float  InReflectionsDelay,
float  InReverb,
float  InReverbDelay,
float  InDiffusion,
float  InDensity,
float  InAirAbsorption,
bool  bInBypassEarlyReflections,
bool  bInBypassLateReflections 
)

Sets the platform agnostic parameters

Construct generic reverb settings based in the I3DL2 standards

Member Function Documentation

◆ Interpolate()

bool FAudioReverbEffect::Interpolate ( const FAudioEffectParameters InStart,
const FAudioEffectParameters InEnd 
)
virtual

Interpolates between Start and End reverb effect settings, storing results locally and returning if interpolation is complete

Get interpolated reverb parameters

Reimplemented from FAudioEffectParameters.

◆ operator=()

FAudioReverbEffect & FAudioReverbEffect::operator= ( class UReverbEffect InReverbEffect)

◆ PrintSettings()

void FAudioReverbEffect::PrintSettings ( ) const
overridevirtual

Reimplemented from FAudioEffectParameters.

Member Data Documentation

◆ AirAbsorptionGainHF

float FAudioReverbEffect::AirAbsorptionGainHF

◆ bBypassEarlyReflections

bool FAudioReverbEffect::bBypassEarlyReflections

◆ bBypassLateReflections

bool FAudioReverbEffect::bBypassLateReflections

◆ DecayHFRatio

float FAudioReverbEffect::DecayHFRatio

◆ DecayTime

float FAudioReverbEffect::DecayTime

◆ Density

float FAudioReverbEffect::Density

Platform agnostic parameters that define a reverb effect. Min < Default < Max

◆ Diffusion

float FAudioReverbEffect::Diffusion

◆ Gain

float FAudioReverbEffect::Gain

◆ GainHF

float FAudioReverbEffect::GainHF

◆ LateDelay

float FAudioReverbEffect::LateDelay

◆ LateGain

float FAudioReverbEffect::LateGain

◆ ReflectionsDelay

float FAudioReverbEffect::ReflectionsDelay

◆ ReflectionsGain

float FAudioReverbEffect::ReflectionsGain

◆ RoomRolloffFactor

float FAudioReverbEffect::RoomRolloffFactor

◆ Time

double FAudioReverbEffect::Time

Time when this reverb was initiated or completed faded in

◆ Volume

float FAudioReverbEffect::Volume

Overall volume of effect


The documentation for this struct was generated from the following files: