sdk/Vxc.h#

Classes#

Types#

Functions#

Defines#

Types Documentation#

enum vx_attempt_stun#

A type of STUN probe.

enum vx_connector_mode#

A type of API mode.

The required setting is connector_mode_normal.

enum vx_session_handle_type#

A type of API mode.

The recommended setting is connector_mode_normal.

enum vx_log_type#

A type of logging for the application.

The Vivox SDK is capable of logging to a native log file and/or sending log information to the client application through a callback method registered with the SDK.

enum vx_message_type#

Used as a run time type indicator for all messages passed between the application and SDK.

enum vx_sessiongroup_recording_control_type#

enum vx_sessiongroup_audio_injection_control_type#

enum vx_sessiongroup_playback_control_type#

enum vx_sessiongroup_playback_mode#

enum vx_control_communications_operation#

The methods in which communication can be controlled.

enum vx_media_type#

enum vx_termination_status#

enum vx_diagnostic_dump_level#

enum vx_media_ringback#

enum vx_channel_type#

enum vx_channel_mode#

enum vx_channel_search_type#

enum vx_channel_moderation_type#

enum vx_sessiongroup_type#

The type of the session group specified at session group creation time.

enum vx_participant_removed_reason#

Indicates the reason why a participant was removed from a session.

enum vx_connection_state#

Indicates current network connection state.

enum vx_request_type#

The set of requests that can be issued.

enum vx_response_type#

Response types that are reported back to the calling app.

enum vx_event_type#

Event types that are reported back to the calling app.

enum ND_ERROR#

enum ND_TEST_TYPE#

enum vx_session_answer_mode#

Determine how incoming calls are handled.

Set at login.

enum vx_buddy_management_mode#

enum vx_rule_type#

enum vx_font_type#

enum vx_font_status#

enum vx_subscription_type#

enum vx_notification_type#

enum vx_dtmf_type#

enum vx_text_mode#

enum vx_channel_lock_mode#

enum vx_mute_scope#

enum vx_recording_frame_type_t#

Hold a recorded audio frame.

enum vx_audiosource_operation#

enum vx_aux_audio_properties_state#

enum vx_login_state_change_state#

enum vx_publication_state_change_state#

enum vx_buddy_presence_state#

enum vx_presence_state#

enum vx_session_notification_state#

enum vx_message_state#

enum vx_session_text_state#

enum vx_session_media_state#

enum vx_participant_type#

enum orientation_type#

enum vx_media_completion_type#

enum vx_device_type#

The type of device.

enum vx_conversation_type#

enum vx_codec#

The configured_codecs field in vx_req_connector_create is a mask of these constants.

enum vx_application_state_notification_type#

Indicates the state of the application.

Note: Valid only on mobile platforms.

enum VXA_ERROR_CODES#

Error codes that are returned by the VXA subsystem.

enum VXA_CAPTURE_FLAGS#

Values passed when opening capture devices.

enum vx_channel_rolloff_curve_type#

Rolloff curve types to serve as the distance model for a positional channel.

This tells the server which algorithm to use when computing attenuation.

enum vx_opus_vbr_mode#

Values for OPUS VBR mode.

enum vx_opus_bandwidth#

Values for OPUS bandwidth.

enum vx_crash_test_type#

Values for vx_crash_test( crash type ).

enum vx_path_id#

The type of path used by the SDK.

enum vx_noise_suppression_level#

enum vx_tts_destination#

Text-to-speech (TTS) definitions.

Destination definitions used by the text-to-speech subsystem.

enum vx_tts_status#

Status codes that are returned by the text-to-speech subsystem.

enum vx_tts_engine_type#

Text-to-speech engine types.

typedef VX_COOKIE#

typedef char* VX_COOKIE;

A request cookie type.

Used when passing in requests to the SDK.

typedef VX_HANDLE#

typedef VX_COOKIE VX_HANDLE;

A generic handle type for state objects (for example: accounts, connectors, sessions, or session groups).

typedef VX_SDK_HANDLE#

typedef unsigned int VX_SDK_HANDLE;

typedef vx_time_t#

typedef time_t vx_time_t;

typedef vx_message_base_t#

typedef struct vx_message_base vx_message_base_t;

typedef vx_req_base_t#

typedef struct vx_req_base vx_req_base_t;

typedef vx_resp_base_t#

typedef struct vx_resp_base vx_resp_base_t;

typedef vx_evt_base_t#

typedef struct vx_evt_base vx_evt_base_t;

typedef vx_state_buddy_contact_t#

typedef struct vx_state_buddy_contact vx_state_buddy_contact_t;

typedef vx_state_buddy_contact_ref_t#

typedef vx_state_buddy_contact_t* vx_state_buddy_contact_ref_t;

typedef vx_state_buddy_contact_list_t#

typedef vx_state_buddy_contact_ref_t* vx_state_buddy_contact_list_t;

typedef vx_state_buddy_t#

typedef struct vx_state_buddy vx_state_buddy_t;

typedef vx_state_buddy_ref_t#

typedef vx_state_buddy_t* vx_state_buddy_ref_t;

typedef vx_state_buddy_list_t#

typedef vx_state_buddy_ref_t* vx_state_buddy_list_t;

typedef vx_state_buddy_group_t#

typedef struct vx_state_buddy_group vx_state_buddy_group_t;

typedef vx_state_buddy_group_ref_t#

typedef vx_state_buddy_group_t* vx_state_buddy_group_ref_t;

typedef vx_state_buddy_group_list_t#

typedef vx_state_buddy_group_ref_t* vx_state_buddy_group_list_t;

typedef vx_participant_t#

typedef struct vx_participant vx_participant_t;

Channel participant.

typedef vx_participant_ref_t#

typedef vx_participant_t* vx_participant_ref_t;

Creates a participant list with the given size.

typedef vx_participant_list_t#

typedef vx_participant_ref_t* vx_participant_list_t;

typedef vx_state_participant_t#

typedef struct vx_state_participant vx_state_participant_t;

State participant.

Only used for state dump.

typedef vx_state_participant_ref_t#

typedef vx_state_participant_t* vx_state_participant_ref_t;

Creates a state_participant list with the given size.

typedef vx_state_participant_list_t#

typedef vx_state_participant_ref_t* vx_state_participant_list_t;

typedef vx_state_session_t#

typedef struct vx_state_session vx_state_session_t;

State session.

Only used for state dump.

typedef vx_state_session_ref_t#

typedef vx_state_session_t* vx_state_session_ref_t;

Creates a state_session list with the given size.

typedef vx_state_session_list_t#

typedef vx_state_session_ref_t* vx_state_session_list_t;

typedef vx_state_sessiongroup_t#

typedef struct vx_state_sessiongroup vx_state_sessiongroup_t;

State session group.

Only used for state dump.

typedef vx_state_sessiongroup_ref_t#

typedef vx_state_sessiongroup_t* vx_state_sessiongroup_ref_t;

Creates a state_sessiongroup list with the given size.

typedef vx_state_sessiongroup_list_t#

typedef vx_state_sessiongroup_ref_t* vx_state_sessiongroup_list_t;

typedef vx_state_account_t#

