Table of Contents

AKRESULT __cdecl AK::SoundEngine::RegisterBusVolumeCallback ( AkUniqueID  in_busID,
AkBusCallbackFunc  in_pfnCallback  
)

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.gif
Note: The bus in_busID needs to be a mixing bus.
Note.gif
Note: Beware when using this callback on the Master Audio Bus: since the output of this bus is not a bus, but is instead a system end-point, AkSpeakerVolumeMatrixCallbackInfo::pMixerContext will be NULL. You cannot modify panning at the output of the Master Audio Bus.
See also:
Returns:
  • AK_Success if successful
Parameters:
in_busID  Bus ID, as obtained by GetIDFromString( bus_name ).
in_pfnCallback  Callback function.