AudioEffectCompressor

Adds a downward compressor audio effect to an audio bus. Allows control of the dynamic range via a volume threshold and timing controls.

A "compressor" decreases the volume of sounds when it exceeds a certain volume threshold level. A compressor can have many uses in a mix:

• To compress the whole volume in the Master bus (although an AudioEffectHardLimiter is probably better).
• To ensure balance of voice audio clips.
• To sidechain, using another bus as a trigger. This decreases the volume of the bus it is attached to, by using the volume from another audio bus for threshold detection. This technique is common in video game mixing to decrease the volume of music and SFX while voices are being heard. This effect is also known as "ducking".
• To accentuate transients by using a long attack, letting sounds exceed the volume threshold level for a short period before compressing them. This can be used to make SFX more punchy.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

public AudioEffectCompressor();

public float AttackUs { get; set; }

public float Gain { get; set; }

public float Mix { get; set; }

public float Ratio { get; set; }

public float ReleaseMs { get; set; }

public StringName Sidechain { get; set; }

public float Threshold { get; set; }

public float GetAttackUs();

public float GetGain();

public float GetMix();

public float GetRatio();

public float GetReleaseMs();

public StringName GetSidechain();

public float GetThreshold();

public void SetAttackUs(float attackUs);

public void SetGain(float gain);

public void SetMix(float mix);

public void SetRatio(float ratio);

public void SetReleaseMs(float releaseMs);

public void SetSidechain(StringName sidechain);

public void SetThreshold(float threshold);