Firelight Technologies FMOD Studio API
FMOD_STUDIO_COMMANDREPLAY_LOAD_BANK_CALLBACK
Callback for command replay bank loading.
C/C++ Syntax
FMOD_RESULT F_CALLBACK FMOD_STUDIO_COMMANDREPLAY_LOAD_BANK_CALLBACK(
FMOD_STUDIO_COMMANDREPLAY *replay,
int commandIndex,
const FMOD_GUID *bankGuid,
const char *bankFilename,
FMOD_STUDIO_LOAD_BANK_FLAGS flags,
FMOD_STUDIO_BANK **bank,
void *userdata
);
Parameters
replay
Pointer to the command replay object.
commandIndex
The command that invoked this callback.
bankGuid
The guid of the bank that needs to be loaded. May be all zero if not known.
bankFilename
The filename of the bank that needs to be loaded. May be NULL if not known.
flags
The flags to load the bank with.
bank
The resulting bank handle.
userdata
The userdata assigned into the given replay, or NULL if not set.
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
C++ Users. Cast FMOD_STUDIO_COMMANDREPLAY * to FMOD::Studio::CommandReplay * inside the callback and use as normal.
'userdata' is the userdata assigned to the system from Studio::CommandReplay::setUserData function.
This callback can be used to load banks when playing a command replay.
See Also
Version 1.10.03 Built on Feb 1, 2018