High Fidelity API Reference

AudioEffectOptions

• Properties • Type Definitions •

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts • Server Entity Scripts • Assignment Client Scripts

Audio effect options used by the Audio API.

Create using new AudioEffectOptions(reverbOptions).

Properties

Name Type Summary
bandwidth number

The corner frequency (Hz) of the low-pass filter at reverb input.

Default Value: 10000

preDelay number

The delay (milliseconds) between dry signal and the onset of early reflections.

Default Value: 20

lateDelay number

The delay (milliseconds) between early reflections and the onset of reverb tail.

Default Value: 0

reverbTime number

The time (seconds) for the reverb tail to decay by 60dB, also known as RT60.

Default Value: 2

earlyDiffusion number

Adjusts the buildup of echo density in the early reflections, normally 100%.

Default Value: 100

lateDiffusion number

Adjusts the buildup of echo density in the reverb tail, normally 100%.

Default Value: 100

roomSize number

The apparent room size, from small (0%) to large (100%).

Default Value: 50

density number

Adjusts the echo density in the reverb tail, normally 100%.

Default Value: 100

bassMult number

Adjusts the bass-frequency reverb time, as multiple of reverbTime.

Default Value: 1.5

bassFreq number

The crossover frequency (Hz) for the onset of bassMult.

Default Value: 250

highGain number

Reduces the high-frequency reverb time, as attenuation (dB).

Default Value: -6

highFreq number

The crossover frequency (Hz) for the onset of highGain.

Default Value: 3000

modRate number

The rate of modulation (Hz) of the LFO-modulated delay lines.

Default Value: 2.3

modDepth number

The depth of modulation (percent) of the LFO-modulated delay lines.

Default Value: 50

earlyGain number

Adjusts the relative level (dB) of the early reflections.

Default Value: 0

lateGain number

Adjusts the relative level (dB) of the reverb tail.

Default Value: 0

earlyMixLeft number

The apparent distance of the source (percent) in the early reflections.

Default Value: 20

earlyMixRight number

The apparent distance of the source (percent) in the early reflections.

Default Value: 20

lateMixLeft number

The apparent distance of the source (percent) in the reverb tail.

Default Value: 90

lateMixRight number

The apparent distance of the source (percent) in the reverb tail.

Default Value: 90

wetDryMix number

Adjusts the wet/dry ratio, from completely dry (0%) to completely wet (100%).

Default Value: 50

Constructor
new AudioEffectOptions( reverbOptionsopt )

Parameters

Name Type Attributes Default Value Description
reverbOptions AudioEffectOptions.ReverbOptions <optional>
 null

Reverberation options.

Type Definitions

ReverbOptions
Type: object

Reverberation options that can be used to initialize an AudioEffectOptions object when created.

Properties

Name Type Summary
bandwidth number

The corner frequency (Hz) of the low-pass filter at reverb input.

Default Value: 10000

preDelay number

The delay (milliseconds) between dry signal and the onset of early reflections.

Default Value: 20

lateDelay number

The delay (milliseconds) between early reflections and the onset of reverb tail.

Default Value: 0

reverbTime number

The time (seconds) for the reverb tail to decay by 60dB, also known as RT60.

Default Value: 2

earlyDiffusion number

Adjusts the buildup of echo density in the early reflections, normally 100%.

Default Value: 100

lateDiffusion number

Adjusts the buildup of echo density in the reverb tail, normally 100%.

Default Value: 100

roomSize number

The apparent room size, from small (0%) to large (100%).

Default Value: 50

density number

Adjusts the echo density in the reverb tail, normally 100%.

Default Value: 100

bassMult number

Adjusts the bass-frequency reverb time, as multiple of reverbTime.

Default Value: 1.5

bassFreq number

The crossover frequency (Hz) for the onset of bassMult.

Default Value: 250

highGain number

Reduces the high-frequency reverb time, as attenuation (dB).

Default Value: -6

highFreq number

The crossover frequency (Hz) for the onset of highGain.

Default Value: 3000

modRate number

The rate of modulation (Hz) of the LFO-modulated delay lines.

Default Value: 2.3

modDepth number

The depth of modulation (percent) of the LFO-modulated delay lines.

Default Value: 50

earlyGain number

Adjusts the relative level (dB) of the early reflections.

Default Value: 0

lateGain number

Adjusts the relative level (dB) of the reverb tail.

Default Value: 0

earlyMixLeft number

The apparent distance of the source (percent) in the early reflections.

Default Value: 20

earlyMixRight number

The apparent distance of the source (percent) in the early reflections.

Default Value: 20

lateMixLeft number

The apparent distance of the source (percent) in the reverb tail.

Default Value: 90

lateMixRight number

The apparent distance of the source (percent) in the reverb tail.

Default Value: 90

wetDryMix number

Adjusts the wet/dry ratio, from completely dry (0%) to completely wet (100%).

Default Value: 50