Firelight Technologies FMOD Studio API

DSP::setParameterFloat

Sets a DSP unit's floating point parameter by index. To find out the parameter names and range, see the see also field.

C++ Syntax

FMOD_RESULT DSP::setParameterFloat(
  int index,
  float value
);

C Syntax

FMOD_RESULT FMOD_DSP_SetParameterFloat(
  FMOD_DSP *dsp,
  int index,
  float value
);

Parameters

index
Parameter index for this unit. Find the number of parameters with DSP::getNumParameters.
value
Floating point parameter value to be passed to the DSP unit.

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

The parameter properties (such as min/max values) can be retrieved with DSP::getParameterInfo.

See Also




Version 1.03.06 Built on Apr 17, 2014