AudioEffectCompressor

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.

Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB). Compressor has many uses in the mix: - In the Master bus to compress the whole output (Although a AudioEffectLimiter is probably better) - 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.

@GodotBaseClass

struct AudioEffectCompressor {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(AudioEffectCompressor other);

AudioEffectCompressor opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static AudioEffectCompressor _new();

void setThreshold(double threshold);

double getThreshold();

void setRatio(double ratio);

double getRatio();

void setGain(double gain);

double getGain();

void setAttackUs(double attack_us);

double getAttackUs();

void setReleaseMs(double release_ms);

double getReleaseMs();

void setMix(double mix);

double getMix();

void setSidechain(StringArg0 sidechain);

String getSidechain();

double threshold [@property getter];

double threshold [@property setter];

double ratio [@property getter];

double ratio [@property setter];

double gain [@property getter];

double gain [@property setter];

double attackUs [@property getter];

double attackUs [@property setter];

double releaseMs [@property getter];

double releaseMs [@property setter];

double mix [@property getter];

double mix [@property setter];

String sidechain [@property getter];

String sidechain [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

getAttackUs double getAttackUs()
getGain double getGain()
getMix double getMix()
getRatio double getRatio()
getReleaseMs double getReleaseMs()
getSidechain String getSidechain()
getThreshold double getThreshold()
opAssign AudioEffectCompressor opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(AudioEffectCompressor other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
setAttackUs void setAttackUs(double attack_us)
setGain void setGain(double gain)
setMix void setMix(double mix)
setRatio void setRatio(double ratio)
setReleaseMs void setReleaseMs(double release_ms)
setSidechain void setSidechain(StringArg0 sidechain)
setThreshold void setThreshold(double threshold)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

attackUs double attackUs [@property getter]
double attackUs [@property setter]: Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: 20ms.
gain double gain [@property getter]
double gain [@property setter]: Gain applied to the output signal.
mix double mix [@property getter]
double mix [@property setter]: Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: 1.
ratio double ratio [@property getter]
double ratio [@property setter]: 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: 4.
releaseMs double releaseMs [@property getter]
double releaseMs [@property setter]: 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: 250ms.
sidechain String sidechain [@property getter]
String sidechain [@property setter]: Reduce the sound level using another audio bus for threshold detection.
threshold double threshold [@property getter]
double threshold [@property setter]: The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: 0.

Static functions

_new AudioEffectCompressor _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

AudioEffectCompressor

Members

Aliases

Functions

Mixins

Properties

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

AudioEffectCompressor

From mixin baseCasts

From `mixin baseCasts`