Meta XR Audio Plugin for FMOD - Requirements and Setup
Updated: Aug 26, 2024
Overview
This section will cover how to install the Meta XR Audio SDK and prepare a project to use it.
By the end of this document, you’ll be able to:
Install FMOD Studio.
Download the Meta XR Audio SDK.
Install the Meta XR Audio SDK into your FMOD project.
Prerequisites
Windows 10/11
Mac running macOS 10.9 or newer
Install FMOD Studio
The first step to get started using the Meta XR Audio Plugin for FMOD is to install the FMOD Studio from their website. You can select the right version of FMOD after creating an FMOD account. To create an account, click Sign In > Register to follow the prompt to set up an account.
The minimum SDK version that we support for this plugin is:
FMOD 2.00.00
We also test the plug-in works in the latest version of FMOD for each release. The plugin may work in versions earlier in than the minimum version, but there is no support provided for that use case.
Download the Meta XR Audio SDK plug-in
You’ll also need to download the FMOD plug-in from the Meta Quest Developer Center. The download contains a pre-built, release-optimized plug-in for all the supported platforms (Windows, Mac and Android/Quest) for each of the major releases of FMOD versions we support.
Once downloaded, extract the .zip to a local folder on your machine.
FMOD Project Setup
There are two ways to add plugins to FMOD, you can either add it to your project or add it to FMOD Studio. In either case, you will copy the same files, but the destination folder will be different.
To install the plug-in such that FMOD Studio can find and use it while authoring sound banks, you need to copy the following files:
Note that there are two different .js file options. This is because in FMOD Studio 2.02.00, the min / max distance slider option was introduced as a native feature for events in FMOD. If you are using an earlier version of FMOD, choose the .js file in the “2.01.23-and-earlier” folder which will have a min / max distance slider on Meta plugin itself. If you are using 2.02.00 or later, choose the .js file in the “2.02.00-and-later” folder which will remove the min / max distance slider from the Meta plugin in favor of the native control.
Adding to the Project
If you are just adding the plugin to your project, create a subdirectory inside your FMOD Project directory named “Plugins” and copy the above files to the directory you created.
Adding to FMOD Studio
If you are adding the plugin to FMOD Studio, copy the above files to the destination folder “C:\Program Files\FMOD SoundSystem\FMOD Studio {version}\Plugins” for Windows. On Mac, you should copy the files to “Applications\FMOD Studio.app\Contents\Plugins”. These are the expected default installation paths for FMOD Studio but keep in mind you may have selected a different location during your installation.
Unity Project Setup
If your Unity game is currently using the Meta XR Audio SDK package, you should uninstall that package before integrating FMOD.
The Meta XR Audio Plugin uses Unity scripts to control Room Acoustic Properties. Learn how to gain access to these C# scripts below for the particular version of the SDK that you are using below.
Copy the plugin to the Unity Project
For any Unity Project you hope integrate the Meta plugin into, you must also copy the Meta libraries into the Unity project. This is true of any Third Party plugin for FMOD and the details of where to copy the dynamic libraries and what project settings to adjust are found within FMOD Official Documentation.
Install Unity Scripts for v67 and newer
Open your project in the Unity Editor, or create a new project.
Press + > Add package from tarball and select the MetaXRSDKAcousticsFMOD tarball inside the downloaded SDK to add the package to your project.
Install Unity Scripts for v59 to v66
In the downloaded zip package, there is a folder named “Unity”. Copy the following files from inside and paste them into the “Assets” folder of your Unity project.
MetaXRAudioNativeInterface.cs
MetaXRAudioRoomAcousticProperties.cs
Install Unity Scripts for v57
In v57 the C# scripts were not included in the FMOD package. v57 users can download the v59 package and use just the C# scripts for their v57 library following the steps for v59 above.
Implementation
Now that the project is set up and the plugin is ready to use, proceed to learn about how to use the features in the SDK: