Firelight Technologies FMOD Studio API

Studio::ParameterInstance::setValue

Sets the value of the parameter.

C++ Syntax

FMOD_RESULT Studio::ParameterInstance::setValue(
  float value
);

C Syntax

FMOD_RESULT FMOD_Studio_ParameterInstance_SetValue(
  FMOD_STUDIO_PARAMETERINSTANCE *parameterinstance,
  float value
);

Parameters

value

The value to set.

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

Parameters are used to control event playback and link it to game state. The provided value will be clamped to the parameter's range before it is set.

See Also

• Studio::ParameterInstance::getValue

Version 1.03.06 Built on Apr 17, 2014