Loads a bank synchronously.
The bank name and type are passed to the Stream Manager. Refer to General Information for a discussion on using strings and IDs. A bank load request will be posted, and consumed by the Bank Manager thread. The function returns when the request has been completely processed.
- Returns
- The bank ID, which is obtained by hashing the bank name (see GetIDFromString()). You may use this ID with UnloadBank().
-
AK_Success:
Load or unload successful.
-
AK_BankAlreadyLoaded:
This bank is already loaded, nothing done.
-
AK_InsufficientMemory:
Insufficient memory to store bank data.
-
AK_BankReadError:
I/O error.
-
AK_WrongBankVersion:
Invalid bank version: make sure the version of Wwise that you used to generate the SoundBanks matches that of the SDK you are currently using.
-
AK_InvalidFile:
File specified could not be opened.
-
AK_NotInitialized
if the sound engine was not correctly initialized
-
AK_InvalidParameter
if some parameters are invalid, check the debug console
-
AK_InvalidBankType
if the bank type parameter is out of range.
-
AK_Fail:
Load or unload failed for any other reason. (Most likely small allocation failure)
- See also
-
- Parameters
-
in_pszString |
Name of the bank to load |
out_bankID |
Returned bank ID |
in_bankType |
Type of the bank to load |