Documentation

Support

Engine

Services

Grow

Industry

Support

Vivox Unity SDK

Vivox Unity SDK

Vivox Unity SDK

Overview
Get started

SDK 16.0.0 upgrade guide
Supported platforms and versions

WebGL SDK support
NDA platform SDKs

Release notes
Developer guide

Set up your project

Integration with the Vivox Unity SDK
Initialize the SDK

Sign in with the Authentication package
Sign in with Custom IDs
Using Vivox Access Tokens together with UAS

Sign in to a game
Sign out of a game

Create voice and text channels

Channel management
Channel name criteria
Channel types
Positional channels

Large 3D channels setting
Positional channel properties
Positional channel configuration

Channel identifiers for large scale games
Participant management
Join a channel

Request capture device access
Initiate a channel join

Leave a channel
Automatic connection recovery

Messaging

Channel messages
Message metadata
Chat history

Chat History query options

Edit and delete messages
Directed messages
Offline direct messages
Anti-flooding
Large text channel setting
Retrieve Conversations list
Set Chat Markers

Player management

Automatic connection recovery

Network reconnect failure
Partial connection failure

Muting

Mute a user's microphone
Mute other users for a specific user

Block functions

Device management

In-game audio device selection

Audio management

Acoustic echo cancellation
In-game control of audio levels
Audio source integration

Unity Editor Audio Tap components
General use of the Audio Tap components
Audio Taps component parameters
Access audio data
Use Audio Taps in C# scripts

Transmission

Transmitting channels
Transmission modes
Push-to-talk

Mobile development

Android app development

Android SDK permission requirements
Request runtime permissions
Android speakerphone audio: Mono or stereo
ProGuard rules
Troubleshooting Bluetooth SCO underrun issues

iOS app development

The iOS microphone recording indicator

Text-to-speech

Text-to-speech voice options
Text-to-speech destinations
Inject a text-to-speech message
Queue a text-to-speech message
Cancel a text-to-speech message

Speech-to-text

Audio transcription conditions
Speech-to-text API
Speech-to-text and audio injection

Server-side-recording

Migrate from V1 to V2
Callback Server

Troubleshooting

Voice activity detection
Vivox SDK error codes

Tutorials

Implement Vivox Unity

Unity Package Manager Vivox package
Vivox Unity package structure
Add the Vivox package to a Unity project
Project settings
Integrate an existing project using VATs with Unity Authentication

Access Token Developer Guide

Access token terminology
Requests that require access tokens
Access token identifiers

Usernames
Access token issuers and signing keys
Channel names

Access token format

Access token header
Access token payload
Access token signature
Supported values for the Vivox action claim

Access token examples

Example: Login token
Example: Join token
Example: Join_Muted token
Example: Kick tokens
Example: Drop_All token
Example: Mute tokens
Example: Mute_All token
Example: Transcription token

Generate a token from the client

Authentication-based token generation
Interface implementation-based token generation

Generate a token on a secure server

Example: C++
Example: C#
Example: Python
Example: JavaScript

Key update API

Add an application API key
Revoke an application API key
Troubleshooting an application API key

Access token error codes

Reference

Chat Channel Sample

Import the Chat Channel Sample
Build the Chat Channel Sample
Vivox SDK error codes

Text Chat Sample
Vivox Unity SDK
Third-party license information

Vivox Unity SDK documentation

Production best practices

Follow best practices for managing Vivox access token signing keys in production.

Read time 1 minute

Last updated 2 days ago

Copyright © 2026 Unity Technologies

LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Report a problem with this page