typedef struct vx_state_account vx_state_account_t;

State account.

Only used for state dump.

typedef vx_state_account_ref_t#

typedef vx_state_account_t* vx_state_account_ref_t;

Creates a state_account list with the given size.

typedef vx_state_account_list_t#

typedef vx_state_account_ref_t* vx_state_account_list_t;

typedef vx_state_connector_t#

typedef struct vx_state_connector vx_state_connector_t;

State connector.

Only used for state dump.

typedef vx_state_connector_ref_t#

typedef vx_state_connector_t* vx_state_connector_ref_t;

Creates a state_connector list with the given size.

typedef vx_state_connector_list_t#

typedef vx_state_connector_ref_t* vx_state_connector_list_t;

typedef vx_channel_t#

typedef struct vx_channel vx_channel_t;

Channel struct.

typedef vx_channel_ref_t#

typedef vx_channel_t* vx_channel_ref_t;

typedef vx_channel_list_t#

typedef vx_channel_ref_t* vx_channel_list_t;

typedef vx_voice_font_t#

typedef struct vx_voice_font vx_voice_font_t;

Voice font struct.

typedef vx_voice_font_ref_t#

typedef vx_voice_font_t* vx_voice_font_ref_t;

typedef vx_voice_font_list_t#

typedef vx_voice_font_ref_t* vx_voice_font_list_t;

typedef vx_block_rule_t#

typedef struct vx_block_rule vx_block_rule_t;

typedef vx_block_rule_ref_t#

typedef vx_block_rule_t* vx_block_rule_ref_t;

typedef vx_block_rules_t#

typedef vx_block_rule_ref_t* vx_block_rules_t;

typedef vx_auto_accept_rule_t#

typedef struct vx_auto_accept_rule vx_auto_accept_rule_t;

typedef vx_auto_accept_rule_ref_t#

typedef vx_auto_accept_rule_t* vx_auto_accept_rule_ref_t;

typedef vx_auto_accept_rules_t#

typedef vx_auto_accept_rule_ref_t* vx_auto_accept_rules_t;

typedef vx_user_channel_t#

typedef struct vx_user_channel vx_user_channel_t;

typedef vx_user_channel_ref_t#

typedef vx_user_channel_t* vx_user_channel_ref_t;

typedef vx_user_channels_t#

typedef vx_user_channel_ref_t* vx_user_channels_t;

typedef vx_connectivity_test_result_t#

typedef struct vx_connectivity_test_result vx_connectivity_test_result_t;

test_type - Enumeration that defines the test performed (for values, see appendix ?15.8).

error_code - Enumeration that defines the error or success of the test (for values, see appendix ?15.9). test_additional_info - Any additional information for this test. For example, this could be the IP addresses used, port numbers, or error information.

typedef vx_connectivity_test_result_ref_t#

typedef vx_connectivity_test_result_t* vx_connectivity_test_result_ref_t;

typedef vx_connectivity_test_results_t#

typedef vx_connectivity_test_result_ref_t* vx_connectivity_test_results_t;

typedef vx_account_t#

typedef struct vx_account vx_account_t;

typedef vx_device_type_t#

typedef enum vx_device_type vx_device_type_t;

The type of device.

typedef vx_device_t#

typedef struct vx_device vx_device_t;

typedef vx_device_ref_t#

typedef vx_device_t* vx_device_ref_t;

typedef vx_devices_t#

typedef vx_device_ref_t* vx_devices_t;

typedef vx_buddy_t#

typedef struct vx_buddy vx_buddy_t;

typedef vx_buddy_ref_t#

typedef vx_buddy_t* vx_buddy_ref_t;

typedef vx_buddy_list_t#

typedef vx_buddy_ref_t* vx_buddy_list_t;

typedef vx_group_t#

typedef struct vx_group vx_group_t;

typedef vx_group_ref_t#

typedef vx_group_t* vx_group_ref_t;

typedef vx_group_list_t#

typedef vx_group_ref_t* vx_group_list_t;

typedef vx_name_value_pair_t#

typedef struct vx_name_value_pair vx_name_value_pair_t;

typedef vx_name_value_pair_ref_t#

typedef vx_name_value_pair_t* vx_name_value_pair_ref_t;

typedef vx_name_value_pairs_t#

typedef vx_name_value_pair_ref_t* vx_name_value_pairs_t;

typedef vx_conversation_t#

typedef struct vx_conversation vx_conversation_t;

typedef vx_conversation_ref_t#

typedef vx_conversation_t* vx_conversation_ref_t;

typedef vx_conversation_list_t#

typedef vx_conversation_ref_t* vx_conversation_list_t;

typedef vx_stat_sample_t#

typedef struct vx_stat_sample vx_stat_sample_t;

typedef vx_stat_thread_t#

typedef struct vx_stat_thread vx_stat_thread_t;

typedef vx_system_stats_t#

typedef struct vx_system_stats vx_system_stats_t;

typedef vx_application_state_notification_type_t#

typedef enum vx_application_state_notification_type vx_application_state_notification_type_t;

Indicates the state of the application.

Note: Valid only on mobile platforms.

typedef vxa_status_t#

typedef int vxa_status_t;

The common return code for vxa* methods.

typedef vxa_capture_device_stats_t#

typedef struct vxa_capture_device_stats_t vxa_capture_device_stats_t;

Get statistics that are useful for debugging audio capture issues.

typedef vxa_render_device_stats_t#

typedef struct vxa_render_device_stats_t vxa_render_device_stats_t;

Get statistics that are useful for debugging audio render issues.

typedef vx_crash_test_type_t#

typedef enum vx_crash_test_type vx_crash_test_type_t;

Values for vx_crash_test( crash type ).

typedef vx_vxd_t#

typedef struct vx_vxd vx_vxd_t;

The Vivox eXtended Data (VXD) that is received.

typedef vx_tts_manager_id#

typedef unsigned int vx_tts_manager_id;

typedef vx_tts_utterance_id#

typedef unsigned int vx_tts_utterance_id;

typedef vx_tts_voice_id#

typedef unsigned int vx_tts_voice_id;

typedef vx_tts_utterance_impl_t#

typedef struct vx_tts_utterance_impl vx_tts_utterance_impl_t;

typedef vx_tts_utterance_t#

typedef struct vx_tts_utterance vx_tts_utterance_t;

Text-to-speech utterance.

typedef vx_tts_voice_t#

typedef struct vx_tts_voice vx_tts_voice_t;

Text-to-speech voice.

Functions Documentation#

function vx_cookie_create#

VIVOXSDK_DLLEXPORT int vx_cookie_create(
    const char * value,
    VX_COOKIE * cookie
)

Allocate and initialize a cookie.

function vx_cookie_free#

VIVOXSDK_DLLEXPORT int vx_cookie_free(
    VX_COOKIE * cookie
)

Free a cookie.

function vx_state_buddy_contact_create#

VIVOXSDK_DLLEXPORT int vx_state_buddy_contact_create(
    vx_state_buddy_contact_t ** contact
)

function vx_state_buddy_contact_free#

VIVOXSDK_DLLEXPORT int vx_state_buddy_contact_free(
    vx_state_buddy_contact_t * contact
)

