Firelight Technologies FMOD Studio API

ChannelGroup::getVolumeRamp

Retrieves whether volume ramp is enabled.

C++ Syntax

FMOD_RESULT ChannelGroup::getVolumeRamp(
  bool *ramp
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetVolumeRamp(
  FMOD_CHANNELGROUP *channelgroup,
  FMOD_BOOL *ramp
);

C# Syntax

RESULT ChannelGroup.getVolumeRamp(
  out bool ramp
);

JavaScript Syntax

ChannelGroup.getVolumeRamp(
  ramp                             // writes value to ramp.val
);

Parameters

ramp

Address of a variable to receive the volume ramp state.

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.

See Also

• ChannelControl::setVolumeRamp

Version 1.10.03 Built on Feb 1, 2018