Firelight Technologies FMOD Studio API

Studio::EventInstance::setParameterValueByIndex

Sets a parameter instance value by index.

C++ Syntax

FMOD_RESULT Studio::EventInstance::setParameterValueByIndex(
  int index,
  float value
);

C Syntax

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

C# Syntax

RESULT Studio.EventInstance.setParameterValueByIndex(
  int index,
  float value
);

JavaScript Syntax

EventInstance.setParameterValueByIndex(
  index,                           
  value                            
);

Parameters

index

Index of the parameter.

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 sets 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.

If it is an automatic parameter, FMOD_ERR_INVALID_PARAM is returned.

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

See Also

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

Version 1.10.03 Built on Feb 1, 2018