AudioEffectOptions

Available in: Interface Scripts Client Entity Scripts Server Entity Scripts Assignment Client Scripts

Audio effect options used by the Audio API.

Create using new AudioEffectOptions(reverbOptions).

Type Definitions

Parameters:
Name Type Attributes Default Description
reverbOptions AudioEffectOptions.ReverbOptions <optional>
null Reverberation options.
Properties:
Name Type Default Description
bandwidth number 10000 The corner frequency (Hz) of the low-pass filter at reverb input.
preDelay number 20 The delay (milliseconds) between dry signal and the onset of early reflections.
lateDelay number 0 The delay (milliseconds) between early reflections and the onset of reverb tail.
reverbTime number 2 The time (seconds) for the reverb tail to decay by 60dB, also known as RT60.
earlyDiffusion number 100 Adjusts the buildup of echo density in the early reflections, normally 100%.
lateDiffusion number 100 Adjusts the buildup of echo density in the reverb tail, normally 100%.
roomSize number 50 The apparent room size, from small (0%) to large (100%).
density number 100 Adjusts the echo density in the reverb tail, normally 100%.
bassMult number 1.5 Adjusts the bass-frequency reverb time, as multiple of reverbTime.
bassFreq number 250 The crossover frequency (Hz) for the onset of bassMult.
highGain number -6 Reduces the high-frequency reverb time, as attenuation (dB).
highFreq number 3000 The crossover frequency (Hz) for the onset of highGain.
modRate number 2.3 The rate of modulation (Hz) of the LFO-modulated delay lines.
modDepth number 50 The depth of modulation (percent) of the LFO-modulated delay lines.
earlyGain number 0 Adjusts the relative level (dB) of the early reflections.
lateGain number 0 Adjusts the relative level (dB) of the reverb tail.
earlyMixLeft number 20 The apparent distance of the source (percent) in the early reflections.
earlyMixRight number 20 The apparent distance of the source (percent) in the early reflections.
lateMixLeft number 90 The apparent distance of the source (percent) in the reverb tail.
lateMixRight number 90 The apparent distance of the source (percent) in the reverb tail.
wetDryMix number 50 Adjusts the wet/dry ratio, from completely dry (0%) to completely wet (100%).

Type Definitions

ReverbOptions
Reverberation options that can be used to initialize an AudioEffectOptions object when created.
Type: object
Properties:
Name Type Default Description
bandwidth number 10000 The corner frequency (Hz) of the low-pass filter at reverb input.
preDelay number 20 The delay (milliseconds) between dry signal and the onset of early reflections.
lateDelay number 0 The delay (milliseconds) between early reflections and the onset of reverb tail.
reverbTime number 2 The time (seconds) for the reverb tail to decay by 60dB, also known as RT60.
earlyDiffusion number 100 Adjusts the buildup of echo density in the early reflections, normally 100%.
lateDiffusion number 100 Adjusts the buildup of echo density in the reverb tail, normally 100%.
roomSize number 50 The apparent room size, from small (0%) to large (100%).
density number 100 Adjusts the echo density in the reverb tail, normally 100%.
bassMult number 1.5 Adjusts the bass-frequency reverb time, as multiple of reverbTime.
bassFreq number 250 The crossover frequency (Hz) for the onset of bassMult.
highGain number -6 Reduces the high-frequency reverb time, as attenuation (dB).
highFreq number 3000 The crossover frequency (Hz) for the onset of highGain.
modRate number 2.3 The rate of modulation (Hz) of the LFO-modulated delay lines.
modDepth number 50 The depth of modulation (percent) of the LFO-modulated delay lines.
earlyGain number 0 Adjusts the relative level (dB) of the early reflections.
lateGain number 0 Adjusts the relative level (dB) of the reverb tail.
earlyMixLeft number 20 The apparent distance of the source (percent) in the early reflections.
earlyMixRight number 20 The apparent distance of the source (percent) in the early reflections.
lateMixLeft number 90 The apparent distance of the source (percent) in the reverb tail.
lateMixRight number 90 The apparent distance of the source (percent) in the reverb tail.
wetDryMix number 50 Adjusts the wet/dry ratio, from completely dry (0%) to completely wet (100%).