Firelight Technologies FMOD Studio API

System::setReverbProperties

Sets parameters for the global reverb environment.

To assist in defining reverb properties there are several presets available, see FMOD_REVERB_PRESETS

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
);

C# Syntax

RESULT System.setReverbProperties(
  int instance,
  ref REVERB_PROPERTIES prop
);

JavaScript Syntax

System.setReverbProperties(
  instance,                        
  prop                             
);

Parameters

instance

Index of the particular reverb instance to target, from 0 to FMOD_REVERB_MAXINSTANCES inclusive.

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 using each instance for the first time, FMOD will create a physical SFX reverb DSP unit that takes up several hundred kilobytes of memory and some CPU.

See Also

• FMOD_REVERB_PROPERTIES
• FMOD_REVERB_PRESETS
• System::getReverbProperties
• ChannelControl::setReverbProperties
• ChannelControl::getReverbProperties

Version 1.10.03 Built on Feb 1, 2018