Firelight Technologies FMOD Studio API

ChannelGroup::setFadePointRamp

Add a short 64 sample volume ramp to the specified time in the future using fade points.

C++ Syntax

FMOD_RESULT ChannelGroup::setFadePointRamp(
  unsigned long long dspclock,
  float volume
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_SetFadePointRamp(
  FMOD_CHANNELGROUP *channelgroup,
  unsigned long long dspclock,
  float volume
);

C# Syntax

RESULT ChannelGroup.setFadePointRamp(
  ulong dspclock,
  float volume
);

JavaScript Syntax

ChannelGroup.setFadePointRamp(
  dspclock,                        
  volume                           
);

Parameters

dspclock

DSP clock of the parent channel group when the volume will be ramped to.

volume

Volume level where 0 is silent and 1.0 is normal volume. Amplification is supported.

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 is a helper function that automatically ramps from the current fade volume to the newly provided volume at a specified time. It will clear any fade points set after this time. Use in conjunction with ChannelControl::setDelay stop delay, to ramp down volume before it stops. The user would specify the same clock value for the fade ramp and stop delay. This can also be used as a way to provide sample accurate delayed volume changes without clicks.

See Also

• ChannelControl::setDelay
• ChannelControl::removeFadePoints
• ChannelControl::addFadePoint
• ChannelControl::getFadePoints

Version 1.10.03 Built on Feb 1, 2018