Firelight Technologies FMOD Studio API

FMOD_DSP_CREATE_CALLBACK

This callback is called once when a user creates a DSP unit of this type. It is used to allocate memory, initialize variables and the like.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_DSP_CREATE_CALLBACK(
  FMOD_DSP_STATE *dsp_state
);

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.

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.

• System::createDSP
• System::createDSPByType
• System::createDSPByPlugin

Sometimes a user will re-use a DSP unit instead of releasing it and creating a new one, so it may be useful to implement FMOD_DSP_RESETCALLBACK to reset any variables or buffers when the user calls it.

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

See Also

• FMOD_DSP_STATE
• FMOD_DSP_DESCRIPTION
• System::createDSP
• System::createDSPByType
• System::createDSPByPlugin
• FMOD_DSP_RESETCALLBACK

Version 1.03.06 Built on Apr 17, 2014