Firelight Technologies FMOD Studio API
SoundGroup::setVolume
Sets the volume for a sound group, affecting all channels playing the sounds in this soundgroup.
C++ Syntax
FMOD_RESULT SoundGroup::setVolume(
float volume
);
C Syntax
FMOD_RESULT FMOD_SoundGroup_SetVolume(
FMOD_SOUNDGROUP *soundgroup,
float volume
);
C# Syntax
RESULT SoundGroup.setVolume(
float volume
);
JavaScript Syntax
SoundGroup.setVolume(
volume
);
Parameters
- volume
- A linear 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
Version 1.10.03 Built on Feb 1, 2018