NOTE: This is only applicable for Vivox Developer Portal users. Unity Dashboard users do not go through this process.
STEP 1: Create an application
When you sign in to the Vivox Developer Portal, you are brought to the Application Dashboard.
To create an application, follow the steps in How do I create an application? An application creates credentials for your game so you can sign in players to Vivox services so they can use voice chat.
STEP 2: Review credentials
There are four types of credentials:
- Endpoint: https://vdx5.www.vivox.com/api2
- Domain: vdx5.vivox.com
- Issuer: studio-abcd-dev
- Key: abc123
Endpoint is an API endpoint. It is a URL that the Vivox SDK uses to communicate with the server to perform most voice functionality.
Domain is the DNS for the Vivox server. It is used in the URIs for the channel and account names.
Issuers are used to split groups of players. Players are typically split by game title or by platform type.
- For example, all players on Game A use the issuer “studio-a123”, and all players on Game B use the issuer “studio-b456”. This allows players on Game A to talk to each other, but they cannot talk to players on Game B, even if they are in a channel with the same name.
- The same logic from the preceding example is applied if players need to be split by platform type. In this scenario, each platform gets its own issuer.
Keys are similar to passwords. A player cannot sign in to or join a channel on a server without the affiliated key.
STEP 3: Review documentation and support resources
To access the Vivox Developer Documentation, on the left side of the Vivox Developer Portal, select the Documentation link, and then select a general or platform-specific resource.
Note: To access a platform-specific resource, your user account must have the correct permissions.
- If you do not use any specific platforms, then it is recommended that you select General Core.
- The platform-specific documentation contains all of the information from General Core and additional platform-specific information and processes.
- A version drop-down menu is available in each resource to view earlier versions of the Vivox V5 documentation.
Knowledge Base and forums
To access the Knowledge Base and forums, on the left side of the Vivox Developer Portal, click the Help Center link.
- The Knowledge Base provides how-to articles, FAQs, and troubleshooting information.
- The forums provide a community for user discussion about Vivox.
STEP 4: Download the SDK
To download the Vivox V5 SDKs, on the left side of the Vivox Developer Portal, click the Downloads link.
On the Downloads page, select a platform from the drop-down menu.
Note: To access a platform-specific SDK, your user account must have the correct permissions.
After you have selected the platform, in the Release Name column, click the link for the Core SDK for that platform, and then on the pop-up that displays, click Download.
Repeat this process for each platform where you want to implement your game.