Firelight Technologies FMOD Studio API

Channel::setVolumeRamp

Sets whether the channel automatically ramps when setting volumes.

C++ Syntax

FMOD_RESULT Channel::setVolumeRamp(
  bool ramp
);

C Syntax

FMOD_RESULT FMOD_Channel_SetVolumeRamp(
  FMOD_CHANNEL *channel,
  FMOD_BOOL 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

• ChannelControl::getVolumeRamp

Version 1.03.06 Built on Apr 17, 2014