Class
CompressorSoundEffect
Adjusts the dynamic range of audio.
A CompressorSoundEffect is used to reduce the dynamic range of audio
by moving the highs and lows of a signal closer together. It does this by
lowering the volume of the highest parts of a source while at the same time
raising the overall volume. This type of effect is useful when you have many
sounds playing and you want to make sure the quieter ones are still audible.
This effect can be applied to either an individual Sound or
SoundGroup by parenting it to the desired instance.
A compressor has several properties which determine how it works. The
Threshold is the audio level where the
compressor will start to lower the volume. As soon as the source goes below
the threshold, the compressor will stop lowering the volume.
The Attack determines how long it takes
for the compressed effect to fully apply. After the threshold has been crossed
the compressor will lower the volume over time until the desired ratio has
been reached. It will take the time specified by
Attack to reach this ratio.
The Release determines how long it takes
for the compressor to remove its effect. After the volume of the source is
under the threshold, the compressor will restore the volume back to the
original over the time specified by
Release.
Along with lowering the volume when the sound has passed the threshold, a
compressor will also amplify the entire sound (after any threshold lowering
has taken effect). This allows quieter sounds to be amplified while louder
sounds can stay about the same. The
GainMakeup determines how much the
effect amplifies the sound.
Properties 6#
Attackfloat | The time the effect takes to become active after its
Threshold has been reached.ReadSafe |
GainMakeupfloat | The overall amplification applied to the effect's Sound or
SoundGroup after attenuation of sounds above the threshold.ReadSafe |
Ratiofloat | The ratio between the SideChain
sound effect, and this sound effect.ReadSafe |
Releasefloat | The time the effect takes to become inactive after its sound is below the
Threshold.ReadSafe |
SideChainInstance | Applies a ducking effect to the compressor sound effect. The behavior of
the sidechain depends on the Sound or SoundGroup linked to
it.ReadSafe |
Thresholdfloat | Volume level at which point the compressor applies its effect.ReadSafe |
Attack: float#
ReadSafe
The time the effect takes to become active after its
Threshold has been reached. Range
is 0.1 to 1 (default 0.1), measured in seconds.
GainMakeup: float#
ReadSafe
The overall amplification applied to the effect's Sound or
SoundGroup after attenuation of sounds above the threshold. Keep
in mind this amplification will occur as long as the effect is active,
regardless of whether the
Threshold has been reached or not.
Range is 0 to 30 (default 0), measured in dB.
Ratio: float#
ReadSafe
The ratio between the SideChain
sound effect, and this sound effect.
Release: float#
ReadSafe
The time the effect takes to become inactive after its sound is below the
Threshold. Range is 0 to 5
(default 0.1), measured in seconds.
SideChain: Instance#
ReadSafe
Applies a ducking effect to the compressor sound effect. The behavior of
the sidechain depends on the Sound or SoundGroup linked to
it.
Threshold: float#
ReadSafe
Volume level at which point the compressor applies its effect. If the
effect's Sound or SoundGroup is below the effect will not
attenuate the sound, although the
GainMakeup will still be applied.
Range is -80 to 0 (default 0), measured in dB.
Inherited members#
Inherited from SoundEffect 2
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild