Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioEqualizer

Adjusts the frequency content of audio streams.

Memory categoryInternal

Member index 10

HistoryMember
726Bypass: bool
726Editor: bool
726HighGain: float
726LowGain: float
726MidGain: float
726MidRange: NumberRange
648GetConnectedWires(pin: string): Instances
660GetInputPins(): Array
660GetOutputPins(): Array
652WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Description

AudioEqualizer adjusts the frequency content of audio streams. It provides one Input pin and one Output pin which can be connected to/from by Wires. AudioEqualizer has 3 frequency bands whose gain values can be controlled, and the crossover points between bands can be moved.

History 27

Members 10

Bypass

TypeDefault
bool

If true, audio streams are passed-through unaffected by this effect.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 2

Editor

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.
SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryState Editing
Loaded/Savedtrue/false

History 2

Tags: [NotReplicated]

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

Returns an array of Wires that are connected to the specified pin. AudioEqualizer has one "Input" pin and one "Output" pin.

Thread safetyUnsafe

History 5

GetInputPins

Parameters (0)
No parameters.
Returns (1)
Array

Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For AudioEqualizer, this is Input only.

Thread safetyUnsafe

History 1

GetOutputPins

Parameters (0)
No parameters.
Returns (1)
Array

Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For AudioEqualizer, this is Output only.

Thread safetyUnsafe

History 1

HighGain

TypeDefault
float

Gain value, in decibels, to be applied to the frequency content of the highest band in the equalizer. Ranges from -80 to 10.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 3

LowGain

TypeDefault
float

Gain value, in decibels, to be applied to the frequency content of the lowest band in the equalizer. Ranges from -80 to 10.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 3

MidGain

TypeDefault
float

Gain value, in decibels, to be applied to the frequency content of the middle band in the equalizer. Ranges from -80 to 10.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 3

MidRange

TypeDefault
NumberRange

The frequency range in hertz of the band influenced by MidGain. The lower value of the range determines the crossover frequency between the low and mid bands. The higher value of the range determines the crossover frequency between the mid and high bands. Both crossover frequencies range from 200 to 20,000.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 3

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance

Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the AudioEqualizer and to some other wirable instance.

Thread safetyUnsafe

History 1

Settings