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