Firelight Technologies FMOD Studio API

FMOD_CODEC_CLOSE_CALLBACK

Close callback for the codec for when FMOD tries to close a sound using this codec.
This is the callback any codec related memory is freed, and things are generally de-initialized / shut down for the codec.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_CODEC_CLOSE_CALLBACK(
  FMOD_CODEC_STATE *codec_state
);

Parameters

codec_state

Pointer to the codec state. The user can use this variable to access runtime plugin specific variables and plugin writer user data.

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

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

See Also

• FMOD_CODEC_STATE
• FMOD_CODEC_DESCRIPTION
• FMOD_CODEC_OPEN_CALLBACK
• FMOD_CODEC_READ_CALLBACK
• FMOD_CODEC_GETLENGTH_CALLBACK
• FMOD_CODEC_SETPOSITION_CALLBACK
• FMOD_CODEC_GETPOSITION_CALLBACK
• FMOD_CODEC_SOUNDCREATE_CALLBACK

Version 1.10.03 Built on Feb 1, 2018