Firelight Technologies FMOD Studio API

ChannelGroup::addFadePoint

Add a volume point to fade from or towards, using a clock offset and 0 to 1 volume level.

C++ Syntax

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

C Syntax

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

Parameters

dspclock

DSP clock of the parent channel group to set the fade point volume.

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

For every fade point, FMOD will do a per sample volume ramp between them. It will scale with the current Channel or ChannelGroup's volume.

See Also

• ChannelControl::removeFadePoints
• ChannelControl::getFadePoints

Version 1.03.06 Built on Apr 17, 2014