Version

menu_open
Target Platform(s):
Wwise SDK 2019.2.15
Windows-Specific AkPlatformInitSettings

This page contains information about the Windows-specific initialization settings.

HWND hWnd Handle to the window associated to the audio.
Each game must specify the HWND of the application for device detection purposes.
The value returned by GetDefaultPlatformInitSettings is the foreground HWND at the moment of the initialization of the sound engine and may not be the correct one for your game.
It is required that each game provides the correct HWND to be used.
AkThreadProperties threadLEngine Lower engine threading properties.
AkThreadProperties threadOutputMgr Ouput thread threading properties.
AkThreadProperties threadBankManager Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL).
AkThreadProperties threadMonitor Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
AkUInt16 uNumRefillsInVoice Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
AkUInt32 uSampleRate Sampling Rate. Default is 48000 Hz. Use 24000hz for low quality. Any positive reasonable sample rate is supported. However be careful setting a custom value. Using an odd or really low sample rate may result in malfunctionning sound engine.
AkAudioAPI eAudioAPI Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
If a valid audioDeviceShareset plug-in is provided, the AkAudioAPI will be Ignored.
bool bGlobalFocus Corresponding to DSBCAPS_GLOBALFOCUS. If using the AkAPI_DirectSound AkAudioAPI type, sounds will be muted if set to false when the game loses the focus.
This setting is ignored when using other AkAudioAPI types.
IXAudio2* pXAudio2 XAudio2 instance to use for the Wwise sound engine. If NULL (default) Wwise will initialize its own instance. Used only if the sink type is XAudio2 in AkInitSettings.outputType.
bool bEnableAvxSupport Enables run-time detection of AVX and AVX2 SIMD support in the engine and plug-ins. Disabling this may improve CPU performance by allowing for higher CPU clockspeeds.

Windows-Specific Audio Output API

Use with AkPlatformInitSettings to select the API used for audio output. Use AkAPI_Default, it will select the more appropriate API depending on the computer's capabilities. Other values should be used for testing purposes.

enum AkAudioAPI
AkAPI_Wasapi Use Wasapi.
AkAPI_XAudio2 Use XAudio2 (this is the preferred API on Windows).
AkAPI_DirectSound Use DirectSound.
AkAPI_Default Default value, will select the more appropriate API (XAudio2 is the default).
See also
AK::SoundEngine::Init
AK::SoundEngine::GetDefaultPlatformInitSettings

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