FAtomBusEffectLimiterSettings Struct Reference

#include <AtomBusEffectLimiter.h>

Public Member Functions
	FAtomBusEffectLimiterSettings ()

Public Attributes
float	AttackTime
bool	bBypass
float	Gain
float	ReleaseTime
float	SidechainGain
float	SidechainMixRatio
float	SurroundLink
float	Threshold
EAtomLimiterType	Type

Constructor & Destructor Documentation

FAtomBusEffectLimiterSettings()

FAtomBusEffectLimiterSettings::FAtomBusEffectLimiterSettings

(

)

Member Data Documentation

AttackTime

float FAtomBusEffectLimiterSettings::AttackTime

Specifies the attack time of the limiter in milliseconds. The time until compression is completed.

bBypass

bool FAtomBusEffectLimiterSettings::bBypass

If true, input audio is directly routed to output audio with applying any effect.

Gain

float FAtomBusEffectLimiterSettings::Gain

Specify the final output gain of the limiter in decibels (dB).

ReleaseTime

float FAtomBusEffectLimiterSettings::ReleaseTime

Specifies the release time of the limiter in milliseconds. The time from when the amplitude becomes below the threshold until the end of compression.

SidechainGain

float FAtomBusEffectLimiterSettings::SidechainGain

Specifies the gain of the sidechain signal in decibels (dB).

SidechainMixRatio

float FAtomBusEffectLimiterSettings::SidechainMixRatio

Specifies the mix ratio between the sidechain signal and the original bus signal in percent. 100% uses only the sidechain signal, while 0% uses only the original bus signal.

SurroundLink

float FAtomBusEffectLimiterSettings::SurroundLink

Specify the surround link strength of the limiter. Surround link function changes the compression strength using the lowest amplitude value in all channels. 100% fully uses the lowest amplitude value in all channels, while 0% turns off the surround link function.

Threshold

float FAtomBusEffectLimiterSettings::Threshold

Specifies the limiter threshold for amplitude compression in decibels (dB).

Type

EAtomLimiterType FAtomBusEffectLimiterSettings::Type

Specifies the limiter amplitude detection value type.

---

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

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Effects/AtomBusEffectLimiter.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/Effects/AtomBusEffectLimiter.cpp