AudioReverb
Reverberates audio streams.
| Memory category | Internal |
|---|
Member index 18
Description
AudioReverb reverberates audio streams, modeling the natural echoes of a room or enclosed space. It provides one Input pin and one Output pin which can be connected to/from by Wires.
History 50
- 726 Change Default of WetLevel from -6 to
- 726 Change Default of ReferenceFrequency from 5000 to
- 726 Change Default of LowShelfGain from 0 to
- 726 Change Default of LowShelfFrequency from 250 to
- 726 Change Default of LateDelayTime from 0.0399999991 to
- 726 Change Default of HighCutFrequency from 20000 to
- 726 Change Default of EarlyDelayTime from 0.0199999996 to
- 726 Change Default of DryLevel from 0 to
- 726 Change Default of Diffusion from 1 to
- 726 Change Default of Density from 1 to
- 726 Change Default of DecayTime from 1.5 to
- 726 Change Default of DecayRatio from 0.5 to
- 726 Change Default of Bypass from false to
- 660 Add GetOutputPins
- 660 Add GetInputPins
- 659 Add Reset
- 652 Add WiringChanged
- 648 Change ReturnType of GetConnectedWires from Objects to Instances
- 643 Change Tags of AudioReverb from [NotBrowsable] to []
- 637 Change ReturnType of GetConnectedWires from Array to Objects
- 636 Change Category of LowShelfGain from Data to State
- 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 AudioReverb from Instances to Internal
- 593 Add GetConnectedWires
- 592 Change Category of WetLevel from Data to State
- 592 Change Category of ReferenceFrequency from Data to State
- 592 Change Category of LowShelfFrequency from Data to State
- 592 Change Category of LateDelayTime from Data to State
- 592 Change Category of HighCutFrequency from Data to State
- 592 Change Category of EarlyDelayTime from Data to State
- 592 Change Category of DryLevel from Data to State
- 592 Change Category of Diffusion from Data to State
- 592 Change Category of Density from Data to State
- 592 Change Category of DecayTime from Data to State
- 592 Change Category of DecayRatio from Data to State
- 588 Add WetLevel
- 588 Add ReferenceFrequency
- 588 Add LowShelfGain
- 588 Add LowShelfFrequency
- 588 Add LateDelayTime
- 588 Add HighCutFrequency
- 588 Add EarlyDelayTime
- 588 Add DryLevel
- 588 Add Diffusion
- 588 Add Density
- 588 Add DecayTime
- 588 Add DecayRatio
- 588 Add AudioReverb
Members 18
Bypass
| Type | Default | |
|---|---|---|
| bool | ||
If true, audio streams are passed-through unaffected by this effect.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
DecayRatio
| Type | Default | |
|---|---|---|
| float | ||
A ratio of high frequency decay time to total decay time, where high frequencies are determined to be anything above ReferenceFrequency, in hertz. Ranges from 0.1 to 1.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 3
- 726 Change Default of DecayRatio from 0.5 to
- 592 Change Category of DecayRatio from Data to State
- 588 Add DecayRatio
DecayTime
| Type | Default | |
|---|---|---|
| float | ||
Time, in seconds, that it will take for the reverb to fully decay. Ranges from 0.1 to 20.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Density
| Type | Default | |
|---|---|---|
| float | ||
A number controlling how many reflections are generated. Ranges from 0.1 to 1.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Diffusion
| Type | Default | |
|---|---|---|
| float | ||
A number controlling how smooth and reflective the reverb's simulated surfaces are. Ranges from 0.1 to 1.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
DryLevel
| Type | Default | |
|---|---|---|
| float | ||
Gain level, in decibels, determining how loud the original, unaltered audio stream will be. Ranges from -80 to 20.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
EarlyDelayTime
| Type | Default | |
|---|---|---|
| float | ||
Time, in seconds, before any reverberation begins. Ranges from 0 to 0.3.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 3
- 726 Change Default of EarlyDelayTime from 0.0199999996 to
- 592 Change Category of EarlyDelayTime from Data to State
- 588 Add EarlyDelayTime
GetConnectedWires
| Parameters (1) | ||
|---|---|---|
| pin | string | |
| Returns (1) | ||
| Instances | ||
Returns an array of Wires that are connected to the specified pin. AudioReverb has one "Input" 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 AudioReverb, this is Input only.
| 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 AudioReverb, this is Output only.
| Thread safety | Unsafe |
|---|
History 1
- 660 Add GetOutputPins
HighCutFrequency
| Type | Default | |
|---|---|---|
| float | ||
Frequency, in hertz, which acts as a cutoff for a low-pass filter. Any audio that has a higher frequency than this is excluded from the reverb. Ranges from 20 to 20,000.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 3
- 726 Change Default of HighCutFrequency from 20000 to
- 592 Change Category of HighCutFrequency from Data to State
- 588 Add HighCutFrequency
LateDelayTime
| Type | Default | |
|---|---|---|
| float | ||
Time in seconds, following early delays, before diffuse reverberations begin. Ranges from 0 to 0.1.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 3
- 726 Change Default of LateDelayTime from 0.0399999991 to
- 592 Change Category of LateDelayTime from Data to State
- 588 Add LateDelayTime
LowShelfFrequency
| Type | Default | |
|---|---|---|
| float | ||
Frequency, in hertz, below which audio can be boosted or reduced in the reverb via LowShelfGain. Ranges from 20 to 20,000.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 3
- 726 Change Default of LowShelfFrequency from 250 to
- 592 Change Category of LowShelfFrequency from Data to State
- 588 Add LowShelfFrequency
LowShelfGain
| Type | Default | |
|---|---|---|
| float | ||
Gain level, in decibels, that controls the presence of low frequency content in the reverb. Ranges from -36 to 12.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 3
- 726 Change Default of LowShelfGain from 0 to
- 636 Change Category of LowShelfGain from Data to State
- 588 Add LowShelfGain
ReferenceFrequency
| Type | Default | |
|---|---|---|
| float | ||
Frequency, in hertz, that separates low frequency decay speeds from high frequency decay speeds. This is used by DecayRatio to determine whether low or high frequencies decay faster. Ranges from 20 to 20,000.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 3
- 726 Change Default of ReferenceFrequency from 5000 to
- 592 Change Category of ReferenceFrequency from Data to State
- 588 Add ReferenceFrequency
Reset
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
WetLevel
| Type | Default | |
|---|---|---|
| float | ||
Gain level, in decibels, determining how loud the reverberated stream will be. Ranges from -80 to 20.
| 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 AudioReverb and to some other wirable instance.
| Thread safety | Unsafe |
|---|
History 1
- 652 Add WiringChanged