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
);

C# Syntax

RESULT Studio.EventInstance.setParameterValue(
  string name,
  float value
);

JavaScript Syntax

EventInstance.setParameterValue(
  name,                            
  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 function finds the parameter by name and then sets the value.

If the event has no parameter of that name, FMOD_ERR_EVENT_NOTFOUND is returned. If it is an automatic parameter, FMOD_ERR_INVALID_PARAM is returned.

See Also

• Studio::EventInstance::getParameterValue
• Studio::EventInstance::getParameterValueByIndex
• Studio::EventInstance::setParameterValueByIndex

Version 1.10.03 Built on Feb 1, 2018