Class
AudioEqualizer
Adjusts the frequency content of audio streams.
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.
Properties 5#
Bypassboolean | Whether audio streams are passed-through unaffected by this effect.ReadSafe |
HighGainfloat | Gain value to be applied to the frequency content of the highest band in the equalizer.ReadSafe |
LowGainfloat | Gain value to be applied to the frequency content of the lowest band in the equalizer.ReadSafe |
MidGainfloat | Gain value to be applied to the frequency content of the middle band in the equalizer.ReadSafe |
MidRangeNumberRange | The frequency range of the band influenced by
MidGain.ReadSafe |
Bypass: boolean#
ReadSafe
If true, audio streams are passed-through unaffected by this effect.
HighGain: float#
ReadSafe
Gain value, in decibels, to be applied to the frequency content of the highest band in the equalizer. Ranges from -80 to 10.
LowGain: float#
ReadSafe
Gain value, in decibels, to be applied to the frequency content of the lowest band in the equalizer. Ranges from -80 to 10.
MidGain: float#
ReadSafe
Gain value, in decibels, to be applied to the frequency content of the middle band in the equalizer. Ranges from -80 to 10.
MidRange: NumberRange#
ReadSafe
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.
Methods 3#
| GetConnectedWires | Returns an array of Wires that are connected to the specified
pin. |
| GetInputPins | Gets the list of pins that Wire can use in Wire.TargetName
to connect to this instance via its Wire.TargetInstance property. |
| GetOutputPins | Gets the list of pins that Wire can use in Wire.SourceName
to connect to this instance via its Wire.SourceInstance property. |
GetConnectedWires(pin: string): List<Wire>#
Returns an array of Wires that are connected to the specified
pin. AudioEqualizer has one "Input" pin and one "Output" pin.
| Name | Type | Default | Description |
|---|---|---|---|
pin | string | An input or output pin on this instance |
Returns
List<Wire>— An array ofWires
GetInputPins(): 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.
Returns
Array— An array of strings representing valid pin names.
GetOutputPins(): 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.
Returns
Array— An array of strings representing valid pin names.
Events 1#
| WiringChanged | Fires when another instance is connected to or disconnected from the
AudioEqualizer via a Wire. |
WiringChanged(connected: boolean, pin: string, wire: Wire, instance: Instance)#
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.
| Name | Type | Default | Description |
|---|---|---|---|
connected | boolean | Whether the instance got connected or disconnected. | |
pin | string | The pin on the AudioEqualizer that the Wire targets. | |
wire | Wire | The Wire between the AudioEqualizer and the other
instance. | |
instance | Instance | The other instance that is or was connected through the Wire. |
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild