Firelight Technologies FMOD Studio API

ChannelGroup::getVolume

Retrieves the volume level.

C++ Syntax

FMOD_RESULT ChannelGroup::getVolume(
  float *volume
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetVolume(
  FMOD_CHANNELGROUP *channelgroup,
  float *volume
);

C# Syntax

RESULT ChannelGroup.getVolume(
  out float volume
);

JavaScript Syntax

ChannelGroup.getVolume(
  volume                           // writes value to volume.val
);

Parameters

volume

Address of a variable to receive the linear volume level.

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::setVolume

Version 1.10.03 Built on Feb 1, 2018