AudioFilter¶
Not yet Class
Adjusts the frequency content of audio streams.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 17 modern Roblox members not implemented yet
Description¶
AudioFilter adjusts the frequency content of audio streams. It provides one Input pin and one Output pin which can be connected to/from by Wires. AudioFilter uses its FilterType, Gain, and Q properties to determine what to do around a particular cutoff Frequency.
Inheritance¶
Object → Instance → AudioFilter
Properties¶
| Member | Signature | Summary |
|---|---|---|
Bypass |
Bypass: bool |
Whether audio streams are passed-through unaffected by this effect. |
Editor |
Editor: bool |
— |
FilterType |
FilterType: AudioFilterType |
The curve type of the band represented by the filter. |
Frequency |
Frequency: float |
The central frequency that the filter acts around. |
Gain |
Gain: float |
For peaking and shelving filters, controls volume increase or reduction. |
Q |
Q: float |
For peaking, lowpass, highpass, bandpass, and notch filters, controls the selectiveness or resonance. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetConnectedWires |
AudioFilter:GetConnectedWires(pin: string): Instances |
Returns an array of Wires that are connected to the specified pin. |
GetGainAt |
AudioFilter:GetGainAt(frequency: float): float |
Returns the magnitude response of the filter at the given frequency. |
GetInputPins |
AudioFilter:GetInputPins(): Array |
Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its [Wire.TargetInstance](Wire.md#targetinsta… |
GetOutputPins |
AudioFilter:GetOutputPins(): Array |
Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its [Wire.SourceInstance](Wire.md#sourceinsta… |
Events¶
| Member | Signature | Summary |
|---|---|---|
WiringChanged |
WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance) |
Fires when another instance is connected to or disconnected from the AudioFilter via a Wire. |
Roblox reference: AudioFilter
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.