Firelight Technologies FMOD Studio API
Studio::EventInstance::setVolume
Sets the volume level of the event instance.
C++ Syntax
FMOD_RESULT Studio::EventInstance::setVolume(
float volume
);
C Syntax
FMOD_RESULT FMOD_Studio_EventInstance_SetVolume(
FMOD_STUDIO_EVENTINSTANCE *eventinstance,
float volume
);
C# Syntax
RESULT Studio.EventInstance.setVolume(
float volume
);
JavaScript Syntax
EventInstance.setVolume(
volume
);
Parameters
- volume
- The volume as a linear gain. 0 = silent, 1 = full volume.
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
This volume is applied as a scaling factor for the event volume. It does not override the volume level set in FMOD Studio, nor any internal volume automation or modulation.
See Also
Version 1.10.03 Built on Feb 1, 2018