function vx_state_buddy_contact_list_create#

VIVOXSDK_DLLEXPORT int vx_state_buddy_contact_list_create(
    int size,
    vx_state_buddy_contact_list_t * list_out
)

function vx_state_buddy_contact_list_free#

VIVOXSDK_DLLEXPORT int vx_state_buddy_contact_list_free(
    vx_state_buddy_contact_t ** list,
    int size
)

function vx_state_buddy_create#

VIVOXSDK_DLLEXPORT int vx_state_buddy_create(
    vx_state_buddy_t ** buddy
)

function vx_state_buddy_free#

VIVOXSDK_DLLEXPORT int vx_state_buddy_free(
    vx_state_buddy_t * buddy
)

function vx_state_buddy_list_create#

VIVOXSDK_DLLEXPORT int vx_state_buddy_list_create(
    int size,
    vx_state_buddy_list_t * list_out
)

function vx_state_buddy_list_free#

VIVOXSDK_DLLEXPORT int vx_state_buddy_list_free(
    vx_state_buddy_t ** list,
    int size
)

function vx_state_buddy_group_create#

VIVOXSDK_DLLEXPORT int vx_state_buddy_group_create(
    vx_state_buddy_group_t ** group
)

function vx_state_buddy_group_free#

VIVOXSDK_DLLEXPORT int vx_state_buddy_group_free(
    vx_state_buddy_group_t * group
)

function vx_state_buddy_group_list_create#

VIVOXSDK_DLLEXPORT int vx_state_buddy_group_list_create(
    int size,
    vx_state_buddy_group_list_t * list_out
)

function vx_state_buddy_group_list_free#

VIVOXSDK_DLLEXPORT int vx_state_buddy_group_list_free(
    vx_state_buddy_group_t ** list,
    int size
)

function vx_participant_create#

VIVOXSDK_DLLEXPORT int vx_participant_create(
    vx_participant_t ** participant
)

function vx_participant_free#

VIVOXSDK_DLLEXPORT int vx_participant_free(
    vx_participant_t * participant
)

function vx_participant_list_create#

VIVOXSDK_DLLEXPORT int vx_participant_list_create(
    int size,
    vx_participant_list_t * list_out
)

function vx_participant_list_free#

VIVOXSDK_DLLEXPORT int vx_participant_list_free(
    vx_participant_t ** list,
    int size
)

function vx_state_participant_create#

VIVOXSDK_DLLEXPORT int vx_state_participant_create(
    vx_state_participant_t ** state_participant
)

function vx_state_participant_free#

VIVOXSDK_DLLEXPORT int vx_state_participant_free(
    vx_state_participant_t * state_participant
)

function vx_state_participant_list_create#

VIVOXSDK_DLLEXPORT int vx_state_participant_list_create(
    int size,
    vx_state_participant_list_t * list_out
)

function vx_state_participant_list_free#

VIVOXSDK_DLLEXPORT int vx_state_participant_list_free(
    vx_state_participant_t ** list,
    int size
)

function vx_state_session_create#

VIVOXSDK_DLLEXPORT int vx_state_session_create(
    vx_state_session_t ** state_session
)

function vx_state_session_free#

VIVOXSDK_DLLEXPORT int vx_state_session_free(
    vx_state_session_t * state_session
)

function vx_state_session_list_create#

VIVOXSDK_DLLEXPORT int vx_state_session_list_create(
    int size,
    vx_state_session_list_t * list_out
)

function vx_state_session_list_free#

VIVOXSDK_DLLEXPORT int vx_state_session_list_free(
    vx_state_session_t ** list,
    int size
)

function vx_state_sessiongroup_create#

VIVOXSDK_DLLEXPORT int vx_state_sessiongroup_create(
    vx_state_sessiongroup_t ** state_sessiongroup
)

function vx_state_sessiongroup_free#

VIVOXSDK_DLLEXPORT int vx_state_sessiongroup_free(
    vx_state_sessiongroup_t * state_sessiongroup
)

function vx_state_sessiongroup_list_create#

VIVOXSDK_DLLEXPORT int vx_state_sessiongroup_list_create(
    int size,
    vx_state_sessiongroup_list_t * list_out
)

function vx_state_sessiongroup_list_free#

VIVOXSDK_DLLEXPORT int vx_state_sessiongroup_list_free(
    vx_state_sessiongroup_t ** list,
    int size
)

function vx_state_account_create#

VIVOXSDK_DLLEXPORT int vx_state_account_create(
    vx_state_account_t ** state_account
)

function vx_state_account_free#

VIVOXSDK_DLLEXPORT int vx_state_account_free(
    vx_state_account_t * state_account
)

function vx_state_account_list_create#

VIVOXSDK_DLLEXPORT int vx_state_account_list_create(
    int size,
    vx_state_account_list_t * list_out
)

function vx_state_account_list_free#

VIVOXSDK_DLLEXPORT int vx_state_account_list_free(
    vx_state_account_t ** list,
    int size
)

function vx_state_connector_create#

VIVOXSDK_DLLEXPORT int vx_state_connector_create(
    vx_state_connector_t ** state_connector
)

function vx_state_connector_free#

VIVOXSDK_DLLEXPORT int vx_state_connector_free(
    vx_state_connector_t * state_connector
)

function vx_state_connector_list_create#

VIVOXSDK_DLLEXPORT int vx_state_connector_list_create(
    int size,
    vx_state_connector_list_t * list_out
)

function vx_state_connector_list_free#

VIVOXSDK_DLLEXPORT int vx_state_connector_list_free(
    vx_state_connector_t ** list,
    int size
)

function vx_channel_create#

VIVOXSDK_DLLEXPORT int vx_channel_create(
    vx_channel_t ** channel
)

function vx_channel_free#

VIVOXSDK_DLLEXPORT int vx_channel_free(
    vx_channel_t * channel
)

function vx_channel_list_create#

VIVOXSDK_DLLEXPORT int vx_channel_list_create(
    int size,
    vx_channel_list_t * list_out
)

function vx_channel_list_free#

VIVOXSDK_DLLEXPORT int vx_channel_list_free(
    vx_channel_t ** list,
    int size
)

function vx_voice_font_create#

VIVOXSDK_DLLEXPORT int vx_voice_font_create(
    vx_voice_font_t ** channel
)

function vx_voice_font_free#

VIVOXSDK_DLLEXPORT int vx_voice_font_free(
    vx_voice_font_t * channel
)

function vx_voice_font_list_create#

VIVOXSDK_DLLEXPORT int vx_voice_font_list_create(
    int size,
    vx_voice_font_list_t * list_out
)

function vx_voice_font_list_free#

VIVOXSDK_DLLEXPORT int vx_voice_font_list_free(
    vx_voice_font_t ** list,
    int size
)

function vx_string_list_create#

VIVOXSDK_DLLEXPORT int vx_string_list_create(
    int size,
    char *** list_out
)

function vx_string_list_free#

VIVOXSDK_DLLEXPORT int vx_string_list_free(
    char ** list
)

function vx_block_rule_create#

VIVOXSDK_DLLEXPORT int vx_block_rule_create(
    vx_block_rule_t ** block_rule
)

function vx_block_rule_free#

