Open Asterune
EqualizerSoundEffect

EqualizerSoundEffect

Adjusts the gain of low, middle, and high audio frequencies.

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

Behavior

EqualizerSoundEffect adjusts the gain of low, middle, and high audio frequencies.

Summary

Members9
Properties8
  • Enabled: boolean = trueparallel read

    Whether this effect processes the audio signal.

  • HighFrequency: number = 4000parallel read

    The frequency boundary of the high equalizer band.

  • HighGain: number = 0parallel read

    The gain applied to the high-frequency band.

  • LowFrequency: number = 400parallel read

    The frequency boundary of the low equalizer band.

  • LowGain: number = 0parallel read

    The gain applied to the low-frequency band.

  • MidFrequency: number = 1000parallel read

    The center frequency of the middle equalizer band.

  • MidGain: number = 0parallel read

    The gain applied to the middle-frequency band.

  • Priority: number = 0parallel read

    The relative priority used to order or process this object.

Methods1

Properties

Enabled

EqualizerSoundEffect.Enabled: boolean = true

Whether this effect processes the audio signal.

HighFrequency

EqualizerSoundEffect.HighFrequency: number = 4000

The frequency boundary of the high equalizer band.

HighGain

EqualizerSoundEffect.HighGain: number = 0

The gain applied to the high-frequency band.

LowFrequency

EqualizerSoundEffect.LowFrequency: number = 400

The frequency boundary of the low equalizer band.

LowGain

EqualizerSoundEffect.LowGain: number = 0

The gain applied to the low-frequency band.

MidFrequency

EqualizerSoundEffect.MidFrequency: number = 1000

The center frequency of the middle equalizer band.

MidGain

EqualizerSoundEffect.MidGain: number = 0

The gain applied to the middle-frequency band.

Priority

EqualizerSoundEffect.Priority: number = 0

The relative priority used to order or process this object.

Methods

GetExecutionGroup

EqualizerSoundEffect: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