Navigation
API > API/Plugins > API/Plugins/Synthesis
| Name | FSubmixEffectMultibandCompressor |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectMultiBandCompressor.h |
| Include Path | #include "SubmixEffects/SubmixEffectMultiBandCompressor.h" |
Syntax
class FSubmixEffectMultibandCompressor : public FSoundEffectSubmix
Inheritance Hierarchy
- FSoundEffectBase → FSoundEffectSubmix → FSubmixEffectMultibandCompressor
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSubmixEffectMultibandCompressor() |
SubmixEffects/SubmixEffectMultiBandCompressor.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSubmixEffectMultibandCompressor() |
SubmixEffects/SubmixEffectMultiBandCompressor.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MaxBlockNumSamples | int32 | SubmixEffects/SubmixEffectMultiBandCompressor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BandSplitter | Audio::FLinkwitzRileyBandSplitter | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| bBypass | bool | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| bInitialized | bool | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| bPrevFourPole | bool | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| DeviceCreatedHandle | FDelegateHandle | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| DeviceDestroyedHandle | FDelegateHandle | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| DeviceId | Audio::FDeviceId | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| DynamicsProcessors | TArray< Audio::FDynamicsProcessor > | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| FrameSize | int32 | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| KeyBandSplitter | Audio::FLinkwitzRileyBandSplitter | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| KeyMultiBandBuffer | Audio::FMultibandBuffer | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| KeySource | FKeySource | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| MultiBandBuffer | Audio::FMultibandBuffer | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| NumChannels | int32 | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| PrevCrossovers | TArray< float > | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| PrevNumBands | int32 | Cached crossover + band info, so we can check if they need a re-build when editing | SubmixEffects/SubmixEffectMultiBandCompressor.h | |
| SampleRate | float | SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
| ScratchBuffer | Audio::FAlignedFloatBuffer | SubmixEffects/SubmixEffectMultiBandCompressor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
Audio::FDeviceId GetDeviceId() |
Gets the effect's deviceId that owns it. | SubmixEffects/SubmixEffectMultiBandCompressor.h | |
virtual void Init
(
const FSoundEffectSubmixInitData& InSampleRate |
Called on an audio effect at initialization on main thread before audio processing begins. | SubmixEffects/SubmixEffectMultiBandCompressor.h | |
void Initialize
(
FSubmixEffectMultibandCompressorSettings& Settings |
Called from OnPresetChanged when something is changed that needs extra attention | SubmixEffects/SubmixEffectMultiBandCompressor.h |
Overridden from FSoundEffectSubmix
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnProcessAudio
(
const FSoundEffectSubmixInputData& InData, |
Process the input block of audio. Called on audio thread. | SubmixEffects/SubmixEffectMultiBandCompressor.h |
Overridden from FSoundEffectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnPresetChanged() |
Called when an audio effect preset is changed. | SubmixEffects/SubmixEffectMultiBandCompressor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
Audio::FMixerDevice * GetMixerDevice() |
SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
void OnDeviceCreated
(
Audio::FDeviceId InDeviceId |
SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
void OnDeviceDestroyed
(
Audio::FDeviceId InDeviceId |
SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
void ResetKey() |
SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
void UpdateKeyFromSettings
(
const FSubmixEffectMultibandCompressorSettings& InSettings |
SubmixEffects/SubmixEffectMultiBandCompressor.h | ||
bool UpdateKeySourcePatch() |
SubmixEffects/SubmixEffectMultiBandCompressor.h |