Navigation
API > API/Plugins > API/Plugins/Synthesis
======================================================================== UTapDelaySubmixPreset Class which processes audio streams and uses parameters defined in the preset class.
| Name | USubmixEffectTapDelayPreset |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectTapDelay.h |
| Include Path | #include "SubmixEffects/SubmixEffectTapDelay.h" |
Syntax
UCLASS (MinimalAPI, ClassGroup=AudioSourceEffect, Meta=(BlueprintSpawnableComponent),
AutoExpandCategories=(Realtime))
class USubmixEffectTapDelayPreset : public USoundEffectSubmixPreset
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USoundEffectPreset → USoundEffectSubmixPreset → USubmixEffectTapDelayPreset
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DynamicSettings | FSubmixEffectTapDelaySettings | SubmixEffects/SubmixEffectTapDelay.h | ||
| Settings | FSubmixEffectTapDelaySettings | SubmixEffects/SubmixEffectTapDelay.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddTap
(
int32& TapId |
Adds a dynamic tap delay with the given settings. Returns the tap id. | SubmixEffects/SubmixEffectTapDelay.h |
|
EFFECT_PRESET_METHODS
(
SubmixEffectTapDelay |
Set all tap delay setting. This will replace any dynamically added or modified taps. | SubmixEffects/SubmixEffectTapDelay.h | |
float GetMaxDelayInMilliseconds() |
Get the maximum delay possible. | SubmixEffects/SubmixEffectTapDelay.h |
|
void GetTap
(
int32 TapId, |
Get the current info about a specific tap. | SubmixEffects/SubmixEffectTapDelay.h |
|
void GetTapIds
(
TArray< int32 >& TapIds |
Retrieve an array of all tap ids for the submix effect. | SubmixEffects/SubmixEffectTapDelay.h |
|
void RemoveTap
(
int32 TapId |
Remove the tap from the preset. | SubmixEffects/SubmixEffectTapDelay.h |
|
void SetInterpolationTime
(
float Time |
Set the time it takes to interpolate between parameters, in milliseconds. | SubmixEffects/SubmixEffectTapDelay.h |
|
void SetTap
(
int32 TapId, |
Modify a specific tap. | SubmixEffects/SubmixEffectTapDelay.h |
|
Overridden from USoundEffectPreset
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnInit() |
SubmixEffects/SubmixEffectTapDelay.h |