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 an AudioEffectLimiter is probably better). - In voice channels to ensure they sound as balanced as possible. - Sidechained. This can reduce the sound level sidechained with another audio bus for threshold detection. This technique is common in video game mixing to the level of music and 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);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(AudioEffectCompressor other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static AudioEffectCompressor _new();

double getAttackUs();

double getGain();

double getMix();

double getRatio();

double getReleaseMs();

String getSidechain();

double getThreshold();

void setAttackUs(double attack_us);

void setGain(double gain);

void setMix(double mix);

void setRatio(double ratio);

void setReleaseMs(double release_ms);

void setSidechain(String sidechain);

void setThreshold(double threshold);

double attackUs [@property getter];

double attackUs [@property setter];

double gain [@property getter];

double gain [@property setter];

double mix [@property getter];

double mix [@property setter];

double ratio [@property getter];

double ratio [@property setter];

double releaseMs [@property getter];

double releaseMs [@property setter];

String sidechain [@property getter];

String sidechain [@property setter];

double threshold [@property getter];

double threshold [@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 typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AudioEffectCompressor other)
opEquals bool opEquals(typeof(null) n)
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(String sidechain)
setThreshold void setThreshold(double threshold)
toHash size_t toHash()

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, in microseconds. Value can range from 20 to 2000.
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).
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.
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, in milliseconds. Value can range from 20 to 2000.
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.

Static functions

_new AudioEffectCompressor _new(): Construct a new instance of AudioEffectCompressor. Note: use memnew!AudioEffectCompressor instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: 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 inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(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.

Meta

Source

See Implementation

godot audioeffectcompressor structs

AudioEffectCompressor