Firelight Technologies FMOD Studio API

System::getReverbProperties

Retrieves the current reverb environment for the specified reverb instance. You must specify the 'Instance' value (usually 0 unless you are using multiple reverbs) before calling this function.

C++ Syntax

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

C Syntax

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

Parameters

instance

Reverb instance number. Must be between 0 and 3 inclusive.

prop

Address of a variable that receives the current reverb environment description. Make sure the 'Instance' value is specified.

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

Note! It is important to specify the 'Instance' value in the FMOD_REVERB_PROPERTIES structure correctly, otherwise you will get an FMOD_ERR_REVERB_INSTANCE error.

See Also

• FMOD_REVERB_PROPERTIES
• System::setReverbProperties
• Channel::setReverbProperties
• Channel::getReverbProperties

Version 1.03.06 Built on Apr 17, 2014