Documentation
Engine
Services
Grow
Industry
Support
Engine
Services
Grow
Industry
Support
Vivox Unreal SDK
Vivox Unreal SDK
Vivox
Vivox Unreal SDK
Overview
Get started
Supported platforms and versions
Implement Vivox Unreal
Add the Vivox Unreal plug-in to a specific project
Add the Vivox Unreal plug-in to all projects
Merge multiple Unreal plug-in packages
Use the Vivox Unreal plug-in in a C++ script
Release notes
Developer guide
Set up your project
Load the VivoxCore module
Initialize the voice client object
Sign in to a game
Sign out of a game
Uninitialize the Vivox SDK
Unity Authentication Service in Unreal
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 events
Join a channel
Request capture device access
Initiate a channel join
Leave a channel
Audio injection
Automatic connection recovery
Messaging
Send and receive group text messages
Directed text
Send data through text messages
Text chat developer guide
Adaptive chat filter
Text evidence management
Evidence report API
Evidence report HTTP request
Evidence report HTTP response example
Anti-flooding
Large text channel setting
Channel-specific options
Audio management
In-game audio control
In-game audio device selection
In-game control of audio levels
Create a dynamic voice energy meter
Muting
Mute a user's microphone
Mute other users
Crossmute functions
In-game moderation
Requirements
Moderation SDK
Moderation actions
Evidence management
Android app development
Android SDK permission requirements
Request runtime permissions
Android speakerphone audio: Mono or stereo
Troubleshooting Bluetooth SCO underrun issues
iOS app development
Acoustic echo cancellation
Initialize the AVAudioSession on app startup
AVAudioSessionModeVoiceChat
AVAudioSession configuration when using WWise
iOS known limitations
Cannot set iOS device volume to 0 when Voice-Processing I/O unit is active
The iOS microphone recording indicator
AVAudioPlayer volume inconsistencies
Volume shifts
Restore audio volume
Server-side recording
Required permissions for Amazon S3 buckets
Subscribe API query parameters
Server-side recording decoder
Decode API query parameters
Make a decode request
Decode a subscription with different options
Automatically end a server-side recording subscription
Server-side recording API usage examples
Make a channel history-only request
Make a speaker history-only request
Make a channel TTL-only request
Make a speaker TTL-only request
Make a channel history and TTL request
Make a speaker history and TTL request
Filter a channel by speaker
Filter a speaker by channel
Speech-to-text audio transcription
Audio transcription conditions
Audio transcription delivery
Enable speech-to-text transcription
Disable speech-to-text transcription
Audio transcription language support
Audio transcription error codes
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
Text-to-speech events
Get raw audio of synthesized speech
Use text-to-speech for incoming messages
Transmission
Transmission methods
Transmission modes
Push-to-talk
Troubleshooting
Voice activity detection
Parameter specifics
VAD adjustments
Vivox SDK error codes
Tutorials
Unreal Shooter Game sample app
Sample app requirements
Sample app package contents
Sample app design overview
Sample app examples of Vivox functionality
Update sample app environment and API values
Reference
Vivox Core Unreal class model overview
Class model diagram
Directed messaging diagram
Channel voice and messaging diagram
Vivox Unreal conventions
Asynchronous method calls
Events
Return values
Unreal types
Unreal API Reference Manual
Class List
AccountId
Channel3DProperties
ChannelId
FVivoxCoreModule
IAudioDevice
IAudioDevices
IChannelConnectionState
IChannelSession
IChannelTextMessage
IClient
IDirectedTextMessage
ILoginSession
IParticipant
IParticipantProperties
IPresenceLocation
IPresenceSubscription
ITextMessage
ITextToSpeech
ITranscribedMessage
ITTSAudioBuffer
ITTSMessage
ITTSVoice
Presence
VivoxConfig
Deprecated List
Access Token Developer Guide
Access token terminology
Requests that require access tokens
Access token identifiers
Usernames
Channel names
Access token issuers and signing keys
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 on the client
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
Server to Server Web API Reference Guide
Prerequisites
Authentication
Access tokens
Channel and user identification
User URI structure
Channel URI structure
Parameters
Common parameters
Fully qualified identifiers
Login API
Control active channels API
Mute a user in a channel
Mute all users in a channel
Unmute a user in a channel
Unmute all users in a channel
Kick a user from a channel
Kick all users from a channel
Kick API
Access token claims for the Kick API
URI structure for the Kick API
Kick a user from a channel
Kick a user from a server
Error handling
Third-party license information
Modules
Reference all Vivox Unreal SDK modules.
Read time 1 minute
Last updated 2 days ago