Navigation
API > API/Plugins > API/Plugins/Synthesis
| Name | FSubmixEffectDelay |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectDelay.h |
| Include Path | #include "SubmixEffects/SubmixEffectDelay.h" |
Syntax
class FSubmixEffectDelay : public FSoundEffectSubmix
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix → FSubmixEffectDelay
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSubmixEffectDelay() |
SubmixEffects/SubmixEffectDelay.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FSubmixEffectDelay() |
SubmixEffects/SubmixEffectDelay.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MinLengthDelaySec | const float | SubmixEffects/SubmixEffectDelay.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DelayLines | TArray< Audio::FDelay > | Delay lines for each channel. | SubmixEffects/SubmixEffectDelay.h | |
| InterpolationInfo | Audio::FLinearEase | SubmixEffects/SubmixEffectDelay.h | ||
| InterpolationTime | float | Current interpolation time, in seconds. | SubmixEffects/SubmixEffectDelay.h | |
| MaxDelayLineLength | float | Current maximum delay line length, in milliseconds. | SubmixEffects/SubmixEffectDelay.h | |
| Params | Audio::TParams< FSubmixEffectDelaySettings > | Params struct used to pass parameters safely to the audio render thread. | SubmixEffects/SubmixEffectDelay.h | |
| SampleRate | float | Sample rate cached at initialization. Used to gage interpolation times. | SubmixEffects/SubmixEffectDelay.h | |
| TargetDelayLineLength | float | Most recently set delay line length. | SubmixEffects/SubmixEffectDelay.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Init
(
const FSoundEffectSubmixInitData& InData |
SubmixEffects/SubmixEffectDelay.h | ||
void SetDelayLineLength
(
float Length |
Set how long the actually delay is, in milliseconds. | SubmixEffects/SubmixEffectDelay.h | |
void SetEffectParameters
(
const FSubmixEffectDelaySettings& InTapEffectParameters |
Sets the reverb effect parameters based from audio thread code. | SubmixEffects/SubmixEffectDelay.h | |
void SetInterpolationTime
(
float Time |
Set the time it takes, in milliseconds, to arrive at a new parameter. | SubmixEffects/SubmixEffectDelay.h |
Overridden from FSoundEffectSubmix
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
SubmixEffects/SubmixEffectDelay.h |
Overridden from FSoundEffectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnPresetChanged() |
SubmixEffects/SubmixEffectDelay.h |