AudioEffectCompressor

Category: Core

Adds a Compressor audio effect to an Audio bus.

Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume.

Compressor has many uses in the mix:

In voice channels to ensure they sound as balanced as possible.
Sidechained. Sidechained, which can reduce the sound level sidechained with another audio bus for threshold detection.. This technique is very common in video game mixing to download the level of Music/SFX while voices are being heard.
Accentuates transients by using a wider attack, making effects sound more punchy.

attack_us

Setter	set_attack_us(value)
Getter	get_attack_us()

Compressor’s reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: .

Gain applied to the output signal.

float mix

Setter	set_mix(value)
Getter	get_mix()

ratio

Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: .

float release_ms

Setter	set_release_ms(value)
Getter	get_release_ms()

Compressor’s delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: .

sidechain

Reduce the sound level using another audio bus for threshold detection.

Setter	set_threshold(value)
Getter	get_threshold()