UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSubmixEffectReverbSettings Struct Referenceabstract

#include <AudioMixerSubmixEffectReverb.h>

Public Member Functions

 UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=EarlyReflections, meta=(DisplayName="Reflections Delay (seconds)", ClampMin="0.0", ClampMax="0.3", EditCondition="!bBypass && !bBypassEarlyReflections")) float ReflectionsDelay=0.007f
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=LateReflections, meta=(DisplayName="Late Delay (seconds)", ClampMin="0.0", ClampMax="0.1", EditCondition="!bBypass && !bBypassLateReflections")) float LateDelay=0.1f
 
 UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=LateReflections, meta=(DisplayName="Decay Time (seconds)", ClampMin="0.1", ClampMax="20.0", EditCondition="!bBypass && !bBypassLateReflections")) float DecayTime
 

Public Attributes

bool bBypassEarlyReflections = false
 
float GainHF = 0.89f
 
float ReflectionsGain = 0.05f
 
bool bBypassLateReflections = false
 
float Density = 0.85f
 
float Diffusion = 0.85f
 
float AirAbsorptionGainHF = 0.994f
 
float DecayHFRatio = 0.83f
 
float LateGain = 1.26f
 
float Gain = 0.0f
 
float WetLevel = 0.3f
 
float DryLevel = 0.0f
 
bool bBypass = false
 

Member Function Documentation

◆ UPROPERTY() [1/3]

FSubmixEffectReverbSettings::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
Category  = EarlyReflections,
meta  = (DisplayName="Reflections Delay (seconds)", ClampMin="0.0", ClampMax="0.3", EditCondition="!bBypass && !bBypassEarlyReflections") 
)
pure virtual

Reflections Delay - 0.0 < 0.007 < 0.3 Seconds - the time between the listener receiving the direct path sound and the first reflection

◆ UPROPERTY() [2/3]

FSubmixEffectReverbSettings::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
Category  = LateReflections,
meta  = (DisplayName="Decay Time (seconds)", ClampMin="0.1", ClampMax="20.0", EditCondition="!bBypass && !bBypassLateReflections") 
)

Decay Time - 0.1 < 1.49 < 20.0 Seconds - larger is more reverb

◆ UPROPERTY() [3/3]

FSubmixEffectReverbSettings::UPROPERTY ( EditAnywhere  ,
BlueprintReadWrite  ,
Category  = LateReflections,
meta  = (DisplayName="Late Delay (seconds)", ClampMin="0.0", ClampMax="0.1", EditCondition="!bBypass && !bBypassLateReflections") 
)
pure virtual

Late Reverb Delay - 0.0 < 0.011 < 0.1 Seconds - time difference between late reverb and first reflections

Member Data Documentation

◆ AirAbsorptionGainHF

float FSubmixEffectReverbSettings::AirAbsorptionGainHF = 0.994f

Air Absorption - 0.0 < 0.994 < 1.0 - lower value means more absorption

◆ bBypass

bool FSubmixEffectReverbSettings::bBypass = false

Bypasses reverb

◆ bBypassEarlyReflections

bool FSubmixEffectReverbSettings::bBypassEarlyReflections = false

Bypasses early reflections

◆ bBypassLateReflections

bool FSubmixEffectReverbSettings::bBypassLateReflections = false

Bypasses late reflections.

◆ DecayHFRatio

float FSubmixEffectReverbSettings::DecayHFRatio = 0.83f

Decay High Frequency Ratio - 0.1 < 0.83 < 2.0 - how much quicker or slower the high frequencies decay relative to the lower frequencies.

◆ Density

float FSubmixEffectReverbSettings::Density = 0.85f

Density - 0.0 < 0.85 < 1.0 - Coloration of the late reverb - lower value is more grainy

◆ Diffusion

float FSubmixEffectReverbSettings::Diffusion = 0.85f

Diffusion - 0.0 < 0.85 < 1.0 - Echo density in the reverberation decay - lower is more grainy

◆ DryLevel

float FSubmixEffectReverbSettings::DryLevel = 0.0f

◆ Gain

float FSubmixEffectReverbSettings::Gain = 0.0f

Reverb Gain - 0.0 < 0.32 < 1.0 - overall reverb gain - master volume control

◆ GainHF

float FSubmixEffectReverbSettings::GainHF = 0.89f

Reverb Gain High Frequency - 0.0 < 0.89 < 1.0 - attenuates the high frequency reflected sound

◆ LateGain

float FSubmixEffectReverbSettings::LateGain = 1.26f

Late Reverb Gain - 0.0 < 1.26 < 10.0 - gain of the late reverb

◆ ReflectionsGain

float FSubmixEffectReverbSettings::ReflectionsGain = 0.05f

Reflections Gain - 0.0 < 0.05 < 3.16 - controls the amount of initial reflections

◆ WetLevel

float FSubmixEffectReverbSettings::WetLevel = 0.3f

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