Wwise SDK 2022.1.4
This page contains information that is specific to using the Wwise SDK for the Windows platform and the Universal Windows Platform (UWP).
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.
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. System Audio Objects are mapped to Microsoft Spatial Sound dynamic objects. During initialization of the System Audio Device, Wwise detects if the endpoint is configured to output for headphones or home theater. Wwise uses the endpoint output configuration to determine which speaker configuration of the System Audio Device ShareSet to assign to the Main Mix.
A passthrough mix is also created and sent out to a WASAPI stream if the endpoint is configured for headphones. If a passthrough mix is not created, then any signals intended for the passthrough mix are automatically directed to the main mix. For example, busses configured as Same as passthrough mix will instead have their mixing behaviour match the Main Mix for the device, as if they were configured for Same as main mix.
The endpoint is configured to output for headphones if the endpoint is a 2-channel output. If the endpoint is not detected as a 2-channel output, then the endpoint is assumed to be a home theater setup.
Because Microsoft Spatial Sound dynamic object positions are expressed in meters, Wwise relies on the
AkInitSettings::fGameUnitsToMeters setting to convert the units. If your project uses Game Units that are not in meters, make sure to properly initialize
AkInitSettings::fGameUnitsToMeters with the correct conversion factor. Otherwise, some discrete objects might sound strange at close distances during binauralization.
When Spatial Sound is disabled, 3D Audio support is disabled, and the Main Mix is simply sent to a WASAPI stream.
|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.
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.
Questions? Problems? Need more info? Contact us, and we can help!Visit our Support page
Register your project and we'll help you get started with no strings attached!Get started with Wwise