HiFi Spatialized Audio for Unity

This package provides access to HiFi Spatialized Audio in Unity.

Installation

Please see Install package.

Usage overview:

1. Create an account: https://account.highfidelity.com/dev/account
2. Create a HiFi "App" for whatever project you're workining on.
3. Create a "Space" inside the App where Users can meet.
4. For each User that will be connecting to the Space: create a JSON Web Token (JWT). The JWT is a compressed binary blob with info about the App Space and the User's publicly visible name (aka optional User ID). Note: since the User's publicly visible name is optional it is technically possible to use a single JWT for all Users in the Space, however then all HiFi peers' IncomingAudioAPIData will have unique visitHashID but the same providedUserID.
5. In the Unity project:
   1. Add com.endel.nativewebsocket package via git URL: https://github.com/endel/NativeWebSocket.git#upm
   2. Add Highfidelity's modified com.unity.webrtc package via git URL: https://github.com/highfidelity/com.unity.webrtc.git#2.4.0-directAudio
   3. Add this com.highfidelity.spatialized-audio package.
   4. Create a HiFi.HiFiCommunicator for the User.
   5. Set the HiFiCommunicator.SignalingServiceUrl to wss://api.highfidelity.com:8001/.
   6. Set the HiFiCommunicator.JWT
   7. Call HiFiCommunicator.ConnectToHiFiAudioAPIServer();
   8. Every frame set HiFiCommunicator.UserData.Position and .Orientation in the HiFi-frame. Note the HiFi world coordinate frame is right-hand Cartesian with forward=z-axis and up=y-axis. The Unity project will undoubtedly be using a different coordinate system and values must be transformed into the HiFi-frame before setting HiFiCommunicator.UserData. There is a HiFiCoordinateFrameUtil class to help with this.

Using the Bumpers Sample

1. Import the dependencies and the package https://github.com/highfidelity/hifi-spatial-audio-unity.git.
2. Import the Bumpers Sample from the package. (e.g., select the HiFi Spatialized Audio package in the Package Manager => Samples => Bumpers => Import)
3. From the Project window, add Assets => Samples => HiFi Spatialized Audio => 0.1.0 => Bumpers => Scenes => BumpersScene to the Hierarchy, and remove any other scenes.
4. In the "BumpersScene" Hierarchy, select gameManager. In the Inspector, click on the empty text box next to "Hi Fi Jwt". Enter a JWT generated from https://account.highfidelity.com
5. Set up an Input Axis Rotate if it doesn't already exist, using Edit => Project Setting... => Input Manager => Axes. Increase size to get a new field. Change values:

  Name: Rotate
  Negative Button: d
  Positive Button: a
  Alt Negative Button: right
  Alt Positive Button: left
  Gravity: 3
  Sensitivity: 3
  Snap: (checked)
  Type: Key or Mouse Button
  Axis: X axis

Licenses

• LICENSE.md
• Third Party Notices.md

Contribution

• CONTRIBUTING.md