Firelight Technologies FMOD Studio API
ChannelControl::setReverbProperties
Sets the wet level (or send level) of a particular reverb instance.
C++ Syntax
FMOD_RESULT ChannelControl::setReverbProperties(
int instance,
float wet
);
Parameters
instance
Index of the particular reverb instance to target, from 0 to FMOD_REVERB_MAXINSTANCES inclusive.
wet
Send level for the signal to the reverb, from 0 (none) to 1.0 (full), default = 1.0 for Channels, 0.0 for ChannelGroups. See remarks.
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
A Channel is automatically connected to all existing reverb instances due to the default wet level of 1.0. A ChannelGroup however will not send to any reverb by default requiring an explicit call to this function.
A ChannelGroup reverb is optimal for the case where you want to send 1 mixed signal to the reverb, rather than a lot of individual channel reverb sends. It is advisable to do this to reduce CPU if you have many Channels inside a ChannelGroup.
Keep in mind when setting a wet level for a ChannelGroup, any Channels under that ChannelGroup will still have their existing sends to the reverb. To avoid this doubling up you should explicitly set the Channel wet levels to 0.0.
See Also
Version 1.10.03 Built on Feb 1, 2018