Target Platform(s):
Wwise SDK 2021.1.5
Windows-Specific Information

This page contains information that is specific to using the Wwise SDK for the Windows platform and the Universal Windows Platform (UWP).

UWP Wwise Audio Plug-in Restrictions

When building Wwise audio plug-ins for UWP, Windows Metadata (WinMD) files are generated. These files must be removed when packaging your plug-ins for use with the Wwise Unity Integration.

Enabling 3D Audio

3D audio support is implemented using Microsoft Spatial Sound. As such, 3D audio is only available when the user has enabled Spatial Sound on the endpoint (i.e., the audio device in Windows). Refer to Microsoft Spatial Sound for further details, including how to enable Spatial Sound on various platforms.

When Spatial Sound is enabled, the Main Mix is sent to Microsoft Spatial Sound static objects (i.e., the channel bed) and the default channel configuration is 7.1.4. When Spatial Sound is disabled, the Main Mix is sent to a WASAPI stream. In either case, the Passthrough Mix is implemented as a WASAPI stream and System Audio Objects are mapped to Microsoft Spatial Sound dynamic objects.

Note: Depending on which Spatial Sound engine is enabled on the endpoint, the number of available dynamic objects can vary. Most engines have less than 30 dynamic objects available, while the default value of the System Minimum Object Requirement property of the System Audio Device in Wwise is 32. With this default setting, audio objects are effectively disabled for most engines. To enable System Audio Objects, you must reduce the value of the System Minimum Object Requirement to a number below 30. A value of 16 is recommended.

Refer to the Microsoft Spatial Sound Runtime Resource Implications section on the Microsoft Spatial Sound page for details on the static and dynamic object limits for each platform combination.

Note: On desktop platforms, there is a limited number of Microsoft Spatial Sound dynamic objects that all processes must share. This means that if one process reserves them all, other processes will not be able to use them until they have been released.

If Spatial Sound is enabled on the endpoint and System Audio Objects are allowed in Wwise, the Wwise sound engine will attempt to reserve all objects for itself. For this reason, the use of System Audio Objects is disabled by default on desktop platforms using the platform setting AkPlatformInitSettings::bEnableSystemAudioObjects.

To enable this option for the Wwise Authoring Tool’s internal sound engine, from the Wwise menubar, click Audio > Authoring Audio Preferences. The Audio Preferences dialog box opens. Select the Enable System Audio Objects check box and click OK.

Microsoft Spatial Sound Platform Output [deprecated]

This audio output device plug-in sends a 7.1.4 mix to the Microsoft Spatial Sound platform.

This functionality is now integrated into the System Audio Device, where the Main Mix is output to Microsoft Spatial Sound when Allow 3D Audio is selected and Spatial Sound is enabled in the operating system.

In conjunction with the MS Spatial output, it was possible to use the System output to exclude a portion of the mix from binaural rendering. This is now explicitly done via the Passthrough Mix in the new System Audio Device.

Windows-Specific AkPlatformInitSettings

Windows Release Notes