Installation

Follow these steps to install Amplitude Audio SDK from official releases or by building from sources.

Get the SDK from releases#

Build the SDK from sources#

To build Amplitude from sources, you will need to first install some dependencies:

• CMake - CMake is the build system used by the SDK. It will help you generate build files for your platform.
• vcpkg - vcpkg is a free C/C++ package manager that Amplitude uses for acquiring and managing libraries on which it depends.
• flatc (optional) - flatc is the compiler of the Flatbuffers serialization format used by Amplitude to generate assets. This is only needed at build time if you are going to compile Amplitude with the provided samples.

Once you have installed dependencies you can clone the repository from GitHub using git as follows:

git clone https://github.com/SparkyStudios/AmplitudeAudioSDK.git

This will create a directory named AmplitudeAudioSDK at the location you cloned the repository. Enter that directory and use CMake to generate build files for your system:

cd AmplitudeAudioSDK
cmake -DCMAKE_TOOLCHAIN_FILE:STRING=~/vcpkg/scripts/buildsystems/vcpkg.cmake  -B ./build

Windows users may generate build files using these commands:

cd AmplitudeAudioSDK
cmake -DCMAKE_TOOLCHAIN_FILE:STRING=C:/vcpkg/scripts/buildsystems/vcpkg.cmake  -B .\build

You may need to change the CMAKE_TOOLCHAIN_FILE CMake variable to point to your installation of vcpkg. Feel free to customize the command as needed, to include for example custom generators like Ninja.

Once the generation is done, you can build the SDK with the following command:

cmake --build build

And then install it with:

cmake --build build --target install

The SDK installs itself in the same folder as the sources, in the sdk directory.

Install the SDK#

Once you have a copy of the SDK, to install it you just need to add a AM_SDK_PATH environment variable in your system, that points to the path of the sdk directory.

That’s it! You can now use Amplitude Audio SDK in your projects!