Reference API Roblox

Engine API

Website

Related

Reference API Roblox

EqualizerSoundEffect

Controls the volume of incoming audio across three frequency ranges.

Memory categoryInstances

Member index 3

HistoryMember
553HighGain: float
553LowGain: float
553MidGain: float
inherited from SoundEffect
553Enabled: bool
553Priority: int
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

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 13

Members 3

HighGain

TypeDefault
float0

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

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

LowGain

TypeDefault
float-20

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

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

MidGain

TypeDefault
float-10

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

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Settings