Get Started

Overview

The Immersitech SDK is a C/C++ library that functions as an audio mixer and audio processor featuring 3D spatial audio processing, noise cancellation, and speech enhancement.
The Immersitech SDK is currently made for people who have direct access to raw audio data. If you can access this, the SDK can collect them and return to you a raw audio output buffer that has been processed. Additionally, the Immersitech SDK allows you to change the audio settings in real time for any participant.

Installation

Prerequisites

Obtain a License Key

If you haven't done so already please reach out to us about starting a trial of the Immersitech Engage™ Core SDK now. You will need to obtain a license key before you can use the audio processing features that the sdk offers.

Download the binaries

You'll need to download the pre-compiled binaries from the Releases section of the immersitech-engage Github repo. Please select the tar file that is specific to the platform where you will be developing with the Immersitech SDK.

 

Windows

The tar file includes libimmersitech.dll and libimmersitech.lib. You will need to link these files to your project. If you need additional help with Windows development please see the Visual Studio projects in our code examples.

Mac

The tar file includes libimmersitech.dylib. You will need to link this file to your project. If you need additional help with Mac development please see the Makefiles in our code examples.

Linux

The tar file includes libimmersitech.so. You will need to link this file to your project. If you need additional help with Linux development please see the Makefiles in our code examples.

Make sure that your C / C++ libraries are up to at least:

Ubuntu: `GLIBC_2.27`

Debian: `GLIBC_2.29`

If you plan on using the websocket server feature of the library, you will need to install and link the following libraries to your program:

`-lcrypto -lssl`

Generic Instructions

To use the Immersitech Library, include immersitech.h in your projects and add the functions to your code. You will also need to make sure to link the dynamic library to your project and ensure it is in the location you linked it to. When you initialize the Immersitech library you will need to provide the correct path to your license file.

The following files are also included in the tar file and are optional for more advanced feature usage:

- immersitech_logger.h (optional if you want to implement a custom logger)
- immersitech_event_manager.h (optional if you want to implement a custom even manager)
- room_layout.json (optional if you want to use custom room layouts)
- websocket_config.json (optional if you want to use the websocket server)

Concepts

Before diving into how to utilize the library, be sure to read the documents in this section to get an understanding of terminology that will be used throughout the documentation.