<img src="https://certify.alexametrics.com/atrk.gif?account=bIEZv1FYxz20cv" style="display:none" height="1" width="1" alt="">
Group
Get In Touch

API & SDK DOCUMENTATION

Let’s start
building

From step-by-step guides to code examples, we've got you covered.

 

FAQ Jump to FAQ page
Guides & Code Examples Jump to Guides & Code Examples
API & SDK Reference Jump to API & SDK Reference
geometric-shapes

 

Get the Spatial Audio Client Library

Integrate Spatial Audio into your Web apps or into your NodeJS project. Contained here are the library files you can host on your own server and reference in your HTML or install the hifi-spatial-audio module. 

 
 
Install Client Libraries
Install with:
Changelog

Integrate Spatial Audio into your NodeJS projects by installing the hifi-spatial-audio module. You can use this module with loaders like Webpack. 

Add Swift Package Dependency Add Swift Package Dependency
Releases

Integrate Spatial Audio into your Swift projects.

API & SDK Reference Docs

Get all the information you may need on how to use our spatial audio with Javascript and Swift in our Client Library Docs. Programmatically create, manage, and delete spatial audio spaces with out Administrative REST API Docs.

JS Spatial Audio Client Library Docs
Swift Client Library Docs
Administrative REST API Docs

Start here:

You have a High Fidelity account and you installed the Spatial Audio Client Library. So what comes next?  If you aren't ready to dive into documentation and your own integration, check out these step-by-step guides and code examples. 

guide-card

Guides

 

faq-yellow
Frequently Asked Questions

Frequently asked questions about the Spatial Audio API, answered.
guide-green
Build a Simple Web App

Within a few minutes, you can develop a Web application that allows two or more people to talk to each other in a virtual 3D environment using the Spatial Audio API.

10-15 Minutes Beginner
guide-bright-blue
Get a JWT

A JSON Web Token authorizes your application code to connect to your Spatial Audio API Server. Learn two ways to obtain a JWT with this guide.

10-15 Minutes Intermediate
guide-pink
Make a DJ Bot

The DJ Bot you'll have created by the end of this guide will have the human users of your application dancing all night long. 🎶

30-45 Minutes Intermediate
guide-blue
Programmatic Space Management

In addition to creating spaces manually with the Developer Console, you can programmatically manage Spaces using the Administrative High Fidelity Spatial Audio REST API.

15-20 Minutes Intermediate
guide-yellow
Control the Sound of a Virtual Environment

How does your app's virtual environment sound to users? Learn all about how to change variables that affect it.

20-30 Minutes Intermediate
guide-pink
Dynamic Space Creation by Name

This guide will show you how to specify a space, connect to it, use space templates, and remove old spaces, all using High Fidelity's Spatial Audio API.

20-30 Minutes Intermediate
guide-green
Build a Dynamic Web App

Use this guide to build a Web App that lets users communicate with each other, identify each other, and move around a virtual 3D space. Crucially, JWT secrets are not exposed to users of this Web App.

45-60 Minutes Advanced
guide-bright-blue
Configure Space Capacity and the Maximum Number of Allowed Users in a Space

High Fidelity offers several different types of servers (known as "space versions") to support the needs of different customer use cases and event types. In this guide, we'll review how to choose and specify the appropriate size for a space.

45-60 Minutes Advanced
guide-yellow
Managing Connection States and Configuring Automatic Reconnections

This guide explores how your app can get information about the state of a user's connection, and explains how to manage reconnections.

45-60 Minutes Advanced
guide-pink
Attenuation and Audio Zones (Blog)

Much goes into making sounds realistic: fidelity, latency, spatialization, frequency roll-off, attenuation. In this post, we talk about attenuation, and how you can use it to create authentic or unusual audio environments.

30-45 Minutes Advanced

Code Examples

example-green
Simple Web App with I/O Device Selection

This project builds upon the "Build a Simple Web App" guide by adding code demonstrating how one may offer the user the ability to choose input and output audio devices.

10-15 Minutes Intermediate
example-bright-blue
Working with User Data Subscriptions

If you'd like your application code to react to user's data changing in a Space, you'll need to make use of User Data Subscriptions. Here's example code which covers those concepts.

10-15 Minutes Intermediate
example-pink
Integrate Spatial Audio with Twilio Videoconferencing

You can integrate High Fidelity Spatial Audio with Twilio Video Chat with this example project which places user videos in a grid. Audio associated with each video is spatialized to correspond to the listener's and speaker's position.

45-60 Minutes Intermediate
example-blue
Integrate Spatial Audio with Agora Videoconferencing

You can integrate High Fidelity Spatial Audio with Agora Video Chat with this example project which places user videos in a grid. Audio associated with each video is spatialized to correspond to the listener's and speaker's position.

45-60 Minutes Intermediate
example-bright-blue
Integrate Spatial Audio with Daily Videoconferencing

You can integrate High Fidelity Spatial Audio with Daily Video Chat with this example project which places user videos in a grid. Audio associated with each video is spatialized to correspond to the listener's and speaker's position.

45-60 Minutes Intermediate
example-green
Integrate Spatial Audio with TokBox Videoconferencing

You can integrate High Fidelity Spatial Audio with TokBox Video Chat with this example project which places user videos in a grid. Audio associated with each video is spatialized to correspond to the listener's and speaker's position.

45-60 Minutes Intermediate

Looking for more?

We love feedback. Tell us what you're looking for and we'll do our best to help.

Contact Us