Firelight Technologies FMOD Studio API

Studio::EventInstance::getReverbLevel

Retrieves the send level to a Low Level reverb instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getReverbLevel(
  int index,
  float *level
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetReverbLevel(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  int index,
  float *level
);

C# Syntax

RESULT Studio.EventInstance.getReverbLevel(
  int index,
  out float level
);

JavaScript Syntax

EventInstance.getReverbLevel(
  index,                           
  level                            // writes value to level.val
);

Parameters

index

Index of the Low Level reverb instance to target, from 0 to 3.

level

Address of a variable to receive the send level for the signal to the reverb, from 0 (none) to 1 (full).

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 gets the level of signal sent from the event instance to a Low Level reverb instance.

NOTE: Use this function in preference to obtaining the event's ChannelGroup via Studio::EventInstance::getChannelGroup and calling ChannelGroup::getReverbProperties directly. This function is safe to use anytime.

See Also

• Studio::EventInstance::setReverbLevel

Version 1.10.03 Built on Feb 1, 2018