AudioCompressor¶
Not yet Class
Adjusts the dynamic range of input 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¶
AudioCompressor adjusts the dynamic range of audio streams. Any momentary bursts of loudness will be clamped down according to the compressor's properties.
AudioCompressor provides Input and Sidechain pins that can be targeted by Wire.TargetName, and an Output pin that can be used by Wire.SourceName.
Inheritance¶
Object → Instance → AudioCompressor
Properties¶
| Member | Signature | Summary |
|---|---|---|
Attack |
Attack: float |
Controls how quickly the compressor will clamp down on volume after it surpasses Threshold. |
Bypass |
Bypass: bool |
Whether audio streams are passed-through unaffected by this effect. |
Editor |
Editor: bool |
— |
MakeupGain |
MakeupGain: float |
A gain value to be applied after compression. |
Ratio |
Ratio: float |
Ratio of input volume to output volume, to be applied when surpassing Threshold. |
Release |
Release: float |
Controls how quickly the compressor will unclamp after the stream volume dips back below Threshold. |
Threshold |
Threshold: float |
Gain value at which the compressor will start to modify the input stream. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetConnectedWires |
AudioCompressor:GetConnectedWires(pin: string): Instances |
Returns an array of Wires that are connected to the specified pin. |
GetInputPins |
AudioCompressor: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 |
AudioCompressor: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 AudioCompressor via a Wire. |
Roblox reference: AudioCompressor
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.