Firelight Technologies FMOD Studio API

FMOD_CODEC_SOUNDCREATE_CALLBACK

Sound creation callback for the codec when FMOD finishes creating the sound. Ie so the codec can set more parameters for the related created sound, ie loop points/mode or 3D attributes etc.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_CODEC_SOUNDCREATE_CALLBACK(
  FMOD_CODEC_STATE *codec_state,
  int subsound,
  FMOD_SOUND *sound
);

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.

subsound

Subsound index being created.

sound

Pointer to the sound being created.

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

• System::createSound
• System::createStream
• FMOD_CODEC_STATE
• FMOD_CODEC_DESCRIPTION
• FMOD_CODEC_OPEN_CALLBACK
• FMOD_CODEC_CLOSE_CALLBACK
• FMOD_CODEC_READ_CALLBACK
• FMOD_CODEC_GETLENGTH_CALLBACK
• FMOD_CODEC_SETPOSITION_CALLBACK
• FMOD_CODEC_GETPOSITION_CALLBACK

Version 1.10.03 Built on Feb 1, 2018