Firelight Technologies FMOD Studio API
ChannelGroup::setVolumeRamp
Sets whether the channel automatically ramps when setting volumes.
C++ Syntax
FMOD_RESULT ChannelGroup::setVolumeRamp(
bool ramp
);
C Syntax
FMOD_RESULT FMOD_ChannelGroup_SetVolumeRamp(
FMOD_CHANNELGROUP *channelgroup,
FMOD_BOOL ramp
);
C# Syntax
RESULT ChannelGroup.setVolumeRamp(
bool ramp
);
JavaScript Syntax
ChannelGroup.setVolumeRamp(
ramp
);
Parameters
- ramp
- Whether to enable volume ramping.
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
When changing volumes on a non-paused channel, FMOD normally adds a small ramp to avoid a pop sound. This function allows that setting to be overriden and volume changes to be applied immediately.
See Also
Version 1.10.03 Built on Feb 1, 2018