Firelight Technologies FMOD Studio API

SoundGroup::getVolume

Retrieves the volume for the sounds within a soundgroup.

C++ Syntax

FMOD_RESULT SoundGroup::getVolume(
  float *volume
);

C Syntax

FMOD_RESULT FMOD_SoundGroup_GetVolume(
  FMOD_SOUNDGROUP *soundgroup,
  float *volume
);

C# Syntax

RESULT SoundGroup.getVolume(
  out float volume
);

JavaScript Syntax

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

Parameters

volume

Address of a variable to receive the soundgroup volume level, 0.0 = silent, 1.0 = full volume. Default = 1.0. Negative volumes and amplification (> 1.0) are 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.

See Also

• SoundGroup::setVolume
• System::createSoundGroup
• System::getMasterSoundGroup

Version 1.10.03 Built on Feb 1, 2018