Firelight Technologies FMOD Studio API

Studio::EventInstance::setParameterValuesByIndices

Sets multiple parameter instance values by index.

C++ Syntax

FMOD_RESULT Studio::EventInstance::setParameterValuesByIndices(
  int *indices,
  float *values,
  int count
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_SetParameterValuesByIndices(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  int *indices,
  float *values,
  int count
);

C# Syntax

RESULT Studio.EventInstance.setParameterValuesByIndices(
  int[] indices,
  float[] values,
  int count
);

Parameters

indices

Indices of the parameters.

values

Values to set.

count

Number of indices and values.

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 values for the given indices. Each 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 any index is an automatic parameter, FMOD_ERR_INVALID_PARAM is returned without setting the value of any parameters.

If any index is set to -1 then the index and corresponding value will be ignored.

A maximum of 92 parameter values can be set at once. If count is greater than 92, 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::setParameterValueByIndex
• Studio::EventInstance::getParameterValueByIndex

Version 1.10.03 Built on Feb 1, 2018