Documentation

Support

Vivox Core SDK

Vivox Core SDK

Initialization

Reference the Vivox Core SDK API.
Read time 1 minuteLast updated 20 hours 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.