Open Asterune
CompressorSoundEffect

CompressorSoundEffect

Reduces audio levels above a threshold.

Creatable
Instance.new("CompressorSoundEffect")
Inherits
SoundEffectInstance
Replication
Standard

Behavior

CompressorSoundEffect reduces audio levels above a threshold.

Summary

Members8
Properties7
  • Attack: number = 0.1parallel read

    The compressor response time when a signal exceeds the threshold.

  • Enabled: boolean = trueparallel read

    Whether this effect processes the audio signal.

  • GainMakeup: number = 0parallel read

    The output gain added after compression.

  • Priority: number = 0parallel read

    The relative priority used to order or process this object.

  • Ratio: number = 2parallel read

    The compression ratio applied above the threshold.

  • Release: number = 0.1parallel read

    The compressor response time when a signal drops below the threshold.

  • Threshold: number = -20parallel read

    The input level above which compression is applied.

Methods1

Properties

Attack

CompressorSoundEffect.Attack: number = 0.1

The compressor response time when a signal exceeds the threshold.

Enabled

CompressorSoundEffect.Enabled: boolean = true

Whether this effect processes the audio signal.

GainMakeup

CompressorSoundEffect.GainMakeup: number = 0

The output gain added after compression.

Priority

CompressorSoundEffect.Priority: number = 0

The relative priority used to order or process this object.

Ratio

CompressorSoundEffect.Ratio: number = 2

The compression ratio applied above the threshold.

Release

CompressorSoundEffect.Release: number = 0.1

The compressor response time when a signal drops below the threshold.

Threshold

CompressorSoundEffect.Threshold: number = -20

The input level above which compression is applied.

Methods

GetExecutionGroup

CompressorSoundEffect:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

Inherited members

Inherited47
Instance47
Properties
ArchivableClassNameNameParent
Methods
AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
Events
AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying

Related APIs

SoundEffect