Firelight Technologies FMOD Studio API

Studio::EventInstance::setParameterValue

Sets a parameter instance value by name.

C++ Syntax

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

C Syntax

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

Parameters

name

Name of the parameter (case-insensitive).

value

Value to set.

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 is a convenience function that is equivalent to calling EventInstance::getParameter then ParameterInstance::setValue.

See Also

• Studio::EventInstance::getParameter
• Studio::ParameterInstance::setValue

Version 1.03.06 Built on Apr 17, 2014