4.9 KiB
4.9 KiB
Introduction
This repository provides plugins and tools for integrating spatial audio and acoustics into your Unity 3D applications and games. This includes:
- A HoloLens 2 spatializer plugin which uses Windows Sonic API to enable hardware offload of spatial audio processing, freeing up the CPU for your application.
- A sample Unity application that demonstrates proper usage of the HoloLens 2 spatializer plugin.
- Source code for the Project Acoustics spatializer plugin.
Getting started with Spatial Audio for Unity on HoloLens 2
Cloning this repository is not required to start using the Microsoft Spatializer in your Unity project. Visit our documentation for instructions on integrating the Microsoft Spatializer into your Unity project. For a more in-depth exploration of spatial audio, check out the learning module. If you'd like to build the plugin yourself, see below.
Required Software
 Windows SDK 18362+ |
 Visual Studio 2019 |
 CMake |
 Unity 2019 |
 Python 3+ |
 Node.js |
|---|---|---|---|---|---|
| Windows 10 May 2019 Update SDK to build the spatializer plugin. Plugin will run on Windows 10 Fall Creator's update and higher and on HoloLens 2. |
Visual Studio is used for code editing, deploying and building UWP app packages | CMake is required for generating Visual Studio 2019 projects | Unity 2019 is required to build the spatializer plugin package. Plugin can be used on Unity 2018 LTS and higher versions. |
Helper scripts for build and packaging use Python 3 and higher. | For UPM packaging |
Branch Guide
- Master branch is used for building release candidates and official releases. Direct pull requests into master are not allowed.
- Develop branch is used for staging ongoing work for the next official release and merged with master after extensive review and testing. Direct pull requests into develop branch are not allowed.
- Use feature branches to bringup individual features. Once a feature is ready and tested a pull request can merge it into develop branch.
Clone the Repository
git clone https://github.com/microsoft/spatialaudio-unity.git --recurse-submodules
If you forget to include submodules when cloning, add them with git submodule update --init --recursive
Build Status
| Build | Branch | Status |
|---|---|---|
| Release | master | |
| Validation | develop |
Local Build
- Launch "Developer Command Prompt for Visual Studio 2019".
- Switch directory to the root of your Git enlistment.
- Run the CMake script to generate Visual Studio 2019 projects:
python3 Tools\runcmake.py - Run the build script to build all flavors:
python3 Tools\build.py - To generate the Unity package:
python3 Tools\unity_package.py -u "c:\Program Files\Unity\Hub\Editor\2019.1.3f1\Editor" -v 0.1.0 - To generate the UPM package:
python3 Tools\upm_package.py -v 0.1.0
Artifacts
- Build produces UPM and Unity asset packages .
- Unity asset package is available under releases tab
- UPM Package is available via Microsoft Mixed Reality scoped registry