VIVOXSDK_DLLEXPORT int vx_block_rule_free(
    vx_block_rule_t * block_rule
)

function vx_block_rules_create#

VIVOXSDK_DLLEXPORT int vx_block_rules_create(
    int size,
    vx_block_rules_t * list_out
)

function vx_block_rules_free#

VIVOXSDK_DLLEXPORT int vx_block_rules_free(
    vx_block_rule_t ** list,
    int size
)

function vx_auto_accept_rule_create#

VIVOXSDK_DLLEXPORT int vx_auto_accept_rule_create(
    vx_auto_accept_rule_t ** auto_accept_rule
)

function vx_auto_accept_rule_free#

VIVOXSDK_DLLEXPORT int vx_auto_accept_rule_free(
    vx_auto_accept_rule_t * auto_accept_rule
)

function vx_auto_accept_rules_create#

VIVOXSDK_DLLEXPORT int vx_auto_accept_rules_create(
    int size,
    vx_auto_accept_rules_t * list_out
)

function vx_auto_accept_rules_free#

VIVOXSDK_DLLEXPORT int vx_auto_accept_rules_free(
    vx_auto_accept_rule_t ** list,
    int size
)

function vx_user_channel_create#

VIVOXSDK_DLLEXPORT int vx_user_channel_create(
    vx_user_channel_t ** user_channel
)

function vx_user_channel_free#

VIVOXSDK_DLLEXPORT int vx_user_channel_free(
    vx_user_channel_t * user_channel
)

function vx_user_channels_create#

VIVOXSDK_DLLEXPORT int vx_user_channels_create(
    int size,
    vx_user_channels_t * list_out
)

function vx_user_channels_free#

VIVOXSDK_DLLEXPORT int vx_user_channels_free(
    vx_user_channel_t ** list,
    int size
)

function vx_connectivity_test_result_create#

VIVOXSDK_DLLEXPORT int vx_connectivity_test_result_create(
    vx_connectivity_test_result_t ** connectivity_test_result,
    ND_TEST_TYPE tt
)

function vx_connectivity_test_result_free#

VIVOXSDK_DLLEXPORT int vx_connectivity_test_result_free(
    vx_connectivity_test_result_t * connectivity_test_result
)

function vx_connectivity_test_results_create#

VIVOXSDK_DLLEXPORT int vx_connectivity_test_results_create(
    int size,
    vx_connectivity_test_results_t * list_out
)

function vx_connectivity_test_results_free#

VIVOXSDK_DLLEXPORT int vx_connectivity_test_results_free(
    vx_connectivity_test_result_t ** list,
    int size
)

function vx_account_create#

VIVOXSDK_DLLEXPORT int vx_account_create(
    vx_account_t ** account
)

function vx_account_free#

VIVOXSDK_DLLEXPORT int vx_account_free(
    vx_account_t * account
)

function vx_device_create#

VIVOXSDK_DLLEXPORT int vx_device_create(
    vx_device_t ** device
)

function vx_device_free#

VIVOXSDK_DLLEXPORT int vx_device_free(
    vx_device_t * device
)

function vx_devices_create#

VIVOXSDK_DLLEXPORT int vx_devices_create(
    int size,
    vx_devices_t * list_out
)

function vx_devices_free#

VIVOXSDK_DLLEXPORT int vx_devices_free(
    vx_device_t ** list,
    int size
)

function vx_buddy_create#

VIVOXSDK_DLLEXPORT int vx_buddy_create(
    vx_buddy_t ** buddy
)

function vx_buddy_free#

VIVOXSDK_DLLEXPORT int vx_buddy_free(
    vx_buddy_t * buddy
)

function vx_buddy_list_create#

VIVOXSDK_DLLEXPORT int vx_buddy_list_create(
    int size,
    vx_buddy_list_t * list_out
)

function vx_buddy_list_free#

VIVOXSDK_DLLEXPORT int vx_buddy_list_free(
    vx_buddy_t ** list,
    int size
)

function vx_group_create#

VIVOXSDK_DLLEXPORT int vx_group_create(
    vx_group_t ** group
)

function vx_group_free#

VIVOXSDK_DLLEXPORT int vx_group_free(
    vx_group_t * group
)

function vx_group_list_create#

VIVOXSDK_DLLEXPORT int vx_group_list_create(
    int size,
    vx_group_list_t * list_out
)

function vx_group_list_free#

VIVOXSDK_DLLEXPORT int vx_group_list_free(
    vx_group_t ** list,
    int size
)

function vx_name_value_pair_create#

VIVOXSDK_DLLEXPORT int vx_name_value_pair_create(
    vx_name_value_pair_t ** nvpair
)

function vx_name_value_pair_free#

VIVOXSDK_DLLEXPORT int vx_name_value_pair_free(
    vx_name_value_pair_t * nvpair
)

function vx_name_value_pairs_create#

VIVOXSDK_DLLEXPORT int vx_name_value_pairs_create(
    int size,
    vx_name_value_pairs_t * list_out
)

function vx_name_value_pairs_free#

VIVOXSDK_DLLEXPORT int vx_name_value_pairs_free(
    vx_name_value_pair_t ** list,
    int size
)

function vx_conversation_create#

VIVOXSDK_DLLEXPORT int vx_conversation_create(
    vx_conversation_t ** conversation
)

function vx_conversation_free#

VIVOXSDK_DLLEXPORT int vx_conversation_free(
    vx_conversation_t * conversation
)

function vx_conversation_list_create#

VIVOXSDK_DLLEXPORT int vx_conversation_list_create(
    int size,
    vx_conversation_list_t * list_out
)

function vx_conversation_list_free#

VIVOXSDK_DLLEXPORT int vx_conversation_list_free(
    int size,
    vx_conversation_t ** list
)

function vx_strdup#

VIVOXSDK_DLLEXPORT char * vx_strdup(
    const char * 
)

Allocate string data to send to the SDK.

Note: This function will not work until vx_initialize3() is called and after vx_uninitialize() is called.

function vx_free#

VIVOXSDK_DLLEXPORT int vx_free(
    char * 
)

Free string data returned to the application.

Note: This function will not work until vx_initialize3() is called and after vx_uninitialize() is called.

This function is rarely used in practice.

function vx_unallocate#

VIVOXSDK_DLLEXPORT int vx_unallocate(
    void * p
)

function vx_allocate#

VIVOXSDK_DLLEXPORT void * vx_allocate(
    size_t nBytes
)

function vx_reallocate#

VIVOXSDK_DLLEXPORT void * vx_reallocate(
    void * p,
    size_t nBytes
)

function vx_calloc#

VIVOXSDK_DLLEXPORT void * vx_calloc(
    size_t num,
    size_t bytesPerElement
)

function vx_allocate_aligned#

VIVOXSDK_DLLEXPORT void * vx_allocate_aligned(
    size_t alignment,
    size_t size
)

function vx_unallocate_aligned#

VIVOXSDK_DLLEXPORT int vx_unallocate_aligned(
    void * p
)

function vx_get_message#

VIVOXSDK_DLLEXPORT int vx_get_message(
    vx_message_base_t ** message
)

The VxSDK polling function.

Parameters:

• message [out] The object containing the message data.

Return: The status of the poll: VX_GET_MESSAGE_AVAILABLE = Success, VX_GET_MESSAGE_FAILURE = Failure, VX_GET_MESSAGE_NO_MESSAGE = No Message Available

This should be called periodically to check for any incoming events.

function vx_issue_request#

VIVOXSDK_DLLEXPORT int vx_issue_request(
    vx_req_base_t * request
)

Parameters:

• request The request object to execute. This is of one of the vx_req_* structs.

Return: The success status of the request.

function vx_issue_request2#

VIVOXSDK_DLLEXPORT int vx_issue_request2(
    vx_req_base_t * request
)

Execute the given request.

Parameters:

• request The request object to execute. This is of one of the vx_req_* structs.

Return: The success status of the request.

This function returns an error if the SDK is not initialized (see vx_initialize3()).

function vx_issue_request3#

VIVOXSDK_DLLEXPORT int vx_issue_request3(
    vx_req_base_t * request,
    int * request_count
)

Execute the given request.

Parameters:

• request The request object to execute. This is of one of the vx_req_* structs.
• request_count If non-null, vx_issue_request3 outputs the number of requests that are still outstanding. Requests at a rate of 12 requests per second - an application can use this value to determine if the application is issuing requests at an unacceptable rate.

Return: The success status of the request.

This function returns an error if the SDK is not initialized (see vx_initialize3()).

function vx_request_to_xml#

VIVOXSDK_DLLEXPORT int vx_request_to_xml(
    void * request,
    char ** xml
)

Get the XML for the given request.

Parameters:

• request The request object.
• xml [out] The XML string.

function vx_xml_to_request#

VIVOXSDK_DLLEXPORT vx_request_type vx_xml_to_request(
    const char * xml,
    void ** request,
    char ** error
)

Get a request for the given XML string.

Parameters:

• xml The XML string.
• request [out] The request struct.
• error [out] The XML parse error string (if any error occurs). NULL otherwise.

Return: The request struct type. If no struct could be created from the XML, req_none is returned.

function vx_response_to_xml#

VIVOXSDK_DLLEXPORT int vx_response_to_xml(
    void * response,
    char ** xml
)

Get the XML for the given response.

Parameters:

• response The response object.
• xml [out] The XML string.

function vx_xml_to_response#

VIVOXSDK_DLLEXPORT vx_response_type vx_xml_to_response(
    const char * xml,
    void ** response,
    char ** error
)

Get a response for the given XML string.

Parameters:

• xml The XML string.
• response [out] The response struct.
• error [out] The XML parse error string (if any error occurs). NULL otherwise.

Return: The response struct type. If no struct could be created from the XML, resp_none is returned.

function vx_event_to_xml#

VIVOXSDK_DLLEXPORT int vx_event_to_xml(
    void * event,
    char ** xml
)

Get the XML for the given event.

Parameters:

• event The event object.
• xml [out] The XML string.

function vx_xml_to_event#

VIVOXSDK_DLLEXPORT vx_event_type vx_xml_to_event(
    const char * xml,
    void ** event,
    char ** error
)

Get a event for the given XML string.

Parameters:

• xml The XML string.
• event [out] The event struct.
• error [out] The XML parse error string (if any error occurs). NULL otherwise.

Return: The event struct type. If no struct could be created from the XML, req_none is returned.

function vx_get_message_type#

VIVOXSDK_DLLEXPORT vx_message_type vx_get_message_type(
    const char * xml
)

Determine whether the XML refers to a request, response, or event.

function vx_get_time_ms#

VIVOXSDK_DLLEXPORT unsigned long long vx_get_time_ms(
    void 
)

Get Millisecond Counter.

function vx_get_time_milli_seconds#

VIVOXSDK_DLLEXPORT unsigned long long vx_get_time_milli_seconds(
    void 
)

Get Millisecond Counter.

function vx_get_time_micro_seconds#

VIVOXSDK_DLLEXPORT unsigned long long vx_get_time_micro_seconds(
    void 
)

Get Microsecond Counter.

function vx_sleep_milli_seconds#

VIVOXSDK_DLLEXPORT long long vx_sleep_milli_seconds(
    unsigned long long milli_seconds
)

Sleep for the specified number of milliseconds.

Parameters:

• milli_seconds [in] Duration to sleep in milliseconds.

Return: The difference between the actual and the specified sleep time in milliseconds.

function vx_register_message_notification_handler#

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

Register a callback that is called when a message is placed in the queue.

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

function vx_unregister_message_notification_handler#

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

Unregister a notification handler.

function vx_wait_for_message#

VIVOXSDK_DLLEXPORT vx_message_base_t * vx_wait_for_message(
    int msTimeout
)

Block the caller until a message is available.

Returns NULL if no message was available within the allotted time.

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_create_account#

VIVOXSDK_DLLEXPORT int vx_create_account(
    const char * acct_mgmt_server,
    const char * admin_name,
    const char * admin_pw,
    const char * uname,
    const char * pw
)

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_on_application_exit#

VIVOXSDK_DLLEXPORT int vx_on_application_exit(
    void 
)

Some applications may need to call this routine before exiting.

Note: Applications must call vx_uninitialize() before calling this routine.

Attention: PC, console, and mobile applications are not required to call this routine because it has no effect for applications on these 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_apply_font_to_file#

VIVOXSDK_DLLEXPORT int vx_apply_font_to_file(
    const char * fontDefinition,
    const char * inputFile,
    const char * outputFile
)

Apply a Vivox voice font to a .wav file.

Parameters:

• fontDefinition - A string that contains the font "definition" in XML format.
• inputFile - A string that contains the path to the input .wav file, which contains the "unmodified" voice.
• outputFile - A string that contains the path to the output .wav file with the font applied.

Return: - 0 if successful, non-zero if failed.

function vx_apply_font_to_file_return_energy_ratio#

VIVOXSDK_DLLEXPORT int vx_apply_font_to_file_return_energy_ratio(
    const char * fontDefinition,
    const char * inputFile,
    const char * outputFile,
    double * energyRatio
)

Apply a Vivox voice font to a .wav file and return the energy ratio (Output Energy/Input Energy).

Parameters:

• fontDefinition - A string that contains the font "definition" in XML format.
• inputFile - A string that contains the path to the input .wav file, which contains the "unmodified" voice.
• outputFile - A string that contains the path to the output .wav file with the font applied.
• energyRatio - The Raw Energy ratio between the input and output audio.

Return: - 0 if successful, non-zero if failed.

function vx_apply_font_to_vxz_file_return_energy_ratio#

VIVOXSDK_DLLEXPORT int vx_apply_font_to_vxz_file_return_energy_ratio(
    const char * fontDefinition,
    const char * inputFile,
    const char * outputFile,
    double * energyRatio
)

Apply a Vivox voice font to a .vxz file and return the energy ratio (Output Energy/Input Energy)

Parameters:

• fontDefinition - A string that contains the font "definition" in XML format.
• inputFile - A string that contains the path to the input .vxz file, which contans the "unmodified" voice.
• outputFile - A string that contains the path to the output .wav file with the font applied.
• energyRatio - The Raw Energy ratio between the input and output audio.

Return: - 0 if successful, non-zero if failed.

function vx_copy_audioBuffer#

VIVOXSDK_DLLEXPORT void * vx_copy_audioBuffer(
    void * audioBufferPtr
)

Create a copy of the internal local audio buffer associated with the vx_req_aux_start_buffer_capture_t request/response.

Parameters:

• audioBufferPtr - A void pointer that should be passed in uninitialized.

See: vx_req_aux_start_buffer_capture

Return: - No return value is provided. On success, the audioBufferPtr will point to a copy of the internal audio buffer. Otherwise, audioBufferPtr is set to NULL.

function vx_get_audioBuffer_duration#

VIVOXSDK_DLLEXPORT double vx_get_audioBuffer_duration(
    void * audioBufferPtr
)

Get the duration of the audio buffer in seconds.

Parameters:

• audioBufferPtr - A void pointer that should be passed in uninitialized.

See: vx_req_aux_start_buffer_capture

Return: - The duration of the audio buffer in seconds.

function vx_get_audioBuffer_sample_rate#

VIVOXSDK_DLLEXPORT int vx_get_audioBuffer_sample_rate(
    void * audioBufferPtr
)

Get the sample rate of the audio buffer.

Parameters:

• audioBufferPtr - A pointer to audio data in a Vivox proprietary format.

See: vx_req_aux_start_buffer_capture

Return: - The sample rate of the buffer's data. 0 if the buffer does not exist.

function vx_free_audioBuffer#

VIVOXSDK_DLLEXPORT int vx_free_audioBuffer(
    void ** audioBufferPtr
)

Free up all memory associated with an allocated Vivox audioBufferPtr.

Parameters:

• audioBufferPtr - A pointer to audio data in a Vivox proprietary format.

Generated by the vx_copy_audioBuffer() call.

function vx_export_audioBuffer_to_pcm#

VIVOXSDK_DLLEXPORT int vx_export_audioBuffer_to_pcm(
    void * audioBufferPtr,
    short * pcmBuffer,
    int maxSamples
)

Export audio data in an audioBufferPtr to a memory buffer as PCM.

Parameters:

• audioBufferPtr - A pointer to audio data in a Vivox proprietary format.
• pcmBuffer - A pointer to the pre-allocated memory buffer.
• maxSamples - The length of the buffer in samples.

Return: - The number of samples copied to the buffer. -1 if failed.

function vx_export_audioBuffer_to_wav_file#

VIVOXSDK_DLLEXPORT int vx_export_audioBuffer_to_wav_file(
    void * audioBufferPtr,
    const char * outputFile
)

Export audio data in an audioBufferPtr to a .wav file.

Parameters:

• audioBufferPtr - A pointer to audio data in a Vivox proprietary format.
• outputFile - A string that contains the path to the output .wav file.

Return: - 0 if successful, non-zero if failed.

function vx_export_audioBuffer_to_memory#

VIVOXSDK_DLLEXPORT int vx_export_audioBuffer_to_memory(
    void * audioBufferPtr,
    short ** audioBufferOut,
    int * nSamplesOut,
    int * sampleRateOut,
    int * nChannelsOut
)

Export audio data in an audioBufferPtr to memory.

Parameters:

• audioBufferPtr - A pointer to audio data in a Vivox proprietary format.
• audioBufferOut - An interleaved (if stereo) audio buffer of PCM-encoded audio. Note that this must be freed with vx_free().
• nSamplesOut - The number of samples.
• sampleRateOut - The sample rate of the audio buffer.
• nChannelsOut - The number of channels in the buffer.

Return: - 0 if successful, non-zero if failed.

function vx_set_out_of_process_server_address#

VIVOXSDK_DLLEXPORT int vx_set_out_of_process_server_address(
    const char * address,
    unsigned short port
)

Set the default out of process server address.

Parameters:

• address - The address of the out of process server. Use "127.0.0.1" for most applications.
• port - port - Use 44125 for most applications.

Return: - 0 if successful, non-zero if failed.

When an address is set, requests issued by using vx_issue_request are sent to the server at the supplied address instead of being handled in the current process context.

function vx_initialize#

VIVOXSDK_DLLEXPORT int vx_initialize(
    void 
)

Return: - 0 if successful, non-zero if failed.

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.

function vx_debug_call#

VIVOXSDK_DLLEXPORT int vx_debug_call(
    void * 
)

function vx_get_system_stats#

VIVOXSDK_DLLEXPORT int vx_get_system_stats(
    vx_system_stats_t * system_stats
)

Get statistics about various system internals.

Return: - 0 if successful, non-zero if failed.

function vx_get_int_var#

VIVOXSDK_DLLEXPORT int vx_get_int_var(
    const char * var_name,
    int * p_value
)

Get named variables.

Parameters:

• var_name - The name of the variable.
• p_value - Where to store the value of the variable.

Return: - 0 if successful, non-zero if failed.

function vx_set_int_var#

VIVOXSDK_DLLEXPORT int vx_set_int_var(
    const char * var_name,
    int value
)

Set named variables.

Parameters:

• var_name - The name of the variable.
• - The integer value to set.

Return: - 0 if successful, non-zero if failed.

function vx_destroy_message#

VIVOXSDK_DLLEXPORT int vx_destroy_message(
    vx_message_base_t * message
)

Deallocate any message of any type.

function vx_debug_generate_token#

VIVOXSDK_DLLEXPORT char * vx_debug_generate_token(
    const char * issuer,
    vx_time_t expiration,
    const char * vxa,
    unsigned long long serial,
    const char * subject,
    const char * from_uri,
    const char * to_uri,
    const unsigned char * key,
    size_t key_len
)

Generate a Vivox Access Token.

Parameters:

• issuer - A standard issuer claim.
• expiration - A standard expiration time claim. If set to (vx_time_t)-1, uses the default time of now(0)+300.
• vxa - A Vivox action, for example, "login", "join", "kick", or "mute".
• serial number - Use this to guarantee uniqueness within an epoch second.
• subject - Optional: The URI of the target of the actions "kick" and "mute". NULL otherwise.
• from_uri - A SIP From URI.
• to_uri - A SIP To URI.
• key - A token-signing key
• key_len - The length of the token-signing key.

Return: null-terminated - A buffer to be freed with vx_free(). If NULL is returned, an error occurred.

!!! This function should only be called when prototyping or debugging token generation server implementations. !!! It should not be in production code, because that would require the issuer/key pair to be resident client memory, which would create a security exposure.

function vx_get_http#

VIVOXSDK_DLLEXPORT unsigned int vx_get_http(
    const char * url,
    unsigned int * response_code,
    char ** content,
    size_t * content_len,
    char ** content_type,
    size_t * content_type_len
)

Synchronously download the contents of the specified URL with the GET method.

Parameters:

• url - [in] The URL of the resource to download.
• response_code - [out] A pointer to the returned response code (0 on error, >= 200 after the request finished).
• content - [out] A pointer to the downloaded content is stored here, and is guaranteed to be NULL-terminated. The memory is allocated automatically. Use vx_free_http() to free up the allocated buffers.
• content_len - [out] A pointer to the returned content length.
• content_type - [out] A pointer to the downloaded content type is stored here, and is guaranteed to be NULL-terminated. The memory is allocated automatically. Use vx_free_http() to free up the allocated buffers.
• content_type_len - [out] A pointer to the returned content type length.

Return: - 0 if successful, non-zero if failed.

function vx_free_http#

VIVOXSDK_DLLEXPORT int vx_free_http(
    char ** content,
    char ** content_type
)

Free the memory allocated during the vx_get_http() call.

Parameters:

• content - [in] The same value as what is passed to vx_get_http().
• content_type - [in] The same value as what is passed to vx_get_http().

Note: Call this function only if vx_get_http() returned zero.

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_get_user_uri#

VIVOXSDK_DLLEXPORT char * vx_get_user_uri(
    const char * name,
    const char * realm,
    const char * issuer
)

Generate the fully specified URI of a user with the given name for the given realm and issuer.

Parameters:

• name - [in] The unique account name that you assigned to the user.
• realm - [in] The realm for that user (for example, mt1s.vivox.com).
• issuer - [in, optional] The issuer. If NULL or an empty string is passed, the generated user URI is the same as what is generated with no argument.

Note: This must be deallocated with vx_free();

function vx_get_echo_channel_uri#

VIVOXSDK_DLLEXPORT char * vx_get_echo_channel_uri(
    const char * name,
    const char * realm,
    const char * issuer
)

Generate the fully specified URI of an echo channel with the given name for the given realm and issuer.

Parameters:

• name - [in] The name you assigned to 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 user URI is the same as what is generated with no argument.

Note: This must be deallocated with vx_free();

function vx_get_general_channel_uri#

VIVOXSDK_DLLEXPORT char * vx_get_general_channel_uri(
    const char * name,
    const char * realm,
    const char * issuer
)

Generate the fully specified URI of a general non-positional channel with the given name for the given realm and issuer.

Parameters:

• name - [in] The name you assigned to 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 user URI is the same as what is generated with no argument.

Note: This must be deallocated with vx_free();

function vx_get_positional_channel_uri#

VIVOXSDK_DLLEXPORT char * vx_get_positional_channel_uri(
    const char * name,
    const char * realm,
    int max_range,
    int clamping_distance,
    double rolloff,
    vx_channel_rolloff_curve_type distance_model,
    const char * issuer
)

Generate the fully specified URI of a positional channel with the given name and 3D properties for the given realm and issuer.

Parameters:

• name - [in] The name you assigned to the channel.
• realm - [in] The realm for that channel (for example, mt1s.vivox.com).
• max_range - [in] The maximum distance from the listener at which a speaker can be heard. This must be an integer > 0.
• clamping_distance - [in] The distance from the listener at which a speaker’s voice is heard at its original volume. This must be an integer in the range 0 <= clamping_distance <= max_range.
• rolloff - [in] The strength of the volume attenuation as the speaker moves away from the listener. This must be a floating point value >= 0 that is rounded to three decimal places.
• distance_model - [in] The curve that determines volume attenuation at distances between the clamping_distance and max_range, scaled by the rolloff.
• issuer - [in, optional] The issuer. If NULL or an empty string is passed, the generated user URI is the same as what is generated with no argument.

Note: This must be deallocated with vx_free(); URIs with different 3D properties are considered different channels.

function vx_uri_to_string#

VIVOXSDK_DLLEXPORT char * vx_uri_to_string(
    int is_multitenant,
    const char * uri
)

Return a textual representation of the compositional elements of a Vivox URI, suitable for logging.

Parameters:

• is_multitenant - [in] 1 if the URI includes a token issuer, or 0 otherwise.
• uri - [in] A fully specified URI representing a Vivox user or channel.

Note: This must be deallocated with vx_free(); The string contains line breaks.

For instance, whether it is a user or channel URI, the name, realm, and other properties are listed.

function vx_opus_set_bit_rate#

VIVOXSDK_DLLEXPORT int vx_opus_set_bit_rate(
    int bits_per_second
)

Set the bitrate for all OPUS encoders.

Parameters:

• bits_per_second - [in] The requested bitrate, 6000-128000 bit/s.

Return: - 0 if successful, non-zero if failed.

function vx_opus_get_bit_rate#

VIVOXSDK_DLLEXPORT int vx_opus_get_bit_rate(
    int * p_bits_per_second
)

Get the current OPUS bitrate.

Parameters:

• p_bits_per_second - [out] A pointer to the returned value.

Return: - 0 if successful, non-zero if failed.

function vx_opus_set_complexity#

VIVOXSDK_DLLEXPORT int vx_opus_set_complexity(
    int complexity
)

Set the complexity for all OPUS encoders.

Parameters:

• complexity - [in] The requested complexity, 0-10.

Return: - 0 if successful, non-zero if failed.

function vx_opus_get_complexity#

VIVOXSDK_DLLEXPORT int vx_opus_get_complexity(
    int * p_complexity
)

Get the current OPUS complexity.

Parameters:

• p_complexity - [out] A pointer to the returned value.

Return: - 0 if successful, non-zero if failed.

function vx_opus_set_vbr_mode#

VIVOXSDK_DLLEXPORT int vx_opus_set_vbr_mode(
    int vbr_mode
)

Set the VBR mode for all OPUS encoders.

Parameters:

• vbr_mode - [in] The requested mode (vx_opus_vbr_mode).

Return: - 0 if successful, non-zero if failed.

function vx_opus_get_vbr_mode#

VIVOXSDK_DLLEXPORT int vx_opus_get_vbr_mode(
    int * p_vbr_mode
)

Get the current OPUS VBR mode.

Parameters:

• p_vbr_mode - [out] A pointer to the returned value (vx_opus_vbr_mode).

Return: - 0 if successful, non-zero if failed.

function vx_opus_set_bandwidth#

VIVOXSDK_DLLEXPORT int vx_opus_set_bandwidth(
    int bandwidth
)

Set the bandwidth for all OPUS encoders.

Parameters:

• bandwidth - [in] The requested bandwidth (vx_opus_bandwidth).

Return: - 0 if successful, non-zero if failed.

function vx_opus_get_bandwidth#

VIVOXSDK_DLLEXPORT int vx_opus_get_bandwidth(
    int * p_bandwidth
)

Get the current OPUS bandwidth.

Parameters:

• p_bandwidth - [out] A pointer to the returned value (vx_opus_bandwidth).

Return: - 0 if successful, non-zero if failed.

function vx_get_available_codecs_mask#

VIVOXSDK_DLLEXPORT unsigned int vx_get_available_codecs_mask(
    void 
)

Get a mask for all available codecs (to be used as configured_codecs).

function vx_get_default_codecs_mask#

VIVOXSDK_DLLEXPORT unsigned int vx_get_default_codecs_mask(
    void 
)

Get a recommended default mask for available codecs (to be used as configured_codecs).

function vx_get_dump_memory_interval#

VIVOXSDK_DLLEXPORT int vx_get_dump_memory_interval(
    void 
)

Get the current period of the Memory Usage information dumping to logcat.

Return: - The sampling interval in seconds. 0 if memory dump is turned off.

Note: Android platform only. Does nothing on other platforms.

function vx_cpumonitor_start#

VIVOXSDK_DLLEXPORT int vx_cpumonitor_start(
    int interval,
    int report_interval
)

Start the CPU load information dumping to logcat.

Parameters:

• interval - [in] The sampling interval in milliseconds. The recommended value is 1000 milliseconds. It is not recommended to have this value under 100 milliseconds.
• report_interval - [in] The reporting interval in milliseconds. The SDK will dump the collected data to logcat once per reporting interval. The recommended value is 5000 milliseconds. It is not recommended to have this value under 1000 milliseconds.

Note: Android platform only. Does nothing on other platforms.

Larger report_interval reduces the average amount of information output by the SDK to logcat. Smaller sampling intervals allow for better detection of short peak loads.

function vx_cpumonitor_stop#

VIVOXSDK_DLLEXPORT int vx_cpumonitor_stop(
    void 
)

Stop the CPU load information dumping to logcat.

Note: Android platform only. Does nothing on other platforms.

function vx_cpumonitor_start_eater#

VIVOXSDK_DLLEXPORT int vx_cpumonitor_start_eater(
    int nthreads,
    int priority
)

Start the requested number of tight loop threads with the requested priority.

Parameters:

• nthreads - [in] The number of threads with tight loops to start. Passing 0 starts the number of threads matching the number of available device processor cores.
• priority - [in] The scheduling priority to be used for each created thread. 0 leaves the default priority. Valid non-zero values are from -20 (the maximum priority - this is dangerous and should not be used) to 20 (the minimum possible priority). It is recommended that you use value 0 for priority.

Note: Android platform only. Does nothing on other platforms.

Attention: After working for some time at the maximum possible speed, the CPU will heat up, and the system will throttle it to prevent overheating.

Android devices can scale the CPU frequency down or stop some cores when the load is low. This decreases the device performance and affects the CPU load measurements provided by vx_cpumonitor_start() - the reported load will be higher. To prevent this, the vx_cpumonitor_start_eater() is provided. If low priority threads with tight loops will be started for each available CPU core, then the system sets each core frequency to its maximum value, and the measurement results reflect the CPU load relative to the device's maximum possible performance.

function vx_cpumonitor_stop_eater#

VIVOXSDK_DLLEXPORT int vx_cpumonitor_stop_eater(
    void 
)

Stop all the CPU eater threads started with vx_cpumonitor_start_eater() call.

Note: Android platform only. Does nothing on other platforms.

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_is_access_token_well_formed#

VIVOXSDK_DLLEXPORT int vx_is_access_token_well_formed(
    const char * access_token,
    char ** error
)

Verify whether the passed access token is well-formed.

Parameters:

• access_token - [in] An access token to check.
• error - [out] An optional pointer to the returned verbose error description. Can be NULL. The returned string must be disposed of with vx_free() call.

Return: - Non-zero if access token looks well-formed, 0 otherwise.

function vx_vxd_send#

VIVOXSDK_DLLEXPORT int vx_vxd_send(
    VX_HANDLE session_handle,
    const char * data,
    size_t size
)

Send VXD into the channel.

Parameters:

• session_handle - [in] The session handle to send VXD to.
• data - [in] The data to be sent.
• size - [in] The data size in bytes.

Return: - 0 if successful, non-zero if failed (SDK not initialized, invalid argument (session, ptr), size too big).

function vx_vxd_recv#

VIVOXSDK_DLLEXPORT int vx_vxd_recv(
    VX_HANDLE session_handle,
    vx_vxd_t ** vxd_ptr
)

Receive VXD from the channel.

Parameters:

• session_handle - [in] The session handle to receive VXD from.
• vxd_ptr - [out] On success, will contain a pointer to the received VXD. Untouched on failure. The caller is responsible for disposing of it with vx_vxd_destroy().

Return: - 0 if successful, non-zero if failed (SDK not initialized, invalid argument (session, ptr), no more data).

function vx_vxd_destroy#

VIVOXSDK_DLLEXPORT int vx_vxd_destroy(
    vx_vxd_t * vxd
)

Dispose of the VXD object returned by vx_vxd_recv().

Parameters:

• vxd - [in] VXD to dispose

Return: - 0 if successful, non-zero if failed (SDK not initialized).

function vx_get_path#

VIVOXSDK_DLLEXPORT char * vx_get_path(
    unsigned int path_id
)

Get a specific path of various files and folders used by the SDK.

Parameters:

• - The path ID.

Return: - A null-terminated buffer to be freed with vx_free(). If NULL is returned, an error occurred.

function vx_get_dynamic_voice_processing_switching_enabled#

VIVOXSDK_DLLEXPORT int vx_get_dynamic_voice_processing_switching_enabled(
    int * enabled
)

Get the current value of the dynamic voice processing switching enabled setting.

Parameters:

• enabled - [out] A pointer to the returned value (0 if disabled, 1 if enabled).

Return: - 0 if successful, non-zero if failed.

function vx_set_dynamic_voice_processing_switching_enabled#

VIVOXSDK_DLLEXPORT int vx_set_dynamic_voice_processing_switching_enabled(
    int enabled
)

Enable and disable dynamic voice processing switching.

Parameters:

• enabled - 1 to enable dynamic voice processing switching, and 0 to disable.

Return: - 0 if successful, non-zero if failed (SDK not initialized).

function vx_get_ios_voice_processing_io_mode#

VIVOXSDK_DLLEXPORT int vx_get_ios_voice_processing_io_mode(
    int * mode
)

Get the mode for the ios_voice_processing_io_mode configuration field.

Parameters:

• enabled - [out] A pointer to the returned value (2 to always use VPIO, 1 to use VPIO only for speakerphone, 0 to never use the VPIO).

Return: - 0 if successful, non-zero if failed.

function vx_set_ios_voice_processing_io_mode#

VIVOXSDK_DLLEXPORT int vx_set_ios_voice_processing_io_mode(
    int mode
)

Set the mode for the ios_voice_processing_io_mode configuration field.

Parameters:

• enabled - 2 to always use VPIO, 1 to use VPIO only for speakerphone, 0 to never use the VPIO

Return: - 0 if successful, non-zero if failed.

function vx_get_platform_aec_enabled#

VIVOXSDK_DLLEXPORT int vx_get_platform_aec_enabled(
    int * enabled
)

Return an indication of whether platform-provided AEC is being used.

Parameters:

• enabled - [out] A pointer to the returned value (0 if disabled, 1 if enabled).

Return: - 0 if successful, non-zero if failed.

function vx_set_platform_aec_enabled#

VIVOXSDK_DLLEXPORT int vx_set_platform_aec_enabled(
    int enabled
)

Enable and disable platform-provided AEC.

Parameters:

• enabled - 1 to enable platform-provided AEC, or 0 to disable.

Return: - 0 if successful, non-zero if failed (SDK not initialized).

Note: iOS only: This is an alias of vx_set_ios_voice_processing_io_mode(0|1). 0 when disabling, 1 when enabling.

function vx_get_vivox_aec_enabled#

VIVOXSDK_DLLEXPORT int vx_get_vivox_aec_enabled(
    int * enabled
)