Firelight Technologies FMOD Studio API

Studio::VCA::setVolume

Sets the volume level of the VCA.

C++ Syntax

FMOD_RESULT Studio::VCA::setVolume(
  float volume
);

C Syntax

FMOD_RESULT FMOD_Studio_VCA_SetVolume(
  FMOD_STUDIO_VCA *vca,
  float volume
);

C# Syntax

RESULT Studio.VCA.setVolume(
  float volume
);

JavaScript Syntax

VCA.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 controlled by the VCA. This fader level is relative to the fader level set in FMOD Studio.

See Also

• Studio::VCA::getVolume

Version 1.10.03 Built on Feb 1, 2018