Diagnostics

Reference the Vivox Core SDK API.

Read time 7 minutes

Last updated 7 months ago

Classes

	Name
struct	vx_req_aux_connectivity_info Perform a network test.
struct	vx_req_account_post_crash_dump Post crash dump data to the server.
struct	vx_resp_aux_connectivity_info The response for vx_req_aux_connectivity_info.
struct	vx_resp_account_post_crash_dump The response for vx_req_account_post_crash_dump.

Types

	Name
typedef struct vx_req_aux_connectivity_info	vx_req_aux_connectivity_info_t Perform a network test.
typedef struct vx_req_account_post_crash_dump	vx_req_account_post_crash_dump_t Post crash dump data to the server.
typedef struct vx_resp_aux_connectivity_info	vx_resp_aux_connectivity_info_t The response for vx_req_aux_connectivity_info.
typedef struct vx_resp_account_post_crash_dump	vx_resp_account_post_crash_dump_t The response for vx_req_account_post_crash_dump.

Functions

	Name
VIVOXSDK_DLLEXPORT int	vx_register_logging_initialization(vx_log_type log_type, const char * log_folder, const char * log_filename_prefix, const char * log_filename_suffix, int log_level, void()(const char source, const char level, const char message) pf_handler) Register a callback that is called to initialize logging.
VIVOXSDK_DLLEXPORT char *	vx_get_log_file_path(void )
VIVOXSDK_DLLEXPORT int	vx_unregister_logging_handler(void()(void ) pf_handler, void * cookie) Unregister the logging callback notification handler.
VIVOXSDK_DLLEXPORT int	vx_get_crash_dump_count(void ) The number of crash dumps stored on disk.
VIVOXSDK_DLLEXPORT int	vx_set_crash_dump_generation_enabled(int value) Enable crash dump generation.
VIVOXSDK_DLLEXPORT int	vx_get_crash_dump_generation(void ) Determine if crash dump generation is enabled.
VIVOXSDK_DLLEXPORT char *	vx_read_crash_dump(int index) Get the Base64-encoded crash dump information.
VIVOXSDK_DLLEXPORT time_t	vx_get_crash_dump_timestamp(int index) Get the timestamp of a crash.
VIVOXSDK_DLLEXPORT int	vx_delete_crash_dump(int index) Delete the crash dump.
VIVOXSDK_DLLEXPORT const char *	vx_get_sdk_version_info(void ) Get the SDK version info.
VIVOXSDK_DLLEXPORT const char *	vx_get_sdk_version_info_ex(void ) Get the SDK extended version info.
VIVOXSDK_DLLEXPORT char *	vx_get_random_user_id(const char * prefix) Get a random guest user ID with the given prefix.
VIVOXSDK_DLLEXPORT char *	vx_get_random_user_id_ex(const char * prefix, const char * issuer) Get a random guest user ID for the given issuer with the given prefix.
VIVOXSDK_DLLEXPORT char *	vx_get_random_channel_uri(const char * prefix, const char * realm) Get a random ephemeral channel ID with the given prefix for the specific realm.
VIVOXSDK_DLLEXPORT char *	vx_get_random_channel_uri_ex(const char * prefix, const char * realm, const char * issuer) Get a random ephemeral channel ID for the given issuer with the given prefix for the specific realm.
VIVOXSDK_DLLEXPORT int	vx_crash_test(vx_crash_test_type_t crash_type) Crash the program.
VIVOXSDK_DLLEXPORT int	vx_set_message_rate_params(unsigned bucketSize, float messageSpeed, int fillBucket) Change the API message rate parameters.
VIVOXSDK_DLLEXPORT int	vx_set_default_message_rate_params(void ) Return the API message rate parameters to their default state.
VIVOXSDK_DLLEXPORT int	vx_android_set_mic_mute(int mute) Mute or unmute the mic on Android.
VIVOXSDK_DLLEXPORT int	vx_internal_enable_debug_mode_disable_strict_checks(void ) Internal: enable debug mode and disable the strict parameter check of some requests.
VIVOXSDK_DLLEXPORT int	vx_internal_disable_debug_mode_enable_strict_checks(void ) Internal: disable the debug mode enabled by vx_internal_enable_debug_mode_disable_strict_checks.
VIVOXSDK_DLLEXPORT int	vx_req_aux_connectivity_info_create(vx_req_aux_connectivity_info_t ** req) Allocate and initialize a vx_req_aux_connectivity_info object.
VIVOXSDK_DLLEXPORT int	vx_req_account_post_crash_dump_create(vx_req_account_post_crash_dump_t ** req) Allocate and initialize a vx_req_account_post_crash_dump object.
VIVOXSDK_DLLEXPORT const char *	vx_get_error_string(int errorCode) Get an error string for a particular error code.

Types Documentation

typedef vx_req_aux_connectivity_info_t


typedef struct vx_req_aux_connectivity_info vx_req_aux_connectivity_info_t;

Perform a network test.

See: vx_resp_aux_connectivity_info

Note: The SDK ships with a sample Network Troubleshooter that can be used as is or as a reference to create a custom Network Troubleshooter.

This command probes the network and performs tests to determine if the application will have the connectivity required to perform the tasks needed to send and receive presence, IM, and media information. This call tests network connectivity issues, such as creating a "Network Troubleshooter" tool that can be standalone or integrated into an application. This single call returns results for all of the tests that are performed, and the data can be displayed to the user.

typedef vx_req_account_post_crash_dump_t


typedef struct vx_req_account_post_crash_dump vx_req_account_post_crash_dump_t;

Post crash dump data to the server.

See: vx_resp_account_post_crash_dump

Note: This command is not an application to the XML interface.

Attention: This is not supported on the iPhone platform.

typedef vx_resp_aux_connectivity_info_t


typedef struct vx_resp_aux_connectivity_info vx_resp_aux_connectivity_info_t;

The response for vx_req_aux_connectivity_info.

See: vx_req_aux_connectivity_info

typedef vx_resp_account_post_crash_dump_t


typedef struct vx_resp_account_post_crash_dump vx_resp_account_post_crash_dump_t;

The response for vx_req_account_post_crash_dump.

See: vx_req_account_post_crash_dump

Note: This response is not applicable to the XML interface.

Functions Documentation

function vx_register_logging_initialization


VIVOXSDK_DLLEXPORT int vx_register_logging_initialization(    vx_log_type log_type,    const char * log_folder,    const char * log_filename_prefix,    const char * log_filename_suffix,    int log_level,    void(*)(const char *source, const char *level, const char *message) pf_handler)

The application should use this to signal the main application thread that will then wakeup and call vx_get_message;

function vx_get_log_file_path


VIVOXSDK_DLLEXPORT char * vx_get_log_file_path(    void )

Deprecated:

File logging is not supported. Get the SDK log file path.

function vx_unregister_logging_handler


VIVOXSDK_DLLEXPORT int vx_unregister_logging_handler(    void(*)(void *) pf_handler,    void * cookie)

Unregister the logging callback notification handler.

Parameters:

pf_handler - OBSOLETE AND UNUSED
cookie - OBSOLETE AND UNUSED

Because the parameters are reserved for future use, pass NULL for each of the parameters (for example: vx_unregister_logging_handler(0, 0);). If a logging handler is registered, then it must be unregistered before shutting down the SDK.