Click or drag to resize

AudioEffectCompressor Properties

The AudioEffectCompressor type exposes the following members.

Properties
  NameDescription
Public propertyAttackUs

Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000.

Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyGain

Gain applied to the output signal.

Public propertyMix

Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet).

Public propertyNativeInstance (Inherited from Object.)
Public propertyRatio

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.

Public propertyReleaseMs

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.

Public propertyResourceLocalToScene

If true, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

(Inherited from Resource.)
Public propertyResourceName

The name of the resource. This is an optional identifier. If ResourceName is not empty, its value will be displayed to represent the current resource in the editor inspector. For built-in scripts, the ResourceName will be displayed as the tab name in the script editor.

(Inherited from Resource.)
Public propertyResourcePath

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

(Inherited from Resource.)
Public propertySidechain

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

Public propertyThreshold

The level above which compression is applied to the audio. Value can range from -60 to 0.

Top
See Also