Firelight Technologies FMOD Studio API
Studio::Bank::getSampleLoadingState
Retrieves the sample data loading state of the bank.
C++ Syntax
FMOD_RESULT Studio::Bank::getSampleLoadingState(
FMOD_STUDIO_LOADING_STATE *state
);
C Syntax
FMOD_RESULT FMOD_Studio_Bank_GetSampleLoadingState(
FMOD_STUDIO_BANK *bank,
FMOD_STUDIO_LOADING_STATE *state
);
C# Syntax
RESULT Studio.Bank.getSampleLoadingState(
out LOADING_STATE state
);
JavaScript Syntax
Bank.getSampleLoadingState(
state // writes value to state.val
);
Parameters
- state
- Address of a variable to receive the loading state.
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
Used for tracking the status of the Studio::Bank::loadSampleData operation.
Note that this function is not affected by Studio::EventDescription::loadSampleData, so it can report FMOD_STUDIO_LOADING_STATE_UNLOADED even if all events in a bank have had their sample data loaded individually.
If the bank is invalid, then the state will be set to FMOD_STUDIO_LOADING_STATE_UNLOADED.
See Also
Version 1.10.03 Built on Feb 1, 2018