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

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::ParameterInstance::setValue

Version 1.03.06 Built on Apr 17, 2014