Firelight Technologies FMOD Studio API

System::getReverbProperties

Retrieves the current reverb environment for the specified reverb instance.

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

C# Syntax

RESULT System.getReverbProperties(
  int instance,
  out REVERB_PROPERTIES prop
);

JavaScript Syntax

System.getReverbProperties(
  instance,                        
  prop                             // writes value to prop.val
);

Parameters

instance

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

prop

Address of a variable that receives the current reverb environment description.

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.

See Also

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

Version 1.10.03 Built on Feb 1, 2018