Version

menu_open
Wwise SDK 2023.1.4

◆ RegisterBusVolumeCallback()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::RegisterBusVolumeCallback ( AkUniqueID  in_busID,
AkBusCallbackFunc  in_pfnCallback,
void *  in_pCookie = NULL 
)

Registers a callback to allow the game to modify or override the volume to be applied at the output of an audio bus. The callback must be registered once per bus ID. Call with in_pfnCallback = NULL to unregister.

Note: The bus in_busID needs to be a mixing bus.
Note: The callback function will not be called for the Master Audio Bus, since the output of this bus is not a bus, but is instead an Audio Device.
See also
Returns
  • AK_Success if successful
  • AK_IDNotFound if the bus is not found
  • AK_NotInitialized if the sound engine is not initialized
  • AK_InsufficientMemory if there is not enough memory to complete the operation
Parameters
in_busIDBus ID, as obtained by GetIDFromString( bus_name ).
in_pfnCallbackCallback function.
in_pCookieUser cookie.

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