Firelight Technologies FMOD Studio API

Studio::System::loadBankFile

Loads a Studio event bank from a file.

C++ Syntax

FMOD_RESULT Studio::System::loadBankFile(
  const char *filename,
  FMOD_STUDIO_LOAD_BANK_FLAGS flags,
  Studio::Bank **bank
);

C Syntax

FMOD_RESULT FMOD_Studio_System_LoadBankFile(
  FMOD_STUDIO_SYSTEM *system,
  const char *filename,
  FMOD_STUDIO_LOAD_BANK_FLAGS flags,
  FMOD_STUDIO_BANK **bank
);

C# Syntax

RESULT Studio.System.loadBankFile(
  string name,
  LOAD_BANK_FLAGS flags,
  out Bank bank
);

JavaScript Syntax

System.loadBankFile(
  filename,                        
  flags,                           
  bank                             // writes value to bank.val
);

Parameters

filename

Name of the file on disk.

flags

Flags to control bank loading.

bank

Address of a variable to receive the Bank object. Optional. Specify 0 or NULL to ignore.

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

By default this function will block until the file load finishes, and then return the FMOD_RESULT indicating the result. If there was a file error for blocking bank loads, then the bank variable will be returned as NULL.

Using the FMOD_STUDIO_LOAD_BANK_NONBLOCKING flag will cause the bank to be loaded asynchronously. In that case it will always return FMOD_OK and a valid bank handle. File errors for asynchronous banks can be detected by calling Studio::Bank::getLoadingState. Failed asynchronous banks should be released by calling Studio::Bank::unload.

See Also

• FMOD_STUDIO_LOAD_BANK_FLAGS
• Studio::System::loadBankMemory
• Studio::System::loadBankCustom
• Studio::Bank::getLoadingState
• Studio::Bank::unload

Version 1.10.03 Built on Feb 1, 2018