Firelight Technologies FMOD Studio API

Studio::EventDescription::getParameter

Retrieves an event parameter by name.

C++ Syntax

FMOD_RESULT Studio::EventDescription::getParameter(
  const char *name,
  FMOD_STUDIO_PARAMETER_DESCRIPTION *parameter
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_GetParameter(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  const char *name,
  FMOD_STUDIO_PARAMETER_DESCRIPTION *parameter
);

C# Syntax

RESULT Studio.EventDescription.getParameter(
  string name,
  out PARAMETER_DESCRIPTION parameter
);

JavaScript Syntax

EventDescription.getParameter(
  name,                            
  parameter                        // writes value to parameter.val
);

Parameters

name

Name of the parameter (case-insensitive).

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.

See Also

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

Version 1.10.03 Built on Feb 1, 2018