Firelight Technologies FMOD Studio API

System::setReverbProperties

Sets parameters for the global reverb environment.
Reverb parameters can be set manually, or automatically using the pre-defined presets given in the fmod.h header.

C++ Syntax

FMOD_RESULT System::setReverbProperties(
  int instance,
  const FMOD_REVERB_PROPERTIES *prop
);

C Syntax

FMOD_RESULT FMOD_System_SetReverbProperties(
  FMOD_SYSTEM *system,
  int instance,
  const FMOD_REVERB_PROPERTIES *prop
);

Parameters

instance
Slot or instance index for the physical SFX reverb. You can have up to 4 reverbs (0 to 3) currently.
prop
Address of an FMOD_REVERB_PROPERTIES structure which defines the attributes for the reverb. Passing 0 or NULL to this function will delete the physical reverb.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

When you use this for the first time, FMOD will create a physical SFX reverb DSP unit that takes up several hundred kilobytes of memory and some CPU.
When you use the instance parameter, a physical SFX reverb DSP unit will be created for each instance that you specify.

To turn a reverb 'off' simply change its Room parameter to

See Also




Version 1.03.06 Built on Apr 17, 2014