Navigation
API > API/Plugins > API/Plugins/Synthesis
| Name | FSubmixEffectFlexiverb |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectFlexiverb.h |
| Include Path | #include "SubmixEffects/SubmixEffectFlexiverb.h" |
Syntax
class FSubmixEffectFlexiverb : public FSoundEffectSubmix
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix → FSubmixEffectFlexiverb
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSubmixEffectFlexiverb() |
SubmixEffects/SubmixEffectFlexiverb.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsEnabled | bool | SubmixEffects/SubmixEffectFlexiverb.h | ||
| Flexiverb | Audio::FFlexiverb | The reverb effect. | SubmixEffects/SubmixEffectFlexiverb.h | |
| Params | Audio::TParams< Audio::FFlexiverbSettings > | The reverb effect params. | SubmixEffects/SubmixEffectFlexiverb.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Init
(
const FSoundEffectSubmixInitData& InSampleRate |
Called on an audio effect at initialization on main thread before audio processing begins. | SubmixEffects/SubmixEffectFlexiverb.h | |
void SetEffectParameters
(
const Audio::FFlexiverbSettings& InReverbEffectParameters |
Sets the reverb effect parameters based from audio thread code. | SubmixEffects/SubmixEffectFlexiverb.h |
Overridden from FSoundEffectSubmix
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 GetDesiredInputChannelCountOverride() |
We want to receive downmixed submix audio to stereo input for the reverb effect. | SubmixEffects/SubmixEffectFlexiverb.h | |
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
Process the input block of audio. Called on audio thread. | SubmixEffects/SubmixEffectFlexiverb.h |
Overridden from FSoundEffectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnPresetChanged() |
Called when an audio effect preset is changed. | SubmixEffects/SubmixEffectFlexiverb.h |