Firelight Technologies FMOD Studio API
Studio::EventInstance::setReverbLevel
Sets the send level to a Low Level reverb instance.
C++ Syntax
FMOD_RESULT Studio::EventInstance::setReverbLevel(
int index,
float level
);
C Syntax
FMOD_RESULT FMOD_Studio_EventInstance_SetReverbLevel(
FMOD_STUDIO_EVENTINSTANCE *eventinstance,
int index,
float level
);
C# Syntax
RESULT Studio.EventInstance.setReverbLevel(
int index,
float level
);
JavaScript Syntax
EventInstance.setReverbLevel(
index,
level
);
Parameters
- index
- Index of the Low Level reverb instance to target, from 0 to 3.
- level
- Send level for the signal to the reverb, from 0 (none) to 1 (full). Default = 0.
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
This function controls the signal to be sent from the event instance to a Low Level reverb instance.
NOTE: Use this function in preference to obtaining the event's ChannelGroup via Studio::EventInstance::getChannelGroup and calling ChannelGroup::setReverbProperties directly. This function is safe to use anytime.
See Also
Version 1.10.03 Built on Feb 1, 2018