Navigation
API > API/Runtime > API/Runtime/AudioMixer
| Name | FSubmixEffectReverb |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectReverb.h |
| Include Path | #include "SubmixEffects/AudioMixerSubmixEffectReverb.h" |
Syntax
class FSubmixEffectReverb : public FSoundEffectSubmix
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix → FSubmixEffectReverb
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSubmixEffectReverb() |
SubmixEffects/AudioMixerSubmixEffectReverb.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MaxWetness | const float | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
| MinWetness | const float | SubmixEffects/AudioMixerSubmixEffectReverb.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentWetDry | Audio::FWetDry | Level of wet/dry signal on current buffer. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
| DecayCurve | FRichCurve | Curve which maps old reverb times to new decay value. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
| PlateReverb | TUniquePtr< Audio::FPlateReverbFast > | The reverb effect. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
| ReverbParams | Audio::TParams< Audio::FPlateReverbFastSettings > | The reverb effect params. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
| SampleRate | float | SubmixEffects/AudioMixerSubmixEffectReverb.h | ||
| WetDryParams | Audio::TParams< Audio::FWetDry > | Settings for wet and dry signal to be consumed on next buffer. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
| WetInputBuffer | Audio::FAlignedFloatBuffer | SubmixEffects/AudioMixerSubmixEffectReverb.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 GetDesiredInputChannelCountOverride() |
Forces receiving downmixed submix audio to stereo input for the reverb effect. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
virtual float GetDryLevel() |
Returns the drylevel of the effect. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
virtual void Init
(
const FSoundEffectSubmixInitData& InSampleRate |
Called on an audio effect at initialization on main thread before audio processing begins. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
virtual void OnPresetChanged() |
Called when an audio effect preset is changed. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
Process the input block of audio. Called on audio thread. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
virtual bool SetParameters
(
const FAudioEffectParameters& InParameters |
Sets the reverb effect parameters based from audio thread code. | SubmixEffects/AudioMixerSubmixEffectReverb.h | |
virtual bool SupportsDefaultReverb() |
Whether this effect supports the default reverb system. | SubmixEffects/AudioMixerSubmixEffectReverb.h |