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
  • Reference
    • Access Token Developer Guide
    • Server to Server Web API Reference Guide
    • Core API Reference Manual
      • Modules
        • Initialization
        • Sending and Receiving Vivox Messages
        • Memory Management
        • Logging In and Logging Out
        • Group Voice and Text Communications
        • Audio Devices
        • Diagnostics
      • Data Structures
      • Deprecated List
    • Third-party license information
  • Privacy overview
  1. Vivox Core SDK documentation

Initialization

Reference the Vivox Core SDK API.
Read time 2 minutes
Last updated 8 months ago

Classes

Name

structvx_sdk_config
Configuration options that are passed to [vx_initialize3()].

Types

Name

typedef struct vx_sdk_configvx_sdk_config_t
Configuration options that are passed to [vx_initialize3()].

Functions

Name

VIVOXSDK_DLLEXPORT intvx_initialize3(vx_sdk_config_t * config, size_t config_size)
An application must call this API before calling any other Vivox API, except [vx_get_default_config3()];.
VIVOXSDK_DLLEXPORT intvx_is_initialized(void )
Check if the Vivox SDK was initialized with an vx_initialize3() call, and not yet uninitialized with an [vx_uninitialize()] call.
VIVOXSDK_DLLEXPORT intvx_get_default_config3(vx_sdk_config_t * config, size_t config_size)
An application must call this API before calling any other Vivox API.
VIVOXSDK_DLLEXPORT intvx_uninitialize(void )
An application must call this before exit.

Types Documentation

typedef vx_sdk_config_t

typedef struct vx_sdk_config vx_sdk_config_t;
Configuration options that are passed to [vx_initialize3()].

Functions Documentation

function vx_initialize3

VIVOXSDK_DLLEXPORT int vx_initialize3(    vx_sdk_config_t * config,    size_t config_size)
An application must call this API before calling any other Vivox API, except [vx_get_default_config3()];.
Return: - 0 if successful, non-zero if failed.

function vx_is_initialized

VIVOXSDK_DLLEXPORT int vx_is_initialized(    void )
Check if the Vivox SDK was initialized with an vx_initialize3() call, and not yet uninitialized with an [vx_uninitialize()] call.
Return: - 0 if not initialized, non-zero if initialized.

function vx_get_default_config3

VIVOXSDK_DLLEXPORT int vx_get_default_config3(    vx_sdk_config_t * config,    size_t config_size)
An application must call this API before calling any other Vivox API.
Return: - 0 if successful, non-zero if failed.

function vx_uninitialize

VIVOXSDK_DLLEXPORT int vx_uninitialize(    void )
An application must call this before exit.
Return: - 0 if successful, non-zero if failed.
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.

  • On this page

    • Classes

    • Types

    • Functions

    • Types Documentation

      • typedef vx_sdk_config_t

    • Functions Documentation

      • function vx_initialize3

      • function vx_is_initialized

      • function vx_get_default_config3

      • function vx_uninitialize

Report a problem with this page