Navigation
API > API/Plugins > API/Plugins/Synthesis
| Name | FSubmixEffectTapDelay |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectTapDelay.h |
| Include Path | #include "SubmixEffects/SubmixEffectTapDelay.h" |
Syntax
class FSubmixEffectTapDelay : public FSoundEffectSubmix
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix → FSubmixEffectTapDelay
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSubmixEffectTapDelay() |
SubmixEffects/SubmixEffectTapDelay.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSubmixEffectTapDelay() |
SubmixEffects/SubmixEffectTapDelay.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bSettingsModified | bool | Whether taps have been modified. | SubmixEffects/SubmixEffectTapDelay.h | |
| CurrentTaps | TArray< FTapDelayInterpolationInfo > | Current state of each tap. | SubmixEffects/SubmixEffectTapDelay.h | |
| DelayLine | Audio::FDelay | SubmixEffects/SubmixEffectTapDelay.h | ||
| InterpolationTime | float | Current interpolation time, in seconds. | SubmixEffects/SubmixEffectTapDelay.h | |
| MaxDelayLineLength | float | Current maximum delay line length, in milliseconds. | SubmixEffects/SubmixEffectTapDelay.h | |
| Params | Audio::TParams< FSubmixEffectTapDelaySettings > | Params struct used to pass parameters safely to the audio render thread. | SubmixEffects/SubmixEffectTapDelay.h | |
| SampleRate | float | Sample rate cached at initialization. Used to gauge interpolation times. | SubmixEffects/SubmixEffectTapDelay.h | |
| TapIncrementsRemaining | int32 | How many increments we have left before all CurrentTaps reach the TargetTaps. | SubmixEffects/SubmixEffectTapDelay.h | |
| TargetTaps | TArray< FTapDelayInfo > | Target parameters that we interpolate to. Updated directly from params. | SubmixEffects/SubmixEffectTapDelay.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddTap
(
int32 TapId |
SubmixEffects/SubmixEffectTapDelay.h | ||
virtual void Init
(
const FSoundEffectSubmixInitData& InData |
SubmixEffects/SubmixEffectTapDelay.h | ||
void RemoveTap
(
int32 TapId |
SubmixEffects/SubmixEffectTapDelay.h | ||
void SetEffectParameters
(
const FSubmixEffectTapDelaySettings& InTapEffectParameters |
Sets the reverb effect parameters based from audio thread code. | SubmixEffects/SubmixEffectTapDelay.h | |
void SetInterpolationTime
(
float Time |
Set the interpolation time. | SubmixEffects/SubmixEffectTapDelay.h | |
void SetTap
(
int32 TapId, |
SubmixEffects/SubmixEffectTapDelay.h |
Overridden from FSoundEffectSubmix
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
SubmixEffects/SubmixEffectTapDelay.h |
Overridden from FSoundEffectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnPresetChanged() |
SubmixEffects/SubmixEffectTapDelay.h |