Firelight Technologies FMOD Studio API

FMOD_REVERB_PROPERTIES

Structure defining a reverb environment for FMOD_SOFTWARE based sounds only.

Structure

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;

Members

DecayTime

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

EarlyDelay

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

LateDelay

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

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

HighCut

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

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)

Remarks

Note the default reverb properties are the same as the FMOD_PRESET_GENERIC preset.
Note that integer values that typically range from -10,000 to 1000 are represented in decibels, and are of a logarithmic scale, not linear, wheras float values are always linear.

The numerical values listed below are the maximum, minimum and default values for each variable respectively.

Hardware voice / Platform Specific reverb support.
WII See FMODWII.H for hardware specific reverb functionality.
3DS See FMOD3DS.H for hardware specific reverb functionality.
PSP See FMODWII.H for hardware specific reverb functionality.

Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.
Members marked with [w] mean the variable can be written to. The user can set the value.
Members marked with [r/w] are either read or write depending on if you are using System::setReverbProperties (w) or System::getReverbProperties (r).

See Also




Version 1.03.06 Built on Apr 17, 2014