Firelight Technologies FMOD Studio API

Studio::EventInstance::getVolume

Retrieves the volume level of the event instance.

C++ Syntax

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

C Syntax

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

C# Syntax

RESULT Studio.EventInstance.getVolume(
  out float volume,
  out float finalvolume
);

JavaScript Syntax

EventInstance.getVolume(
  volume,                          // writes value to volume.val
  finalvolume                      // writes value to finalvolume.val
);

Parameters

volume

Address of a variable to receive the volume as set from the public API. Specify 0 or NULL to ignore.

finalvolume

Address of a variable to receive the final combined volume. Specify 0 or NULL to ignore.

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 can return both the volume set from the last call to Studio::EventInstance::setVolume, as well as the final combined volume which may be the result of automation and modulation.

NOTE: The final volume will not change immediately. It will change during subsequent asynchronous updates.

See Also

• Studio::EventInstance::setVolume

Version 1.10.03 Built on Feb 1, 2018