Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2022.1.17

◆ RegisterBusMeteringCallback()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::RegisterBusMeteringCallback ( AkUniqueID  in_busID,
AkBusMeteringCallbackFunc  in_pfnCallback,
AkMeteringFlags  in_eMeteringFlags,
void *  in_pCookie = NULL 
)

Registers a callback to be called to allow the game to access metering data from any mixing bus. You may use this to monitor loudness at any point of the mixing hierarchy by accessing the peak, RMS, True Peak and K-weighted power (according to loudness standard ITU BS.1770). See Advanced Mix Customization Using the Speaker Matrix Callback for an example. 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.
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_eMeteringFlagsMetering flags.
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