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

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.

See Also

• Studio::EventInstance::getParameterCount

Version 1.03.06 Built on Apr 17, 2014