AudioReverb
Reverberates audio streams.
| Memory category | Internal |
|---|
Member index 14
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 31
- 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 14
Bypass
| Type | Default | |
|---|---|---|
| bool | false | |
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
DecayRatio
| Type | Default | |
|---|---|---|
| float | 0.5 | |
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 2
- 592 Change Category of DecayRatio from Data to State
- 588 Add DecayRatio
DecayTime
| Type | Default | |
|---|---|---|
| float | 1.5 | |
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 | 1 | |
A number controlling how many reflections are generated. Ranges from 0 to 1.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
Diffusion
| Type | Default | |
|---|---|---|
| float | 1 | |
A number controlling how smooth and reflective the reverb's simulated surfaces are. Ranges from 0 to 1.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
DryLevel
| Type | Default | |
|---|---|---|
| float | 0 | |
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 | 0.0199999996 | |
Time, in seconds, before any reverberation begins. Ranges from 0 to 0.3.
| Thread safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
History 2
- 592 Change Category of EarlyDelayTime from Data to State
- 588 Add EarlyDelayTime
GetConnectedWires
| Parameters (1) | ||
|---|---|---|
| pin | string | |
| Returns (1) | ||
| Objects | ||
| Thread safety | Unsafe |
|---|
History 4
- 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
HighCutFrequency
| Type | Default | |
|---|---|---|
| float | 20000 | |
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 2
- 592 Change Category of HighCutFrequency from Data to State
- 588 Add HighCutFrequency
LateDelayTime
| Type | Default | |
|---|---|---|
| float | 0.0399999991 | |
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 2
- 592 Change Category of LateDelayTime from Data to State
- 588 Add LateDelayTime
LowShelfFrequency
| Type | Default | |
|---|---|---|
| float | 250 | |
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 2
- 592 Change Category of LowShelfFrequency from Data to State
- 588 Add LowShelfFrequency
LowShelfGain
| Type | Default | |
|---|---|---|
| float | 0 | |
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 2
- 636 Change Category of LowShelfGain from Data to State
- 588 Add LowShelfGain
ReferenceFrequency
| Type | Default | |
|---|---|---|
| float | 5000 | |
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 2
- 592 Change Category of ReferenceFrequency from Data to State
- 588 Add ReferenceFrequency
WetLevel
| Type | Default | |
|---|---|---|
| float | -6 | |
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 |