Firelight Technologies FMOD Studio API
Studio::CommandReplay::setLoadBankCallback
Sets a callback that is invoked when the replay reaches a load bank command.
C++ Syntax
FMOD_RESULT Studio::CommandReplay::setLoadBankCallback(
FMOD_STUDIO_COMMANDREPLAY_LOAD_BANK_CALLBACK callback
);
C Syntax
FMOD_RESULT FMOD_Studio_CommandReplay_SetLoadBankCallback(
FMOD_STUDIO_COMMANDREPLAY *commandreplay,
FMOD_STUDIO_COMMANDREPLAY_LOAD_BANK_CALLBACK callback
);
C# Syntax
RESULT Studio.CommandReplay.setLoadBankCallback(
COMMANDREPLAY_LOAD_BANK_CALLBACK callback
);
JavaScript Syntax
CommandReplay.setLoadBankCallback(
callback
);
Parameters
- callback
- The callback to use.
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
The load bank callback is invoked whenever any of the Studio load bank functions are reached. For Studio::System::loadBankFile, the callback will have the filename used in the replay file, modified by any path set in Studio::CommandReplay::setBankPath. For banks loaded with Studio::System::loadBankMemory and Studio::System::loadBankCustom, the path will be NULL but the guid can be used to identify what bank was loaded.
If this callback is not set the bank is loaded automatically. If the callback is set the bank is not loaded automatically and should be loaded in the callback. Failing to load the bank in the callback will mean the replay will continue but some later events may not be found.
See Also
Version 1.10.03 Built on Feb 1, 2018