AudioCompressor
Adjusts the dynamic range of input streams.
| Memory category | Internal |
|---|
Member index 11
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.
History 30
- 726 Change Default of Threshold from -40 to
- 726 Change Default of Release from 0.100000001 to
- 726 Change Default of Ratio from 40 to
- 726 Change Default of MakeupGain from 0 to
- 726 Change Default of Editor from false to
- 726 Change Default of Bypass from false to
- 726 Change Default of Attack from 0.100000001 to
- 660 Add GetOutputPins
- 660 Add GetInputPins
- 655 Add Editor
- 652 Add WiringChanged
- 648 Change ReturnType of GetConnectedWires from Objects to Instances
- 643 Change Tags of AudioCompressor from [NotBrowsable] to []
- 637 Change ReturnType of GetConnectedWires from Array to Objects
- 628 Add Bypass
- 618 Change Security of GetConnectedWires from PluginSecurity to None
- 607 Change Security of GetConnectedWires from RobloxScriptSecurity to PluginSecurity
- 597 Change MemoryCategory of AudioCompressor from Instances to Internal
- 593 Add GetConnectedWires
- 592 Change Category of Threshold from Data to State
- 592 Change Category of Release from Data to State
- 592 Change Category of Ratio from Data to State
- 592 Change Category of MakeupGain from Data to State
- 592 Change Category of Attack from Data to State
- 588 Add Threshold
- 588 Add Release
- 588 Add Ratio
- 588 Add MakeupGain
- 588 Add Attack
- 588 Add AudioCompressor
Members 11
Attack
| Type | Default | |
|---|---|---|
| float | ||
Time, in seconds, denoting how quickly the compressor will clamp down on volume after it surpasses Threshold. Ranges from 0.0001 to 0.5.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Bypass
| Type | Default | |
|---|---|---|
| bool | ||
If true, audio streams are passed-through unaffected by this effect.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Editor
| Type | Default | |
|---|---|---|
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | State Editing |
| Loaded/Saved | true/false |
GetConnectedWires
| Parameters (1) | ||
|---|---|---|
| pin | string | |
| Returns (1) | ||
| Instances | ||
Returns an array of Wires that are connected to the specified pin. AudioCompressor has one "Input" pin, one "Sidechain" pin, and one "Output" pin.
| Thread safety | Unsafe |
|---|
History 5
- 648 Change ReturnType of GetConnectedWires from Objects to Instances
- 637 Change ReturnType of GetConnectedWires from Array to Objects
- 618 Change Security of GetConnectedWires from PluginSecurity to None
- 607 Change Security of GetConnectedWires from RobloxScriptSecurity to PluginSecurity
- 593 Add GetConnectedWires
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 AudioCompressor, these are:
InputSidechain
| Thread safety | Unsafe |
|---|
History 1
- 660 Add GetInputPins
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 AudioCompressor, this is Output only.
| Thread safety | Unsafe |
|---|
History 1
- 660 Add GetOutputPins
MakeupGain
| Type | Default | |
|---|---|---|
| float | ||
Gain value to be applied after compression, in decibels. After limiting the dynamic range, the resulting stream may be very quiet and this property can be used to compensate. Ranges from -30 to 30.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 3
- 726 Change Default of MakeupGain from 0 to
- 592 Change Category of MakeupGain from Data to State
- 588 Add MakeupGain
Ratio
| Type | Default | |
|---|---|---|
| float | ||
Ratio of input volume to output volume, to be applied when surpassing Threshold. For example, a value of 2 will cut the amount by which the input stream exceeds the threshold in half whenever the input stream does so. Ranges from 1 to 50.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Release
| Type | Default | |
|---|---|---|
| float | ||
Time, in seconds, denoting how quickly the compressor will unclamp after its stream volume dips back below Threshold. Ranges from 0.01 to 5.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Threshold
| Type | Default | |
|---|---|---|
| float | ||
Gain value at which the compressor will start to modify the input stream, in decibels, with a range of -60 to 0. When the input stream's volume surpasses Threshold, the compressor will take Attack seconds to kick in. When the input stream's volume recedes below Threshold, the compressor will take Release seconds to stop acting.
If any Wires are connected to the Sidechain pin of the compressor, this threshold analyzes those streams instead of the Input streams; this can be used to duck the volume of one stream in response to another.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
WiringChanged
| Parameters (4) | |
|---|---|
| connected | bool |
| 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 AudioCompressor and to some other wirable instance.
| Thread safety | Unsafe |
|---|
History 1
- 652 Add WiringChanged