Firelight Technologies FMOD Studio API

ChannelGroup::getFadePoints

Retrieve information about fade points stored within a Channel or ChannelGroup.

C++ Syntax

FMOD_RESULT ChannelGroup::getFadePoints(
  unsigned int *numpoints,
  unsigned long long *point_dspclock,
  float *point_volume
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetFadePoints(
  FMOD_CHANNELGROUP *channelgroup,
  unsigned int *numpoints,
  unsigned long long *point_dspclock,
  float *point_volume
);

C# Syntax

RESULT ChannelGroup.getFadePoints(
  ref uint numpoints,
  ulong[] point_dspclock,
  float[] point_volume
);

JavaScript Syntax

ChannelGroup.getFadePoints(
  numpoints,                       // writes value to numpoints.val
  point_dspclock,                  // writes value to point_dspclock.val
  point_volume                     // writes value to point_volume.val
);

Parameters

numpoints

Address of a variable to receive the number of fade points stored within the Channel or ChannelGroup.

point_dspclock

Address of a variable to receive an array of 64bit clock values. Can be 0 or NULL.

point_volume

Address of a variable to receive an array of floating point volume values. Can be 0 or NULL.

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

To first get the number of points for memory purposes, and not store any data, call this function with point_dpsclock and point_volume parameters being 0 or NULL.

See Also

• ChannelControl::addFadePoint
• ChannelControl::removeFadePoints

Version 1.10.03 Built on Feb 1, 2018