Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Implement Vivox Unreal

Follow this workflow to implement the Vivox Unreal SDK your project.
Read time 1 minuteLast updated 3 days ago

To implement the Vivox Unreal SDK, you need the following items, which you can find on the Unity Dashboard:
  • The URL for your Vivox API endpoint
  • The host for your Vivox domain
  • Your Vivox access token issuer and key pair.
    • You use these to sign Vivox access tokens on your server and distribute those tokens to your game clients.
      Note
      You can initially sign access tokens with your game client, but this is not a recommended production practice.
    • For more information, refer to the Access Token Developer Guide.
  • A Vivox Unreal SDK distribution for each of the platforms that will be supported by your game. Each distribution contains the following resources:
    • A
      VivoxCore
      directory, which contains the VivoxCore module and the
      VivoxCore.h
      header file to include in your sources.
    • One or more sample applications that demonstrate how to use the Vivox Unreal SDK.
These distributions come in the form of platform-specific archives (.zip or .tgz). Unzip the archive to a convenient location in your game source code working copy. After you familiarize yourself with the items in this list, decide if you want to make the Vivox Core Unreal plug-in available to a specific project or to all of your Unreal projects.