Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_evt_voice_service_connection_state_changed

Reference the Vivox Core SDK API.
Read time 1 minuteLast updated 12 days ago

Raised when the SDK is running out of process and the connection state of the Vivox Voice Service (VVS) changes. More...
#include <VxcEvents.h>

Public Attributes

Name

vx_evt_base_tbase
The common properties for all events.
intconnected
Indicates whether the voice service connection state is connected.
char *platform
The platform of the machine that the voice service is running on.
char *version
The version of the voice service.
char *data_directory
The data directory.
intnetwork_test_run
Indicates whether the network test ran.
intnetwork_test_completed
Indicates whether the network test completed.
intnetwork_test_state
Indicates whether the network test has passed or failed.
intnetwork_is_down
Indicates if the network is down.

Detailed Description

struct vx_evt_voice_service_connection_state_changed;
Raised when the SDK is running out of process and the connection state of the Vivox Voice Service (VVS) changes. Sent when the connection is made and when the connection is lost. Alerts the application so the VVS can be restarted, if needed.

Public Attributes Documentation

variable base

vx_evt_base_t base;
The common properties for all events.

variable connected

int connected;
Indicates whether the voice service connection state is connected.

variable platform

char * platform;
The platform of the machine that the voice service is running on.

variable version

char * version;
The version of the voice service.

variable data_directory

char * data_directory;
The data directory.

variable network_test_run

int network_test_run;
Indicates whether the network test ran.

variable network_test_completed

int network_test_completed;
Indicates whether the network test completed.

variable network_test_state

int network_test_state;
Indicates whether the network test has passed or failed. This can change depending on the network connection and the power state of the machine.

variable network_is_down

int network_is_down;
Indicates if the network is down.