Firelight Technologies FMOD Studio API

Studio::EventInstance::getParameterValueByIndex

Gets a parameter instance value by index.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getParameterValueByIndex(
  int index,
  float *value,
  float *finalvalue
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetParameterValueByIndex(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  int index,
  float *value,
  float *finalvalue
);

C# Syntax

RESULT Studio.EventInstance.getParameterValueByIndex(
  int index,
  out float value,
  out float finalvalue
);

JavaScript Syntax

EventInstance.getParameterValueByIndex(
  index,                           
  value,                           // writes value to value.val
  finalvalue                       // writes value to finalvalue.val
);

Parameters

index

Index of the parameter.

value

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

finalvalue

Address of a variable to receive the final combined value. 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 gets the parameter value for the given index. The parameter index can be one of the list from Studio::EventInstance::getParameterCount, or it can found by looking at the index field of FMOD_STUDIO_PARAMETER_DESCRIPTION after calling Studio::EventDescription::getParameter.

This function can return both the value set from the last call to Studio::EventInstance::setParameterValue, as well as the final combined value which may be the result of automation, modulation, and smoothing. Automatic parameters always return the user value as 0, since they can never be set from the public API.

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

NOTE: The order of parameters is not necessarily the same as what is shown in the FMOD Studio event window.

See Also

• Studio::EventDescription::getParameterCount
• Studio::EventDescription::getParameter
• Studio::EventInstance::getParameterCount
• Studio::EventInstance::getParameterValue
• Studio::EventInstance::setParameterValue
• Studio::EventInstance::setParameterValueByIndex

Version 1.10.03 Built on Feb 1, 2018