Firelight Technologies FMOD Studio API

FMOD_DSP_SETPARAM_FLOAT_CALLBACK

This callback is called when the user wants to set a float parameter for a DSP unit.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_DSP_SETPARAM_FLOAT_CALLBACK(
  FMOD_DSP_STATE *dsp_state,
  int index,
  float value
);

Parameters

dsp_state

Pointer to the plugin state. The user can use this variable to access runtime plugin specific variables and plugin writer user data. Do not cast this to FMOD_DSP! The handle to the user created DSP handle is stored within the FMOD_DSP_STATE structure.

index

The index into the parameter list for the parameter the user wants to set.

value

The value passed in by the user to set for the selected parameter.

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

Functions that the user would have to call for this callback to be called.

• DSP::setParameterFloat.

Range checking is not needed. FMOD will clamp the incoming value to the specified min/max.

Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.

See Also

• FMOD_DSP_STATE
• DSP::setParameterFloat
• FMOD_DSP_DESCRIPTION
• FMOD_DSP_GETPARAM_FLOAT_CALLBACK

Version 1.10.03 Built on Feb 1, 2018