Table of Contents

AKRESULT __cdecl AK::SoundEngine::RegisterGlobalCallback ( AkGlobalCallbackFunc  in_pCallback,
AkUInt32  in_eLocation = AkGlobalCallbackLocation_BeginRender,
void *  in_pCookie = NULL,
AkPluginType  in_eType = AkPluginTypeNone,
AkUInt32  in_ulCompanyID = 0,
AkUInt32  in_ulPluginID = 0  

Registers a global callback function. This function will be called from the audio rendering thread, at the location specified by in_eLocation. This function will also be called from the thread calling AK::SoundEngine::Term with in_eLocation set to AkGlobalCallbackLocation_Term. For example, in order to be called at every audio rendering pass, and once during teardown for releasing resources, you would call RegisterGlobalCallback(myCallback, AkGlobalCallbackLocation_BeginRender | AkGlobalCallbackLocation_Term, myCookie, AkPluginTypeNone, 0, 0);

A Plugin Type, Company ID and Plugin ID can be provided to this function to enable timing in the performance montior. If the callback is being timed, it will contribute to the Total Plug-in CPU measurement, and also appear in the Plug-ins tab of the Advanced Profiler by plug-in type and ID. It is illegal to call this function while already inside of a global callback. This function might stall for several milliseconds before returning.
See also:
in_pCallback  Function to register as a global callback.
in_eLocation  Callback location defined in AkGlobalCallbackLocation. Bitwise OR multiple locations if needed.
in_pCookie  User cookie.
in_eType  Plug-in type (for example, source or effect). AkPluginTypeNone for no timing.
in_ulCompanyID  Company identifier (as declared in the plug-in description XML file). 0 for no timing.
in_ulPluginID  Plug-in identifier (as declared in the plug-in description XML file). 0 for no timing.