Version

menu_open
Wwise SDK 2024.1.5

◆ PrepareBus() [1/4]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::PrepareBus ( PreparationType  in_PreparationType,
AkUniqueID in_pBusID,
AkUInt32  in_uBusses 
)

Prepares or unprepares busses synchronously (by ID).
The Busses are identified by their ID (refer to General Information for a discussion on using strings and IDs). Before invoking PrepareBus(), use LoadBank() to explicitly load the SoundBank(s) that contain the Bus structures. When a request is posted to the Bank Manager consumer thread, it will load the required loose media files for effects placed on the specified busses. The function returns when the request is completely processed.

Returns
  • AK_Success: Prepare/un-prepare successful.
  • AK_IDNotFound: At least one of the bus IDs does not exist.
  • 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_InvalidParameter: Invalid parameter, invalid memory alignment.
  • AK_Fail: Load or unload failed for any other reason.
Remarks
Whenever at least one bus fails to be resolved, the actions performed for all other busses are cancelled.
See also
Parameters
in_PreparationTypePreparation type ( Preparation_Load or Preparation_Unload )
in_pBusIDArray of bus IDs
in_uBussesNumber of bus IDs in the array

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise