Navigation
API > API/Plugins > API/Plugins/Synthesis
Audio render thread effect object.
| Name | FSubmixEffectConvolutionReverb |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectConvolutionReverb.h |
| Include Path | #include "SubmixEffects/SubmixEffectConvolutionReverb.h" |
Syntax
class FSubmixEffectConvolutionReverb : public FSoundEffectSubmix
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix → FSubmixEffectConvolutionReverb
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| SubmixEffects/SubmixEffectConvolutionReverb.h | |||
FSubmixEffectConvolutionReverb
(
const USubmixEffectConvolutionReverbPreset* InPreset |
Construct a convolution object with an existing preset. | SubmixEffects/SubmixEffectConvolutionReverb.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FSubmixEffectConvolutionReverb() |
SubmixEffects/SubmixEffectConvolutionReverb.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DryVolume | float | SubmixEffects/SubmixEffectConvolutionReverb.h | ||
| WetVolume | float | SubmixEffects/SubmixEffectConvolutionReverb.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Reverb | TSharedRef< Audio::FEffectConvolutionReverb > | Reverb performs majority of DSP operations. | SubmixEffects/SubmixEffectConvolutionReverb.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Init
(
const FSoundEffectSubmixInitData& InitData |
Called on an audio effect at initialization on main thread before audio processing begins. | SubmixEffects/SubmixEffectConvolutionReverb.h | |
void RebuildConvolutionReverb() |
SubmixEffects/SubmixEffectConvolutionReverb.h | ||
AudioConvReverbIntrinsics::FVersionData UpdateConvolutionReverb
(
const USubmixEffectConvolutionReverbPreset* InPreset |
Call on the game thread in order to update the impulse response and hardware acceleration used in this submix effect. | SubmixEffects/SubmixEffectConvolutionReverb.h |
Overridden from FSoundEffectSubmix
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
Process the input block of audio. Called on audio thread. | SubmixEffects/SubmixEffectConvolutionReverb.h |
Overridden from FSoundEffectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnPresetChanged() |
Called when an audio effect preset settings is changed. | SubmixEffects/SubmixEffectConvolutionReverb.h |