Firelight Technologies FMOD Studio API

Studio::EventInstance::getParameterByIndex

Retrieves a parameter instance by index.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getParameterByIndex(
  int index,
  Studio::ParameterInstance **parameter
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetParameterByIndex(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  int index,
  FMOD_STUDIO_PARAMETERINSTANCE **parameter
);

C# Syntax

RESULT Studio.EventInstance.getParameterByIndex(
  int index,
  out ParameterInstance instance
);

JavaScript Syntax

EventInstance.getParameterByIndex(
  index,                           
  parameter                        // writes value to parameter.val
);

Parameters

index

Index of the parameter.

parameter

Address of a variable to receive the ParameterInstance object.

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 can be used in combination with Studio::EventInstance::getParameterCount to enumerate all parameter instances within an event instance.

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

NOTE: This function is deprecated. It will be removed in a future version. Please get and set parameter values using Studio::EventInstance::getParameterValue, Studio::EventInstance::setParameterValue, Studio::EventInstance::getParameterValueByIndex, and Studio::EventInstance::setParameterValueByIndex.

See Also

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

Version 1.10.03 Built on Feb 1, 2018