Firelight Technologies FMOD Studio API
Studio::Bus::setVolume
Sets the volume level of the bus.
C++ Syntax
FMOD_RESULT Studio::Bus::setVolume(
float volume
);
C Syntax
FMOD_RESULT FMOD_Studio_Bus_SetVolume(
FMOD_STUDIO_BUS *bus,
float volume
);
C# Syntax
RESULT Studio.Bus.setVolume(
float volume
);
JavaScript Syntax
Bus.setVolume(
volume
);
Parameters
- volume
- The volume level to set 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 function allows volume control of all audio routed into the bus. This fader level is relative to the fader level set in FMOD Studio.
See Also
Version 1.10.03 Built on Feb 1, 2018