Reference API Roblox

Engine API

Website

Related

Reference API Roblox

EqualizerSoundEffect

Controls the volume of incoming audio across three frequency ranges.

Member index 3

HistoryMember
731HighGain: float
731LowGain: float
731MidGain: float
inherited from SoundEffect
731Enabled: bool
731Priority: int
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

An equalizer allows for control of the volume of various frequency ranges for the Sound or SoundGroup the effect is parented to. This can be used to highlight particular elements of audio or minimize or outright eliminate others. The EqualizerSoundEffect gives control over three ranges of frequency: Low, Mid, and High. Their specific frequencies are as follows:

  • Low: 0 - 400 Hz
  • Mid: 400 - 4000 Hz
  • High: 4000+ Hz

History 19

Members 3

HighGain

TypeDefault
float0

Range: -80 to 10 (default 0) The output volume of frequencies greater than 4000 Hz. Measured in dB.

History 6

LowGain

TypeDefault
float-20

Range: -80 to 10 (default 0) The output volume of frequencies lower than 400 Hz. Measured in dB.

History 6

MidGain

TypeDefault
float-10

Range: -80 to 10 (default 0) The output volume of frequencies between 400 and 4000 Hz. Measured in dB.

History 6

Settings