Other Documentation

Wwise SDK 2022.1.8

◆ Suspend()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Suspend ( bool  in_bRenderAnyway = false,
bool  in_bFadeOut = true 

This function should be called to put the sound engine in background mode, where audio isn't processed anymore. This needs to be called if the console has a background mode or some suspended state. Call WakeupFromSuspend when your application receives the message from the OS that the process is back in foreground. When suspended, the sound engine will process API messages (like PostEvent and SetSwitch) only when RenderAudio() is called. It is recommended to match the in_bRenderAnyway parameter with the behavior of the rest of your game: if your game still runs in background and you must keep some kind of coherent state between the audio engine and game, then allow rendering. If you want to minimize CPU when in background, then don't allow rendering and never call RenderAudio from the game.

Consult Handling System-Specific Events to learn when it is appropriate to call this function for each platform.

See also
Handling System-Specific Events
in_bRenderAnyway If set to true, audio processing will still occur, but not outputted. When set to false, no audio will be processed at all, even upon reception of RenderAudio().
in_bFadeOut Delay the suspend by one audio frame in order to fade-out. When false, the suspend takes effect immediately but audio may glitch.

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