FSubmixEffectMultibandCompressorSettings | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/Synthesis

A submix dynamics processor.


Name	FSubmixEffectMultibandCompressorSettings
Type	struct
Header File	/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectMultiBandCompressor.h
Include Path	#include "SubmixEffects/SubmixEffectMultiBandCompressor.h"

Syntax

USTRUCT (BlueprintType )  
struct FSubmixEffectMultibandCompressorSettings

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bAnalogMode	bool	Toggles treating the attack and release envelopes as analog-style vs digital-style. Analog will respond a bit more naturally/slower.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Response
Bands	TArray< FDynamicsBandSettings >	Each band is a full dynamics processor, affecting at a unique frequency range.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Bands
bBypass	bool	Whether or not to bypass effect.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=General Meta=(DisplayName="Bypass", DisplayAfter="DynamicsProcessorType")
bFourPole	bool	Turning off FourPole mode will use cheaper, shallower 2-pole crossovers.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Crossover
bKeyAudition	bool	Audition the key modulation signal, bypassing enveloping and processing the input signal.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Sidechain Meta=(DisplayName="Key Audition", EditCondition="!bBypass")
DynamicsProcessorType	ESubmixEffectDynamicsProcessorType	Controls how each band will react to audio above its threshold.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=General Meta=(DisplayName="Type")
ExternalAudioBus	TObjectPtr< UAudioBus >	If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator)	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Sidechain Meta=(EditCondition="!bBypass && KeySource == ESubmixEffectDynamicsKeySource::AudioBus", EditConditionHides)
ExternalSubmix	TObjectPtr< USoundSubmix >	If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator)	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Sidechain Meta=(EditCondition="!bBypass && KeySource == ESubmixEffectDynamicsKeySource::Submix", EditConditionHides)
KeyGainDb	float	Gain to apply to key signal if external input is supplied.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Sidechain Meta=(DisplayName="External Input Gain (dB)", EditCondition="ExternalSubmix != nullptr \|\| ExternalAudioBus != nullptr", UIMin="-60.0", UIMax="30.0")
KeySource	ESubmixEffectDynamicsKeySource		SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Sidechain Meta=(EditCondition="!bBypass")
LinkMode	ESubmixEffectDynamicsChannelLinkMode	Whether to compress all channels equally, and how to evaluate the overall level.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Dynamics
LookAheadMsec	float	The amount of time to look ahead of the current audio. Allows for transients to be included in dynamics processing.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Response Meta=(DisplayName="Look Ahead (ms)", ClampMin="0.0", ClampMax="50.0", UIMin="0.0", UIMax="50.0")
PeakMode	ESubmixEffectDynamicsPeakMode	Controls how quickly the bands will react to a signal above its threshold.	SubmixEffects/SubmixEffectMultiBandCompressor.h	EditAnywhere BlueprintReadWrite Category=Dynamics

Navigation

Syntax

Variables

Public