Firelight Technologies FMOD Studio API

Studio::Bank::getLoadingState

Retrieves the bank loading state.

C++ Syntax

FMOD_RESULT Studio::Bank::getLoadingState(
  FMOD_STUDIO_LOADING_STATE *state
);

C Syntax

FMOD_RESULT FMOD_Studio_Bank_GetLoadingState(
  FMOD_STUDIO_BANK *bank,
  FMOD_STUDIO_LOADING_STATE *state
);

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

This function provides a way of tracking banks which can be loaded asynchronously. Only after a bank has finished loading is it valid to query event descriptions within the bank.

See Also

• FMOD_STUDIO_LOADING_STATE
• Studio::System::loadBankFile

Version 1.03.06 Built on Apr 17, 2014