Firelight Technologies FMOD Studio API

Studio::EventDescription::getParameterByIndex

Retrieves an event parameter by index.

C++ Syntax

FMOD_RESULT Studio::EventDescription::getParameterByIndex(
  int index,
  FMOD_STUDIO_PARAMETER_DESCRIPTION *parameter
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_GetParameterByIndex(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  int index,
  FMOD_STUDIO_PARAMETER_DESCRIPTION *parameter
);

C# Syntax

RESULT Studio.EventDescription.getParameterByIndex(
  int index,
  out PARAMETER_DESCRIPTION parameter
);

JavaScript Syntax

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

Parameters

index

Index of the parameter.

parameter

Address of a variable to receive the parameter description.

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::EventDescription::getParameterCount to enumerate all parameters within an event.

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

See Also

• FMOD_STUDIO_PARAMETER_DESCRIPTION
• Studio::EventDescription::getParameterCount

Version 1.10.03 Built on Feb 1, 2018