Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Core SDK

Vivox Core SDK

Vivox
​
​
Vivox Core SDK
  • Overview
  • Before you begin
  • Get started
  • Release notes
  • Developer Guide
    • Client SDK basics
      • Initialize the Vivox SDK
      • Handle messages
      • Message types
      • Character encoding
      • Requests and responses
      • Create the connector object
      • Sign in to a game
      • Sign out of a game
      • Uninitialize the Vivox SDK
    • Channels
    • Presence management
    • Messaging
    • Manage audio
    • Couch co-op
    • Android app development
    • iOS app development
    • macOS app development
    • Windows app development
    • Real-time recording
    • Speech-to-text audio transcription
    • Text-to-speech
    • Troubleshooting
  • Reference
  • Privacy overview
  1. Vivox Core SDK documentation

Initialize the Vivox SDK

How to initialize the Vivox voice client object.
Read time 1 minute
Last updated 8 months ago
Before the game can issue requests to the Vivox SDK, it must first initialize the Vivox SDK by calling 
vx_initialize3()
. This operation might cause additional shared libraries to be loaded, which can take anywhere from a few milliseconds to hundreds of milliseconds, depending on the machine.
Note
We recommend that you call 
vx_initialize3()
on application startup.
The following code displays an example of how to initialize the Vivox SDK:
#include"Vxc.h"#include"VxcErrors.h". . .vx_sdk_config_t defaultConfig;int status = vx_get_default_config3(&defaultConfig, sizeof (defaultConfig));if (status != VxErrorSuccess){    printf("vx_sdk_get_default_config3() returned %d: %s\n", status,    vx_get_error_string(status));    return;}status = vx_initialize3(&defaultConfig, sizeof (defaultConfig));if (status != VxErrorSuccess){    printf ("vx_initialize3() returned %d : %s\n", status, vx_get_error_string(status));    return;}// Vivox Client SDK is now initialized
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo 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.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

    Report a problem with this page