Vivox Unity SDK documentation
Note: This documentation is for the Unity Vivox SDK v16. This version of the SDK has substantial changes from previous versions. If you're migrating from a previous version refer to the Upgrade Guide.
The Vivox SDK is a voice and text chat system that brings in-app communications to your project. Use and review text analysis through the Unity Moderation platform to manage your community and players.
Vivox features
- Cross-platform functionality
- Directed voice and text communication services
- Group voice and text communication services
Game developers can integrate these capabilities directly into game clients and companion applications by using the Vivox SDK.
Vivox offers additional features for speech-to-text transcriptions and text-to-speech for better accessibility for users. It also offers additional safety features through Safe Text to help reduce in-game toxicity.
Safety add-ons
Vivox has built-in support for Safe Text, a test moderation tool that helps to build more welcoming communities in your game. This tool gathers text evidence of inappropriate behavior, allowing moderators to review what happened.
Safe Text
Safe Text is a suite of safety tools you can use to tailor in-game communications rules, filter harmful messages, and collect evidence on toxic players.
Get started with Safe Text with the Safe Text documentation.
Vivox versions
If you're looking for Vivox documentation for the Core or Unreal SDK, refer to the following links:
- Vivox Core SDK documentation
- Vivox Unreal SDK documentation
- Legacy Vivox Unity (v15) SDK documentation
Unity sample projects
Test out Vivox functionality by using any of the following sample projects.
| Sample project | Description |
|---|---|
| Chat Channel Sample | This sample scene showcases voice chat, text chat, text-to-speech and muting features for immersive, interactive user engagement. |
| Text Chat Sample | A text-focused sample scene that demonstrates creating channels, sending, editing, and deleting DM or channel messages along with retrieving past conversations and their message history. Showcasing recent enrichments to the Vivox Text Chat system. |
| Megacity Metro sample | A fully functional, large-scale, cross-platform competitive multiplayer shooter. This demo uses Netcode for Entitie, Multiplay Hosting, Matchmaker, Authentication, and Vivox Voice Chat, and is intended for advanced users. Read more about it on the Megacity Metro product page. |