Vivox Reference Manual

Useful reference material for developers integrating Vivox into their projects.

Choose your operating system:

Windows

macOS

Linux

INI Settings

The following are Vivox INI settings for Unreal Engine:

DefaultEngine.ini
[VoiceChat.Vivox]
; ServerUrl from Vivox Developer Portal. Should be surrounded by double quotes.
ServerUrl=""
; Domain from Vivox Developer Portal
Domain=
; Issuer from Vivox Developer Portal
Issuer=
; Secret from Vivox Developer Portal. Should only be set during development before you have your token generation on a secure server
InsecureSecret=
; Set bVADAutomaticParameterSelection to false use default Voice Activity Detection settings
bVADAutomaticParameterSelection=true
; Set bEnableAudioDucking to true to enable audio ducking on iOS and XboxOne
bEnableAudioDucking=false

Console Command

Printing out the state information of a Vivox connection is commonly used when debugging problems during development, to do this, enter the VIVOX INFO command into the Console .

Tags
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss