FSubmixEffectDynamicsProcessorSettings Struct Reference

#include <AudioMixerSubmixEffectDynamicsProcessor.h>

Public Member Functions
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=General, meta=(DisplayName="Input Gain (dB)", UIMin="-12.0", UIMax="20.0", EditCondition="!bBypass")) float InputGainDb=0.0f
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Dynamics, meta=(DisplayName="Threshold (dB)", ClampMin="-60.0", ClampMax="0.0", UIMin="-60.0", UIMax="0.0", EditCondition="!bBypass")) float ThresholdDb
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Dynamics, meta=(EditCondition="!bBypass && DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Compressor || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Expander || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::UpwardsCompressor", ClampMin="1.0", ClampMax="20.0", UIMin="1.0", UIMax="20.0")) float Ratio
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Dynamics, meta=(DisplayName="Knee (dB)", ClampMin="0.0", ClampMax="20.0", UIMin="0.0", UIMax="20.0", EditCondition="!bBypass")) float KneeBandwidthDb
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Response, meta=(DisplayName="Look Ahead (ms)", ClampMin="0.0", ClampMax="50.0", UIMin="0.0", UIMax="50.0", EditCondition="!bBypass")) float LookAheadMsec
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Response, meta=(DisplayName="AttackTime (ms)", ClampMin="1.0", ClampMax="300.0", UIMin="1.0", UIMax="200.0", EditCondition="!bBypass")) float AttackTimeMsec
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Response, meta=(DisplayName="Release Time (ms)", ClampMin="20.0", ClampMax="5000.0", UIMin="20.0", UIMax="5000.0", EditCondition="!bBypass")) float ReleaseTimeMsec
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Sidechain, meta=(DisplayName="External Input Gain (dB)", EditCondition="!bBypass && KeySource != ESubmixEffectDynamicsKeySource::Default", UIMin="-60.0", UIMax="30.0")) float KeyGainDb=0.0f
	UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Output, meta=(DisplayName="Output Gain (dB)", UIMin="-60.0", UIMax="30.0", EditCondition="!bBypass")) float OutputGainDb=0.0f
	FSubmixEffectDynamicsProcessorSettings ()

Public Attributes
ESubmixEffectDynamicsProcessorType	DynamicsProcessorType = ESubmixEffectDynamicsProcessorType::Compressor
ESubmixEffectDynamicsPeakMode	PeakMode = ESubmixEffectDynamicsPeakMode::Peak
ESubmixEffectDynamicsChannelLinkMode	LinkMode = ESubmixEffectDynamicsChannelLinkMode::Average
ESubmixEffectDynamicsKeySource	KeySource = ESubmixEffectDynamicsKeySource::Default
TObjectPtr< UAudioBus >	ExternalAudioBus = nullptr
TObjectPtr< USoundSubmix >	ExternalSubmix = nullptr
uint8	bChannelLinked_DEPRECATED: 1
uint8	bAnalogMode: 1
uint8	bBypass: 1
uint8	bKeyAudition: 1
FSubmixEffectDynamicProcessorFilterSettings	KeyHighshelf
FSubmixEffectDynamicProcessorFilterSettings	KeyLowshelf

Constructor & Destructor Documentation

FSubmixEffectDynamicsProcessorSettings()

FSubmixEffectDynamicsProcessorSettings::FSubmixEffectDynamicsProcessorSettings ( )

inline

Member Function Documentation

UPROPERTY() [1/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY	(	EditAnywhere	,
		BlueprintReadWrite	,
		Category	= Dynamics,
		meta	= (DisplayName="Knee (dB)", ClampMin="0.0", ClampMax="20.0", UIMin="0.0", UIMax="20.0", EditCondition="!bBypass")
	)

UPROPERTY() [2/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY	(	EditAnywhere	,
		BlueprintReadWrite	,
		Category	= Dynamics,
		meta	= (DisplayName="Threshold (dB)", ClampMin="-60.0", ClampMax="0.0", UIMin="-60.0", UIMax="0.0", EditCondition="!bBypass")
	)

UPROPERTY() [3/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY	(	EditAnywhere	,
		BlueprintReadWrite	,
		Category	= Dynamics,
		meta	= (EditCondition="!bBypass && DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Compressor || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Expander ||  DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::UpwardsCompressor", ClampMin="1.0", ClampMax="20.0", UIMin="1.0", UIMax="20.0")
	)

UPROPERTY() [4/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY ( EditAnywhere  , BlueprintReadWrite  , Category  = General, meta  = (DisplayName="Input Gain (dB)", UIMin="-12.0", UIMax="20.0", EditCondition="!bBypass")  )

pure virtual

UPROPERTY() [5/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY ( EditAnywhere  , BlueprintReadWrite  , Category  = Output, meta  = (DisplayName="Output Gain (dB)", UIMin="-60.0", UIMax="30.0", EditCondition="!bBypass")  )

pure virtual

UPROPERTY() [6/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY	(	EditAnywhere	,
		BlueprintReadWrite	,
		Category	= Response,
		meta	= (DisplayName="AttackTime (ms)", ClampMin="1.0", ClampMax="300.0", UIMin="1.0", UIMax="200.0", EditCondition="!bBypass")
	)

UPROPERTY() [7/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY	(	EditAnywhere	,
		BlueprintReadWrite	,
		Category	= Response,
		meta	= (DisplayName="Look Ahead (ms)", ClampMin="0.0", ClampMax="50.0", UIMin="0.0", UIMax="50.0", EditCondition="!bBypass")
	)

UPROPERTY() [8/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY	(	EditAnywhere	,
		BlueprintReadWrite	,
		Category	= Response,
		meta	= (DisplayName="Release Time (ms)", ClampMin="20.0", ClampMax="5000.0", UIMin="20.0", UIMax="5000.0", EditCondition="!bBypass")
	)

UPROPERTY() [9/9]

FSubmixEffectDynamicsProcessorSettings::UPROPERTY ( EditAnywhere  , BlueprintReadWrite  , Category  = Sidechain, meta  = (DisplayName="External Input Gain (dB)", EditCondition="!bBypass && KeySource != ESubmixEffectDynamicsKeySource::Default", UIMin="-60.0", UIMax="30.0")  )

pure virtual

Member Data Documentation

bAnalogMode

uint8 FSubmixEffectDynamicsProcessorSettings::bAnalogMode

bBypass

uint8 FSubmixEffectDynamicsProcessorSettings::bBypass

bChannelLinked_DEPRECATED

uint8 FSubmixEffectDynamicsProcessorSettings::bChannelLinked_DEPRECATED

bKeyAudition

uint8 FSubmixEffectDynamicsProcessorSettings::bKeyAudition

DynamicsProcessorType

ESubmixEffectDynamicsProcessorType FSubmixEffectDynamicsProcessorSettings::DynamicsProcessorType = ESubmixEffectDynamicsProcessorType::Compressor

ExternalAudioBus

TObjectPtr<UAudioBus> FSubmixEffectDynamicsProcessorSettings::ExternalAudioBus = nullptr

ExternalSubmix

TObjectPtr<USoundSubmix> FSubmixEffectDynamicsProcessorSettings::ExternalSubmix = nullptr

KeyHighshelf

FSubmixEffectDynamicProcessorFilterSettings FSubmixEffectDynamicsProcessorSettings::KeyHighshelf

KeyLowshelf

FSubmixEffectDynamicProcessorFilterSettings FSubmixEffectDynamicsProcessorSettings::KeyLowshelf

KeySource

ESubmixEffectDynamicsKeySource FSubmixEffectDynamicsProcessorSettings::KeySource = ESubmixEffectDynamicsKeySource::Default

LinkMode

ESubmixEffectDynamicsChannelLinkMode FSubmixEffectDynamicsProcessorSettings::LinkMode = ESubmixEffectDynamicsChannelLinkMode::Average

PeakMode

ESubmixEffectDynamicsPeakMode FSubmixEffectDynamicsProcessorSettings::PeakMode = ESubmixEffectDynamicsPeakMode::Peak

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h