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
);

C# Syntax

RESULT Studio.Bank.getLoadingState(
  out LOADING_STATE state
);

JavaScript Syntax

Bank.getLoadingState(
  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

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.

If the bank has a file error, then the state will be returned as FMOD_STUDIO_LOADING_STATE_ERROR and the return code from this function will be the error code of the bank load function.

If the bank is invalid, then the state will be set to FMOD_STUDIO_LOADING_STATE_UNLOADED.

See Also

• FMOD_STUDIO_LOADING_STATE
• Studio::System::loadBankFile
• Studio::System::loadBankMemory
• Studio::System::loadBankCustom

Version 1.10.03 Built on Feb 1, 2018