FMOD_REVERB_PROPERTIES

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_REVERB_PROPERTIES

Structure defining a reverb environment.

C/C++ Syntax

typedef struct {
  float DecayTime;
  float EarlyDelay;
  float LateDelay;
  float HFReference;
  float HFDecayRatio;
  float Diffusion;
  float Density;
  float LowShelfFrequency;
  float LowShelfGain;
  float HighCut;
  float EarlyLateMix;
  float WetLevel;
} FMOD_REVERB_PROPERTIES;

JavaScript Syntax

struct FMOD_REVERB_PROPERTIES
{
  DecayTime,
  EarlyDelay,
  LateDelay,
  HFReference,
  HFDecayRatio,
  Diffusion,
  Density,
  LowShelfFrequency,
  LowShelfGain,
  HighCut,
  EarlyLateMix,
  WetLevel,
};

Members

DecayTime

[r/w] 0.0 20000.0 1500.0 Reverberation decay time (ms)

EarlyDelay

[r/w] 0.0 300.0 7.0 Initial reflection delay time (ms)

LateDelay

[r/w] 0.0 100 11.0 Late reverberation delay time relative to initial reflection (ms)

HFReference

[r/w] 20.0 20000.0 5000 Reference high frequency (Hz)

HFDecayRatio

[r/w] 10.0 100.0 50.0 High-frequency to mid-frequency decay time ratio (%)

Diffusion

[r/w] 0.0 100.0 100.0 Value that controls the echo density in the late reverberation decay (%)

Density

[r/w] 0.0 100.0 100.0 Value that controls the modal density in the late reverberation decay (%)

LowShelfFrequency

[r/w] 20.0 1000.0 250.0 Reference low frequency (Hz)

LowShelfGain

[r/w] -36.0 12.0 0.0 Relative room effect level at low frequencies (dB)

HighCut

[r/w] 20.0 20000.0 20000.0 Relative room effect level at high frequencies (Hz)

EarlyLateMix

[r/w] 0.0 100.0 50.0 Early reflections level relative to room effect (%)

WetLevel

[r/w] -80.0 20.0 -6.0 Room effect level at mid frequencies (dB)

Remarks

Note the default reverb properties are the same as the FMOD_PRESET_GENERIC preset.

All members are read/write [r/w], written to by FMOD when queried with System::getReverbProperties and read by FMOD when set with System::setReverbProperties.

JavaScript only :

Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.REVERB_PROPERTIES()", no 'new' keyword is required.

See Also



Version 1.10.03 Built on Feb 1, 2018