Firelight Technologies FMOD Studio API

Studio::EventInstance::getParameterValue

Gets a parameter instance value by name.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getParameterValue(
  const char *name,
  float *value,
  float *finalvalue
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetParameterValue(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  const char *name,
  float *value,
  float *finalvalue
);

C# Syntax

RESULT Studio.EventInstance.getParameterValue(
  string name,
  out float value,
  out float finalvalue
);

JavaScript Syntax

EventInstance.getParameterValue(
  name,                            
  value,                           // writes value to value.val
  finalvalue                       // writes value to finalvalue.val
);

Parameters

name

Name of the parameter (case-insensitive).

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 finds the parameter by name and then gets the value. This function can return both the user side 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.

See Also

• Studio::EventInstance::getParameterValue
• Studio::EventInstance::setParameterValue
• Studio::EventInstance::getParameterValueByIndex

Version 1.10.03 Built on Feb 1, 2018