FAtomBusEffectCompressorSettings Struct Reference

#include <AtomBusEffectCompressor.h>

Public Member Functions
	FAtomBusEffectCompressorSettings ()

Public Attributes
float	AttackTime
bool	bBypass
float	Gain
float	Ratio
float	ReleaseTime
float	SidechainGain
float	SidechainMixRatio
FAtomSplitEQFilter	SplitEQ
float	SurroundLink
float	Threshold

Constructor & Destructor Documentation

FAtomBusEffectCompressorSettings()

FAtomBusEffectCompressorSettings::FAtomBusEffectCompressorSettings

(

)

Member Data Documentation

AttackTime

float FAtomBusEffectCompressorSettings::AttackTime

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

bBypass

bool FAtomBusEffectCompressorSettings::bBypass

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

Gain

float FAtomBusEffectCompressorSettings::Gain

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

Ratio

float FAtomBusEffectCompressorSettings::Ratio

Specifies the compressor ratio. There are no minimum and maximum limits, but the minimum value is limited to 0.01f during signal processing.

ReleaseTime

float FAtomBusEffectCompressorSettings::ReleaseTime

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

SidechainGain

float FAtomBusEffectCompressorSettings::SidechainGain

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

SidechainMixRatio

float FAtomBusEffectCompressorSettings::SidechainMixRatio

Specifies the compressor amplitude detection value type. 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.

SplitEQ

FAtomSplitEQFilter FAtomBusEffectCompressorSettings::SplitEQ

Specifies the split EQ parameters of the compressor. Split EQ is an equalizer that divides the band into two. Compresses only the band extracted by the filter and synthesizes it with the remaining band.

SurroundLink

float FAtomBusEffectCompressorSettings::SurroundLink

Specify the surround link strength of the compressor. 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 FAtomBusEffectCompressorSettings::Threshold

Specifies the compressor threshold at which the amplitude starts to be compressed in decibels (dB).

---

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

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