Firelight Technologies FMOD Studio API

FMOD_DSP_SETPARAM_DATA_CALLBACK

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

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_DSP_SETPARAM_DATA_CALLBACK(
  FMOD_DSP_STATE *dsp_state,
  int index,
  void *value,
  unsigned int length
);

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

Pointer to the binary data to set for the selected parameter.

length

The length of the binary data. Optional.

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

Certain data types are predefined by the system and can be specified via the FMOD_DSP_PARAMETER_DESC_DATA, see FMOD_DSP_PARAMETER_DATA_TYPE

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

• DSP::setParameterData.

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::setParameterData
• FMOD_DSP_DESCRIPTION
• FMOD_DSP_GETPARAM_DATA_CALLBACK

Version 1.10.03 Built on Feb 1, 2018