Firelight Technologies FMOD Studio API

Studio::EventInstance::getVolume

Retrieves the volume level set by the API on the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getVolume(
  float *volume
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetVolume(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  float *volume
);

Parameters

volume

Address of a variable to receive the 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.

See Also

• Studio::EventInstance::setVolume

Version 1.03.06 Built on Apr 17, 2014