Version

menu_open
Wwise SDK 2024.1.5

◆ PrepareBus() [2/4]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::PrepareBus ( PreparationType  in_PreparationType,
AkUniqueID in_pBusID,
AkUInt32  in_uBusses,
AkBankCallbackFunc  in_pfnBankCallback,
void *  in_pCookie 
)

Prepares or unprepares busses asynchronously (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 immediately. Use a callback to be notified when the request has finished being processed.

Returns
AK_Success if scheduling is was successful, AK_Fail otherwise.
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
in_pfnBankCallbackCallback function
in_pCookieCallback cookie (reserved to user, passed to the callback function)

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