Diagnostics

---

Classes

Types

Functions

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)

Register a callback that is called to initialize logging. 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.

function vx_get_crash_dump_count

VIVOXSDK_DLLEXPORT int vx_get_crash_dump_count(    void )

The number of crash dumps stored on disk. Note: Not supported on mobile or console platforms.

function vx_set_crash_dump_generation_enabled

VIVOXSDK_DLLEXPORT int vx_set_crash_dump_generation_enabled(    int value)

Enable crash dump generation. Note: Not supported on mobile or console platforms.

function vx_get_crash_dump_generation

VIVOXSDK_DLLEXPORT int vx_get_crash_dump_generation(    void )

Determine if crash dump generation is enabled. Note: Not supported on mobile or console platforms.

function vx_read_crash_dump

VIVOXSDK_DLLEXPORT char * vx_read_crash_dump(    int index)

Get the Base64-encoded crash dump information. Note: Not supported on mobile or console platforms.

function vx_get_crash_dump_timestamp

VIVOXSDK_DLLEXPORT time_t vx_get_crash_dump_timestamp(    int index)

Get the timestamp of a crash. Note: Not supported on mobile or console platforms.

function vx_delete_crash_dump

VIVOXSDK_DLLEXPORT int vx_delete_crash_dump(    int index)

Delete the crash dump. Note: Not supported on mobile or console platforms.

function vx_get_sdk_version_info

VIVOXSDK_DLLEXPORT const char * vx_get_sdk_version_info(    void )

Get the SDK version info.

function vx_get_sdk_version_info_ex

VIVOXSDK_DLLEXPORT const char * vx_get_sdk_version_info_ex(    void )

Get the SDK extended version info.

function vx_get_random_user_id

VIVOXSDK_DLLEXPORT char * vx_get_random_user_id(    const char * prefix)

Get a random guest user ID with the given prefix. Parameters:

• - [in] prefix The prefix for the user.

Note: This must be deallocated with vx_free(); The returned ID always starts and ends with the '.' character.

function vx_get_random_user_id_ex

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. Parameters:

• prefix - [in] The prefix for the user.
• issuer - [in, optional] The issuer. If NULL or an empty string is passed, the generated user ID is the same as what is generated by vx_get_random_user_id().

Note: This must be deallocated with vx_free(); The returned ID always starts and ends with the '.' character.

function vx_get_random_channel_uri

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. Parameters:

• prefix - [in] The prefix for the channel.
• realm - [in] The realm for that channel (for example, mt1s.vivox.com).

Note: This must be deallocated with vx_free(); The prefix should start with one of the following options: confctl-g- for general non-positional channels confctl-e- for echo channels confctl-d- for positional channels

function vx_get_random_channel_uri_ex

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. Parameters:

• prefix - [in] The prefix for the channel.
• realm - [in] The realm for that channel (for example, mt1s.vivox.com).
• issuer - [in, optional] The issuer. If NULL or an empty string is passed, the generated channel ID is the same as what is generated by vx_get_random_channel_uri().

Note: This must be deallocated with vx_free(); The prefix should start with one of the following options: confctl-g- for general non-positional channels confctl-e- for echo channels confctl-d- for positional channels

function vx_crash_test

VIVOXSDK_DLLEXPORT int vx_crash_test(    vx_crash_test_type_t crash_type)

Crash the program. Parameters:

• crash_type - The type of crash (see vx_crash_test_type).

function vx_set_message_rate_params

VIVOXSDK_DLLEXPORT int vx_set_message_rate_params(    unsigned bucketSize,    float messageSpeed,    int fillBucket)

Change the API message rate parameters. Parameters:

• messageSpeed - Messages per second.
• fillBucket - is bool

function vx_set_default_message_rate_params

VIVOXSDK_DLLEXPORT int vx_set_default_message_rate_params(    void )

Return the API message rate parameters to their default state.

function vx_android_set_mic_mute

VIVOXSDK_DLLEXPORT int vx_android_set_mic_mute(    int mute)

Mute or unmute the mic on Android. Parameters:

• mute - Non-zero mutes the microphone; 0 unmutes.

Return: - Non-zero if previous state was muted, 0 if previous state was unmuted. Note: Android platform only. Does nothing on other platforms.

function vx_internal_enable_debug_mode_disable_strict_checks

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. Attention: Do not call this function if you are not completely sure of what are you doing!

function vx_internal_disable_debug_mode_enable_strict_checks

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. Attention: Do not call this function if you are not completely sure of what are you doing!

function vx_req_aux_connectivity_info_create

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.

function vx_req_account_post_crash_dump_create

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. Attention: This is not supported on the iPhone platform.

function vx_get_error_string

VIVOXSDK_DLLEXPORT const char * vx_get_error_string(    int errorCode)

Get an error string for a particular error code.