FSubmixEffectReverb

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSoundEffectBase

FSoundEffectSubmix

FSubmixEffectReverb

References

Module

AudioMixer

Header

/Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectReverb.h

Include

#include "SubmixEffects/AudioMixerSubmixEffectReverb.h"

Syntax

class FSubmixEffectReverb : public FSoundEffectSubmix

Constructors

Name Description

Public function

FSubmixEffectReverb()

Overridden from FSoundEffectSubmix

Name Description

Public function Virtual Const

uint32

 

GetDesiredInputChannelCountOverride()

Forces receiving downmixed submix audio to stereo input for the reverb effect.

Public function Virtual Const

float

 

GetDryLevel()

Returns the drylevel of the effect.

Public function Virtual

void

 

Init

(
    const FSoundEffectSubmixInitData& ...
)

Called on an audio effect at initialization on main thread before audio processing begins.

Public function Virtual

void

 

OnProcessAudio

(
    const FSoundEffectSubmixInputData&...,
    FSoundEffectSubmixOutputData& OutD...
)

Process the input block of audio. Called on audio thread.

Public function Virtual

bool

 

SetParameters

(
    const FAudioEffectParameters& InPa...
)

Sets the reverb effect parameters based from audio thread code.

Public function Virtual Const

bool

 

SupportsDefaultReverb()

Whether this effect supports the default reverb system.

Overridden from FSoundEffectBase

Name Description

Public function Virtual

void

 

OnPresetChanged()

Called when an audio effect preset is changed.

Constants

Name

Description

MaxWetness

MinWetness