Firelight Technologies FMOD Studio API
FMOD_DSP_GETPARAM_DATA_CALLBACK
This callback is called when the user wants to get an indexed binary data parameter from a DSP unit.
C/C++ Syntax
FMOD_RESULT F_CALLBACK FMOD_DSP_GETPARAM_DATA_CALLBACK(
FMOD_DSP_STATE *dsp_state,
int index,
void **value,
unsigned int *length,
char *valuestr
);
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 get.
value
Pointer to a void * variable to receive the selected parameter value.
length
Pointer to a variable to receive the length of the selected parameter value.
valuestr
A pointer to a string to receive the value of the selected parameter, but in text form. This might be useful to display words instead of numbers. For example "ON" or "OFF" instead of 1.0 and 0.0. The length of the buffer being passed in is always 16 bytes, so do not exceed this. Note: This pointer will be 0 / NULL if a string is not required.
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.
Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.
See Also
Version 1.10.03 Built on Feb 1, 2018