Channel::getReverbProperties

FMOD Studio API

Firelight Technologies FMOD Studio API

Channel::getReverbProperties

Retrieves the wet level (or send level) for a particular reverb instance.

C++ Syntax

FMOD_RESULT Channel::getReverbProperties(
  int instance,
  float *wet
);

C Syntax

FMOD_RESULT FMOD_Channel_GetReverbProperties(
  FMOD_CHANNEL *channel,
  int instance,
  float *wet
);

C# Syntax

RESULT Channel.getReverbProperties(
  int instance,
  out float wet
);

JavaScript Syntax

Channel.getReverbProperties(
  instance,                        
  wet                              // writes value to wet.val
);

Parameters

instance
Index of the particular reverb instance to target, from 0 to FMOD_REVERB_MAXINSTANCES inclusive.
wet
Address of a variable that receives the send level for the signal to the reverb, from 0 (none) to 1.0 (full).

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




Version 1.10.03 Built on Feb 1, 2018