Table of Contents

virtual AKRESULT AK::IAkSinkPluginContext::SignalAudioThread (  )  [pure virtual]

Sink plugins may need to call this function to notify the audio thread that it should wake up in order to potentially process an audio frame. Note that the audio thread may wake up for other reasons, for example following calls to AK::SoundEngine::RenderAudio(). Once the audio thread is awaken, it will ask the sink plugin how many audio frames need to be processed and presented to the plugin. This is done through AK::IAkSinkPlugin::IsDataNeeded() and AK::IAkSinkPlugin::Consume() respectively. Note that only the sink plugin that is instantiated on the main output device (primary tree) may control the audio thread synchronization.

Returns:
AK_Success if the calling plugin is instantiated on the main output device (primary tree), AK_Fail otherwise.
See also: