Version

menu_open
Wwise SDK 2023.1.4

◆ RegisterCaptureCallback()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::RegisterCaptureCallback ( AkCaptureCallbackFunc  in_pfnCallback,
AkOutputDeviceID  in_idOutput = AK_INVALID_OUTPUT_DEVICE_ID,
void *  in_pCookie = NULL 
)

Registers a callback used for retrieving audio samples. The callback will be called from the audio thread during real-time rendering and from the main thread during offline rendering.

Returns
  • AK_Success when successful
  • AK_DeviceNotFound if the audio device ID doesn't match to a device in use.
  • AK_InvalidParameter when in_pfnCallback is null
  • AK_NotInitialized if the sound engine is not initialized at this time
See also
Parameters
in_pfnCallbackCapture callback function to register.
in_idOutputThe audio device specific id, return by AK::SoundEngine::AddOutput or AK::SoundEngine::GetOutputID
in_pCookieCallback cookie that will be sent to the callback function along with additional information

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