sdk/VxcRequests.h

Reference the Vivox Core SDK API.

Read time 73 minutes

Last updated a day ago

Classes

	Name
struct	vx_req_connector_create Connect the application to the Vivox service.
struct	vx_req_connector_initiate_shutdown Call this when the application is shutting down to gracefully release resources.
struct	vx_req_account_login
struct	vx_req_account_authtoken_login
struct	vx_req_account_anonymous_login Log in anonymously to the Vivox network.
struct	vx_req_account_logout Log a user out of the Vivox system.
struct	vx_req_account_set_login_properties Set some of the properties passed in on the login command.
struct	vx_req_sessiongroup_create
struct	vx_req_sessiongroup_terminate
struct	vx_req_sessiongroup_add_session Sessions represent a connection to a media session with one or more participants.
struct	vx_req_sessiongroup_remove_session End an established session (hang-up or disconnect).
struct	vx_req_sessiongroup_set_focus Set the audio focus of a session when there are multiple sessions in a session group.
struct	vx_req_sessiongroup_unset_focus Unset the focus of a specific channel that previously was set to have focus.
struct	vx_req_sessiongroup_reset_focus Reset all sessions in a group so they have equal priority or focus.
struct	vx_req_sessiongroup_set_tx_session Set the session within the session group to which to user's voice is transmitted.
struct	vx_req_sessiongroup_set_tx_all_sessions Transmit the user's voice to all sessions within the specified session group.
struct	vx_req_sessiongroup_set_tx_no_session Disables transmission to all sessions within a session group.
struct	vx_req_sessiongroup_set_session_3d_position Set the position of any entire channel so all audio from that channel sounds like it comes from that position.
struct	vx_req_sessiongroup_control_audio_injection Start or stop session group audio injection.
struct	vx_req_session_create
struct	vx_req_session_media_connect Connect media (audio) in a session.
struct	vx_req_session_media_disconnect
struct	vx_req_session_text_connect Add text to a session.
struct	vx_req_session_text_disconnect Disconnect text in a session.
struct	vx_req_session_terminate End an established session (hang-up or disconnect).
struct	vx_req_session_mute_local_speaker Mute or unmute the audio render or the incoming text messages of the logged in user for the specified session.
struct	vx_req_session_set_local_render_volume Set the audio render volume for the specified session.
struct	vx_req_session_set_local_speaker_volume
struct	vx_req_session_channel_invite_user This command sends an invitation to a specified user to join the channel that corresponds to the provided session handle.
struct	vx_req_session_set_participant_volume_for_me Set the volume for a participant in the current session.
struct	vx_req_session_set_participant_mute_for_me Mute a participant in the current session.
struct	vx_req_session_set_3d_position Set and get the 3D position of the speaker and listener.
struct	vx_req_session_set_voice_font Apply a voice font to an already established voice session.
struct	vx_req_account_channel_change_owner
struct	vx_req_account_send_user_app_data Send specified data directly to a user.
struct	vx_req_account_channel_add_acl
struct	vx_req_account_channel_remove_acl
struct	vx_req_account_channel_get_acl
struct	vx_req_channel_mute_user Mute or unmute a participant in a specific channel.
struct	vx_req_channel_ban_user
struct	vx_req_channel_get_banned_users
struct	vx_req_channel_kick_user Kick a user out of a channel and automatically allow the user back in after 60 seconds.
struct	vx_req_channel_mute_all_users Mute or unmute all current users in a channel.
struct	vx_req_channel_set_lock_mode
struct	vx_req_connector_mute_local_mic Mute or unmute the microphone.
struct	vx_req_connector_mute_local_speaker Mute or unmute the speaker (the render device of incoming audio).
struct	vx_req_connector_set_local_mic_volume
struct	vx_req_connector_set_local_speaker_volume
struct	vx_req_connector_get_local_audio_info Retrieve the current volume and mute status of the local render and capture devices.
struct	vx_req_account_buddy_set Add a buddy to a buddy list or update the properties of a buddy.
struct	vx_req_account_buddy_delete Delete a buddy from a user's buddy list.
struct	vx_req_account_list_buddies_and_groups Retrieve a list of all buddies and buddy groups for a given account.
struct	vx_req_session_send_message Send a message to all participants in the session.
struct	vx_req_session_delete_message Delete a message for all participants in the session.
struct	vx_req_session_edit_message Edit a message for all participants in the session.
struct	vx_req_session_archive_query Query messages that were archived by the server for the specified channel.
struct	vx_req_session_chat_history_query Query messages that were archived by the server for the specified channel.
struct	vx_req_account_chat_history_get_last_read Get the last read message from a specified channel.
struct	vx_req_account_set_presence Set the presence (online/offline status) of an account.
struct	vx_req_account_send_subscription_reply Respond to an incoming subscription event.
struct	vx_req_session_send_notification Send a notification about the properties of the current session (for example, whether a user is typing).
struct	vx_req_session_send_dtmf
struct	vx_req_account_create_block_rule Define rules to block individuals or groups of individuals.
struct	vx_req_account_delete_block_rule Delete a block rule.
struct	vx_req_account_list_block_rules Retrieve a list of block rules for a given account.
struct	vx_req_account_create_auto_accept_rule Set up rules to automatically accept individuals or groups of individuals when they request presence subscriptions.
struct	vx_req_account_delete_auto_accept_rule Delete an auto accept rule.
struct	vx_req_account_list_auto_accept_rules Retrieve a list of auto accept rules for a given account.
struct	vx_req_account_update_account
struct	vx_req_account_get_account
struct	vx_req_account_send_sms
struct	vx_req_aux_connectivity_info Perform a network test.
struct	vx_req_aux_get_render_devices Retrieve a list of audio render devices for the current computer.
struct	vx_req_aux_get_capture_devices Return a list of available audio capture devices.
struct	vx_req_aux_set_render_device Instruct the Vivox SDK sound system to set the render device to a specific value.
struct	vx_req_aux_set_capture_device Instruct the Vivox SDK sound system to set the capture device to a specific value.
struct	vx_req_aux_get_mic_level This method returns the master microphone (capture) level of the Vivox SDK sound system.
struct	vx_req_aux_get_speaker_level This method returns the master speaker (render) level of the Vivox SDK sound system.
struct	vx_req_aux_set_mic_level Set the master microphone level of the Vivox SDK sound system.
struct	vx_req_aux_set_speaker_level Set the master speaker level of the Vivox SDK sound system.
struct	vx_req_aux_render_audio_start Ensure that a specific selected render device is functioning properly.
struct	vx_req_aux_render_audio_modify Modify the applied font of the aux audio buffer that is rendering.
struct	vx_req_aux_get_vad_properties Get the connector VAD (Voice Activity Detector) properties.
struct	vx_req_aux_set_vad_properties Set the connector VAD (Voice Activity Detector) properties.
struct	vx_req_aux_get_derumbler_properties Get the derumbler (high-pass filter) properties.
struct	vx_req_aux_set_derumbler_properties Set the derumbler (high-pass filter) properties.
struct	vx_req_aux_render_audio_stop Immediately stop audio render playback.
struct	vx_req_aux_capture_audio_start Ensure that a specific selected capture device is functioning properly.
struct	vx_req_aux_capture_audio_stop Immediately stop audio capture.
struct	vx_req_account_get_session_fonts Get the list of fonts that are eligible for use in a session by the current user.
struct	vx_req_account_get_template_fonts Get the list of fonts that the user can "try", including all user fonts and free root fonts.
struct	vx_req_aux_start_buffer_capture Start audio capture from the selected audio capture device.
struct	vx_req_aux_play_audio_buffer Play a buffer from memory that was captured with the [vx_req_aux_start_buffer_capture] command.
struct	vx_req_aux_global_monitor_keyboard_mouse
struct	vx_req_aux_set_idle_timeout
struct	vx_generic_credentials Credentials for creating Vivox accounts.
struct	vx_req_aux_create_account
struct	vx_req_aux_reactivate_account
struct	vx_req_aux_deactivate_account
struct	vx_req_account_post_crash_dump Post crash dump data to the server.
struct	vx_req_aux_reset_password Reset a user's password.
struct	vx_req_aux_diagnostic_state_dump Get the current state of the SDK.
struct	vx_req_account_web_call
struct	vx_req_sessiongroup_get_stats Retrieve network-related statistics for the call associated with the specified session group.
struct	vx_req_account_send_message Send a message to a specific user.
struct	vx_req_account_delete_message Delete an existing message sent to a specific user.
struct	vx_req_account_edit_message modify an existing message sent to a specific user.
struct	vx_req_account_archive_query Query messages that were archived by the server for the specified account.
struct	vx_req_account_chat_history_query Query messages that were archived by the server for the specified account.
struct	vx_req_account_get_conversations Returns a list of conversations a user is participating in, in reverse order.
struct	vx_req_account_chat_history_set_marker Sets the message as read in a given conversation, this information will be used to calculate the amount of unread messages in a conversation among other things.
struct	vx_req_aux_notify_application_state_change Notify the SDK when important application-level changes occur.
struct	vx_req_account_control_communications Manage communication between users.
struct	vx_req_session_transcription_control Enable or disable session transcription.
struct	vx_req_account_safe_voice_update_consent Update the player consent status in the Safe Voice service for consent tracking.
struct	vx_req_account_safe_voice_get_consent Pass a Unity Authentication token to be validated by the Mint service for channel joins.

Types

	Name
enum	vx_password_hash_algorithm_t { password_hash_algorithm_cleartext = 0, password_hash_algorithm_sha1_username_hash = 1} The type of password hash algorithm to use when joining password-protected channels.
enum	req_disposition_type_t { req_disposition_reply_required, req_disposition_no_reply_required} Control whether the SDK returns a response for potential high volume requests, specifically, a vx_req_session_set_3d_position_t request.
typedef struct vx_req_connector_create	vx_req_connector_create_t Connect the application to the Vivox service.
typedef struct vx_req_connector_initiate_shutdown	vx_req_connector_initiate_shutdown_t Call this when the application is shutting down to gracefully release resources.
typedef struct vx_req_account_login	vx_req_account_login_t
typedef struct vx_req_account_authtoken_login	vx_req_account_authtoken_login_t
typedef struct vx_req_account_anonymous_login	vx_req_account_anonymous_login_t Log in anonymously to the Vivox network.
typedef struct vx_req_account_logout	vx_req_account_logout_t Log a user out of the Vivox system.
typedef struct vx_req_account_set_login_properties	vx_req_account_set_login_properties_t Set some of the properties passed in on the login command.
typedef struct vx_req_sessiongroup_create	vx_req_sessiongroup_create_t
typedef struct vx_req_sessiongroup_terminate	vx_req_sessiongroup_terminate_t
typedef struct vx_req_sessiongroup_add_session	vx_req_sessiongroup_add_session_t Sessions represent a connection to a media session with one or more participants.
typedef struct vx_req_sessiongroup_remove_session	vx_req_sessiongroup_remove_session_t End an established session (hang-up or disconnect).
typedef struct vx_req_sessiongroup_set_focus	vx_req_sessiongroup_set_focus_t Set the audio focus of a session when there are multiple sessions in a session group.
typedef struct vx_req_sessiongroup_unset_focus	vx_req_sessiongroup_unset_focus_t Unset the focus of a specific channel that previously was set to have focus.
typedef struct vx_req_sessiongroup_reset_focus	vx_req_sessiongroup_reset_focus_t Reset all sessions in a group so they have equal priority or focus.
typedef struct vx_req_sessiongroup_set_tx_session	vx_req_sessiongroup_set_tx_session_t Set the session within the session group to which to user's voice is transmitted.
typedef struct vx_req_sessiongroup_set_tx_all_sessions	vx_req_sessiongroup_set_tx_all_sessions_t Transmit the user's voice to all sessions within the specified session group.
typedef struct vx_req_sessiongroup_set_tx_no_session	vx_req_sessiongroup_set_tx_no_session_t Disables transmission to all sessions within a session group.
typedef struct vx_req_sessiongroup_set_session_3d_position	vx_req_sessiongroup_set_session_3d_position_t Set the position of any entire channel so all audio from that channel sounds like it comes from that position.
typedef struct vx_req_sessiongroup_control_audio_injection	vx_req_sessiongroup_control_audio_injection_t Start or stop session group audio injection.
typedef struct vx_req_session_create	vx_req_session_create_t
typedef struct vx_req_session_media_connect	vx_req_session_media_connect_t Connect media (audio) in a session.
typedef struct vx_req_session_media_disconnect	vx_req_session_media_disconnect_t
typedef struct vx_req_session_text_connect	vx_req_session_text_connect_t Add text to a session.
typedef struct vx_req_session_text_disconnect	vx_req_session_text_disconnect_t Disconnect text in a session.
typedef struct vx_req_session_terminate	vx_req_session_terminate_t End an established session (hang-up or disconnect).
typedef struct vx_req_session_mute_local_speaker	vx_req_session_mute_local_speaker_t Mute or unmute the audio render or the incoming text messages of the logged in user for the specified session.
typedef struct vx_req_session_set_local_render_volume	vx_req_session_set_local_render_volume_t Set the audio render volume for the specified session.
typedef struct vx_req_session_set_local_speaker_volume	vx_req_session_set_local_speaker_volume_t
typedef struct vx_req_session_channel_invite_user	vx_req_session_channel_invite_user_t This command sends an invitation to a specified user to join the channel that corresponds to the provided session handle.
typedef struct vx_req_session_set_participant_volume_for_me	vx_req_session_set_participant_volume_for_me_t Set the volume for a participant in the current session.
typedef struct vx_req_session_set_participant_mute_for_me	vx_req_session_set_participant_mute_for_me_t Mute a participant in the current session.
typedef struct vx_req_session_set_3d_position	vx_req_session_set_3d_position_t Set and get the 3D position of the speaker and listener.
typedef struct vx_req_session_set_voice_font	vx_req_session_set_voice_font_t Apply a voice font to an already established voice session.
typedef struct vx_req_account_channel_change_owner	vx_req_account_channel_change_owner_t
typedef struct vx_req_account_send_user_app_data	vx_req_account_send_user_app_data_t Send specified data directly to a user.
typedef struct vx_req_account_channel_add_acl	vx_req_account_channel_add_acl_t
typedef struct vx_req_account_channel_remove_acl	vx_req_account_channel_remove_acl_t
typedef struct vx_req_account_channel_get_acl	vx_req_account_channel_get_acl_t
typedef struct vx_req_channel_mute_user	vx_req_channel_mute_user_t Mute or unmute a participant in a specific channel.
typedef struct vx_req_channel_ban_user	vx_req_channel_ban_user_t
typedef struct vx_req_channel_get_banned_users	vx_req_channel_get_banned_users_t
typedef struct vx_req_channel_kick_user	vx_req_channel_kick_user_t Kick a user out of a channel and automatically allow the user back in after 60 seconds.
typedef struct vx_req_channel_mute_all_users	vx_req_channel_mute_all_users_t Mute or unmute all current users in a channel.
typedef struct vx_req_channel_set_lock_mode	vx_req_channel_set_lock_mode_t
typedef struct vx_req_connector_mute_local_mic	vx_req_connector_mute_local_mic_t Mute or unmute the microphone.
typedef struct vx_req_connector_mute_local_speaker	vx_req_connector_mute_local_speaker_t Mute or unmute the speaker (the render device of incoming audio).
typedef struct vx_req_connector_set_local_mic_volume	vx_req_connector_set_local_mic_volume_t
typedef struct vx_req_connector_set_local_speaker_volume	vx_req_connector_set_local_speaker_volume_t
typedef struct vx_req_connector_get_local_audio_info	vx_req_connector_get_local_audio_info_t Retrieve the current volume and mute status of the local render and capture devices.
typedef struct vx_req_account_buddy_set	vx_req_account_buddy_set_t Add a buddy to a buddy list or update the properties of a buddy.
typedef struct vx_req_account_buddy_delete	vx_req_account_buddy_delete_t Delete a buddy from a user's buddy list.
typedef struct vx_req_account_list_buddies_and_groups	vx_req_account_list_buddies_and_groups_t Retrieve a list of all buddies and buddy groups for a given account.
typedef struct vx_req_session_send_message	vx_req_session_send_message_t Send a message to all participants in the session.
typedef struct vx_req_session_delete_message	vx_req_session_delete_message_t Delete a message for all participants in the session.
typedef struct vx_req_session_edit_message	vx_req_session_edit_message_t Edit a message for all participants in the session.
typedef struct vx_req_session_archive_query	vx_req_session_archive_query_t Query messages that were archived by the server for the specified channel.
typedef struct vx_req_session_chat_history_query	vx_req_session_chat_history_query_t Query messages that were archived by the server for the specified channel.
typedef struct vx_req_account_chat_history_get_last_read	vx_req_account_chat_history_get_last_read_t Get the last read message from a specified channel.
typedef struct vx_req_account_set_presence	vx_req_account_set_presence_t Set the presence (online/offline status) of an account.
typedef struct vx_req_account_send_subscription_reply	vx_req_account_send_subscription_reply_t Respond to an incoming subscription event.
typedef struct vx_req_session_send_notification	vx_req_session_send_notification_t Send a notification about the properties of the current session (for example, whether a user is typing).
typedef struct vx_req_session_send_dtmf	vx_req_session_send_dtmf_t
typedef struct vx_req_account_create_block_rule	vx_req_account_create_block_rule_t Define rules to block individuals or groups of individuals.
typedef struct vx_req_account_delete_block_rule	vx_req_account_delete_block_rule_t Delete a block rule.
typedef struct vx_req_account_list_block_rules	vx_req_account_list_block_rules_t Retrieve a list of block rules for a given account.
typedef struct vx_req_account_create_auto_accept_rule	vx_req_account_create_auto_accept_rule_t Set up rules to automatically accept individuals or groups of individuals when they request presence subscriptions.
typedef struct vx_req_account_delete_auto_accept_rule	vx_req_account_delete_auto_accept_rule_t Delete an auto accept rule.
typedef struct vx_req_account_list_auto_accept_rules	vx_req_account_list_auto_accept_rules_t Retrieve a list of auto accept rules for a given account.
typedef struct vx_req_account_update_account	vx_req_account_update_account_t
typedef struct vx_req_account_get_account	vx_req_account_get_account_t
typedef struct vx_req_account_send_sms	vx_req_account_send_sms_t
typedef struct vx_req_aux_connectivity_info	vx_req_aux_connectivity_info_t Perform a network test.
typedef struct vx_req_aux_get_render_devices	vx_req_aux_get_render_devices_t Retrieve a list of audio render devices for the current computer.
typedef struct vx_req_aux_get_capture_devices	vx_req_aux_get_capture_devices_t Return a list of available audio capture devices.
typedef struct vx_req_aux_set_render_device	vx_req_aux_set_render_device_t Instruct the Vivox SDK sound system to set the render device to a specific value.
typedef struct vx_req_aux_set_capture_device	vx_req_aux_set_capture_device_t Instruct the Vivox SDK sound system to set the capture device to a specific value.
typedef struct vx_req_aux_get_mic_level	vx_req_aux_get_mic_level_t This method returns the master microphone (capture) level of the Vivox SDK sound system.
typedef struct vx_req_aux_get_speaker_level	vx_req_aux_get_speaker_level_t This method returns the master speaker (render) level of the Vivox SDK sound system.
typedef struct vx_req_aux_set_mic_level	vx_req_aux_set_mic_level_t Set the master microphone level of the Vivox SDK sound system.
typedef struct vx_req_aux_set_speaker_level	vx_req_aux_set_speaker_level_t Set the master speaker level of the Vivox SDK sound system.
typedef struct vx_req_aux_render_audio_start	vx_req_aux_render_audio_start_t Ensure that a specific selected render device is functioning properly.
typedef struct vx_req_aux_render_audio_modify	vx_req_aux_render_audio_modify_t Modify the applied font of the aux audio buffer that is rendering.
typedef struct vx_req_aux_get_vad_properties	vx_req_aux_get_vad_properties_t Get the connector VAD (Voice Activity Detector) properties.
typedef struct vx_req_aux_set_vad_properties	vx_req_aux_set_vad_properties_t Set the connector VAD (Voice Activity Detector) properties.
typedef struct vx_req_aux_get_derumbler_properties	vx_req_aux_get_derumbler_properties_t Get the derumbler (high-pass filter) properties.
typedef struct vx_req_aux_set_derumbler_properties	vx_req_aux_set_derumbler_properties_t Set the derumbler (high-pass filter) properties.
typedef struct vx_req_aux_render_audio_stop	vx_req_aux_render_audio_stop_t Immediately stop audio render playback.
typedef struct vx_req_aux_capture_audio_start	vx_req_aux_capture_audio_start_t Ensure that a specific selected capture device is functioning properly.
typedef struct vx_req_aux_capture_audio_stop	vx_req_aux_capture_audio_stop_t Immediately stop audio capture.
typedef struct vx_req_account_get_session_fonts	vx_req_account_get_session_fonts_t Get the list of fonts that are eligible for use in a session by the current user.
typedef struct vx_req_account_get_template_fonts	vx_req_account_get_template_fonts_t Get the list of fonts that the user can "try", including all user fonts and free root fonts.
typedef struct vx_req_aux_start_buffer_capture	vx_req_aux_start_buffer_capture_t Start audio capture from the selected audio capture device.
typedef struct vx_req_aux_play_audio_buffer	vx_req_aux_play_audio_buffer_t Play a buffer from memory that was captured with the vx_req_aux_start_buffer_capture command.
typedef struct vx_req_aux_global_monitor_keyboard_mouse	vx_req_aux_global_monitor_keyboard_mouse_t
typedef struct vx_req_aux_set_idle_timeout	vx_req_aux_set_idle_timeout_t
typedef struct vx_req_aux_create_account	vx_req_aux_create_account_t
typedef struct vx_req_aux_reactivate_account	vx_req_aux_reactivate_account_t
typedef struct vx_req_aux_deactivate_account	vx_req_aux_deactivate_account_t
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_req_aux_reset_password	vx_req_aux_reset_password_t Reset a user's password.
typedef struct vx_req_aux_diagnostic_state_dump	vx_req_aux_diagnostic_state_dump_t Get the current state of the SDK.
typedef struct vx_req_account_web_call	vx_req_account_web_call_t
typedef struct vx_req_sessiongroup_get_stats	vx_req_sessiongroup_get_stats_t Retrieve network-related statistics for the call associated with the specified session group.
typedef struct vx_req_account_send_message	vx_req_account_send_message_t Send a message to a specific user.
typedef struct vx_req_account_delete_message	vx_req_account_delete_message_t Delete an existing message sent to a specific user.
typedef struct vx_req_account_edit_message	vx_req_account_edit_message_t modify an existing message sent to a specific user.
typedef struct vx_req_account_archive_query	vx_req_account_archive_query_t Query messages that were archived by the server for the specified account.
typedef struct vx_req_account_chat_history_query	vx_req_account_chat_history_query_t Query messages that were archived by the server for the specified account.
typedef struct vx_req_account_get_conversations	vx_req_account_get_conversations_t Returns a list of conversations a user is participating in, in reverse order.
typedef struct vx_req_account_chat_history_set_marker	vx_req_account_chat_history_set_marker_t Sets the message as read in a given conversation, this information will be used to calculate the amount of unread messages in a conversation among other things.
typedef struct vx_req_aux_notify_application_state_change	vx_req_aux_notify_application_state_change_t Notify the SDK when important application-level changes occur.
typedef struct vx_req_account_control_communications	vx_req_account_control_communications_t Manage communication between users.
typedef struct vx_req_session_transcription_control	vx_req_session_transcription_control_t Enable or disable session transcription.
typedef struct vx_req_account_safe_voice_update_consent	vx_req_account_safe_voice_update_consent_t Update the player consent status in the Safe Voice service for consent tracking.
typedef struct vx_req_account_safe_voice_get_consent	vx_req_account_safe_voice_get_consent_t Pass a Unity Authentication token to be validated by the Mint service for channel joins.

Functions

	Name
VIVOXSDK_DLLEXPORT int	vx_req_connector_create_create(vx_req_connector_create_t ** req) Allocate and initialize a vx_req_connector_create object.
VIVOXSDK_DLLEXPORT int	vx_req_connector_initiate_shutdown_create(vx_req_connector_initiate_shutdown_t ** req) Allocate and initialize a vx_req_connector_initiate_shutdown object.
VIVOXSDK_DLLEXPORT int	vx_req_account_login_create(vx_req_account_login_t ** req) Allocate and initialize a vx_req_account_login object.
VIVOXSDK_DLLEXPORT int	vx_req_account_authtoken_login_create(vx_req_account_authtoken_login_t ** req) Allocate and initialize a vx_req_account_authtoken_login object.
VIVOXSDK_DLLEXPORT int	vx_req_account_anonymous_login_create(vx_req_account_anonymous_login_t ** req) Allocate and initialize a vx_req_account_anonymous_login object.
VIVOXSDK_DLLEXPORT int	vx_req_account_logout_create(vx_req_account_logout_t ** req) Allocate and initialize a vx_req_account_logout object.
VIVOXSDK_DLLEXPORT int	vx_req_account_set_login_properties_create(vx_req_account_set_login_properties_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_create_create(vx_req_sessiongroup_create_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_terminate_create(vx_req_sessiongroup_terminate_t ** req) Allocate and initialize a vx_req_sessiongroup_terminate object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_add_session_create(vx_req_sessiongroup_add_session_t ** req) Allocate and initialize a vx_req_sessiongroup_add_session object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_remove_session_create(vx_req_sessiongroup_remove_session_t ** req) Allocate and initialize a vx_req_sessiongroup_remove_session object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_set_focus_create(vx_req_sessiongroup_set_focus_t ** req) Allocate and initialize a vx_req_sessiongroup_set_focus object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_unset_focus_create(vx_req_sessiongroup_unset_focus_t ** req) Allocate and initialize a vx_req_sessiongroup_unset_focus object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_reset_focus_create(vx_req_sessiongroup_reset_focus_t ** req) Allocate and initialize a vx_req_sessiongroup_reset_focus object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_set_tx_session_create(vx_req_sessiongroup_set_tx_session_t ** req) Allocate and initialize a vx_req_sessiongroup_set_tx_session object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_set_tx_all_sessions_create(vx_req_sessiongroup_set_tx_all_sessions_t ** req) Allocate and initialize a vx_req_sessiongroup_set_tx_all_sessions object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_set_tx_no_session_create(vx_req_sessiongroup_set_tx_no_session_t ** req) Allocate and initialize a vx_req_sessiongroup_set_tx_no_session object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_set_session_3d_position_create(vx_req_sessiongroup_set_session_3d_position_t ** req) Allocate and initialize a vx_req_sessiongroup_set_session_3d_position object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_control_audio_injection_create(vx_req_sessiongroup_control_audio_injection_t ** req) Allocate and initialize a vx_req_sessiongroup_control_audio_injection object.
VIVOXSDK_DLLEXPORT int	vx_req_session_create_create(vx_req_session_create_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_session_media_connect_create(vx_req_session_media_connect_t ** req) Allocate and initialize a vx_req_session_media_connect object.
VIVOXSDK_DLLEXPORT int	vx_req_session_media_disconnect_create(vx_req_session_media_disconnect_t ** req) Allocate and initialize a vx_req_session_media_disconnect object.
VIVOXSDK_DLLEXPORT int	vx_req_session_text_connect_create(vx_req_session_text_connect_t ** req) Allocate and initialize a vx_req_session_text_connect object.
VIVOXSDK_DLLEXPORT int	vx_req_session_text_disconnect_create(vx_req_session_text_disconnect_t ** req) Allocate and initialize a vx_req_session_text_disconnect object.
VIVOXSDK_DLLEXPORT int	vx_req_session_terminate_create(vx_req_session_terminate_t ** req) Allocate and initialize a vx_req_session_terminate object.
VIVOXSDK_DLLEXPORT int	vx_req_session_mute_local_speaker_create(vx_req_session_mute_local_speaker_t ** req) Allocate and initialize a vx_req_session_mute_local_speaker object.
VIVOXSDK_DLLEXPORT int	vx_req_session_set_local_render_volume_create(vx_req_session_set_local_render_volume_t ** req) Allocate and initialize a vx_req_session_set_local_render_volume object.
VIVOXSDK_DLLEXPORT int	vx_req_session_set_local_speaker_volume_create(vx_req_session_set_local_speaker_volume_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_session_channel_invite_user_create(vx_req_session_channel_invite_user_t ** req) Create a vx_req_session_channel_invite_user_t request.
VIVOXSDK_DLLEXPORT int	vx_req_session_set_participant_volume_for_me_create(vx_req_session_set_participant_volume_for_me_t ** req) Allocate and initialize a vx_req_session_set_participant_volume_for_me object.
VIVOXSDK_DLLEXPORT int	vx_req_session_set_participant_mute_for_me_create(vx_req_session_set_participant_mute_for_me_t ** req) Allocate and initialize a vx_req_session_set_participant_mute_for_me object.
VIVOXSDK_DLLEXPORT int	vx_req_session_set_3d_position_create(vx_req_session_set_3d_position_t ** req) Allocate and initialize a vx_req_session_set_3d_position object.
VIVOXSDK_DLLEXPORT int	vx_req_session_set_voice_font_create(vx_req_session_set_voice_font_t ** req) Allocate and initialize a vx_req_session_set_voice_font object.
VIVOXSDK_DLLEXPORT int	vx_req_account_channel_change_owner_create(vx_req_account_channel_change_owner_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_account_send_user_app_data_create(vx_req_account_send_user_app_data_t ** req) Allocate and initialize a vx_req_account_send_user_app_data object.
VIVOXSDK_DLLEXPORT int	vx_req_account_channel_add_acl_create(vx_req_account_channel_add_acl_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_account_channel_remove_acl_create(vx_req_account_channel_remove_acl_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_account_channel_get_acl_create(vx_req_account_channel_get_acl_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_channel_mute_user_create(vx_req_channel_mute_user_t ** req) Allocate and initialize a vx_req_channel_mute_user object.
VIVOXSDK_DLLEXPORT int	vx_req_channel_ban_user_create(vx_req_channel_ban_user_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_channel_get_banned_users_create(vx_req_channel_get_banned_users_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_channel_kick_user_create(vx_req_channel_kick_user_t ** req) Allocate and initialize a vx_req_channel_kick_user object.
VIVOXSDK_DLLEXPORT int	vx_req_channel_mute_all_users_create(vx_req_channel_mute_all_users_t ** req) Allocate and initialize a vx_req_channel_mute_all_users object.
VIVOXSDK_DLLEXPORT int	vx_req_channel_set_lock_mode_create(vx_req_channel_set_lock_mode_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_connector_mute_local_mic_create(vx_req_connector_mute_local_mic_t ** req) Allocate and initialize a vx_req_connector_mute_local_mic object.
VIVOXSDK_DLLEXPORT int	vx_req_connector_mute_local_speaker_create(vx_req_connector_mute_local_speaker_t ** req) Allocate and initialize a vx_req_connector_mute_local_speaker object.
VIVOXSDK_DLLEXPORT int	vx_req_connector_set_local_mic_volume_create(vx_req_connector_set_local_mic_volume_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_connector_set_local_speaker_volume_create(vx_req_connector_set_local_speaker_volume_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_connector_get_local_audio_info_create(vx_req_connector_get_local_audio_info_t ** req) Allocate and initialize a vx_req_connector_get_local_audio_info object.
VIVOXSDK_DLLEXPORT int	vx_req_account_buddy_set_create(vx_req_account_buddy_set_t ** req) Allocate and initialize a vx_req_account_buddy_set object.
VIVOXSDK_DLLEXPORT int	vx_req_account_buddy_delete_create(vx_req_account_buddy_delete_t ** req) Allocate and initialize a vx_req_account_buddy_delete object.
VIVOXSDK_DLLEXPORT int	vx_req_account_list_buddies_and_groups_create(vx_req_account_list_buddies_and_groups_t ** req) Allocate and initialize a vx_req_account_list_buddies_and_groups object.
VIVOXSDK_DLLEXPORT int	vx_req_session_send_message_create(vx_req_session_send_message_t ** req) Allocate and initialize a vx_req_session_send_message object.
VIVOXSDK_DLLEXPORT int	vx_req_session_delete_message_create(vx_req_session_delete_message_t ** req) Allocate and initialize a vx_req_session_delete_message object.
VIVOXSDK_DLLEXPORT int	vx_req_session_edit_message_create(vx_req_session_edit_message_t ** req) Allocate and initialize a vx_req_session_edit_message object.
VIVOXSDK_DLLEXPORT int	vx_req_session_archive_query_create(vx_req_session_archive_query_t ** req) Allocate and initialize a vx_req_session_archive_query object.
VIVOXSDK_DLLEXPORT int	vx_req_session_chat_history_query_create(vx_req_session_chat_history_query_t ** req) Allocate and initialize a vx_req_session_chat_history_query object.
VIVOXSDK_DLLEXPORT int	vx_req_account_chat_history_get_last_read_create(vx_req_account_chat_history_get_last_read_t ** req) Allocate and initialize a vx_req_account_chat_history_get_last_read object.
VIVOXSDK_DLLEXPORT int	vx_req_account_set_presence_create(vx_req_account_set_presence_t ** req) Allocate and initialize a vx_req_account_set_presence object.
VIVOXSDK_DLLEXPORT int	vx_req_account_send_subscription_reply_create(vx_req_account_send_subscription_reply_t ** req) Allocate and initialize a vx_req_account_send_subscription_reply object.
VIVOXSDK_DLLEXPORT int	vx_req_session_send_notification_create(vx_req_session_send_notification_t ** req) Allocate and initialize a vx_req_session_send_notification object.
VIVOXSDK_DLLEXPORT int	vx_req_session_send_dtmf_create(vx_req_session_send_dtmf_t ** req)
VIVOXSDK_DLLEXPORT int	vx_req_account_create_block_rule_create(vx_req_account_create_block_rule_t ** req) Allocate and initialize a vx_req_account_create_block_rule object.
VIVOXSDK_DLLEXPORT int	vx_req_account_delete_block_rule_create(vx_req_account_delete_block_rule_t ** req) Allocate and initialize a vx_req_account_delete_block_rule object.
VIVOXSDK_DLLEXPORT int	vx_req_account_list_block_rules_create(vx_req_account_list_block_rules_t ** req) Allocate and initialize a vx_req_account_list_block_rules object.
VIVOXSDK_DLLEXPORT int	vx_req_account_create_auto_accept_rule_create(vx_req_account_create_auto_accept_rule_t ** req) Allocate and initialize a vx_req_account_create_auto_accept_rule object.
VIVOXSDK_DLLEXPORT int	vx_req_account_delete_auto_accept_rule_create(vx_req_account_delete_auto_accept_rule_t ** req) Allocate and initialize a vx_req_account_delete_auto_accept_rule object.
VIVOXSDK_DLLEXPORT int	vx_req_account_list_auto_accept_rules_create(vx_req_account_list_auto_accept_rules_t ** req) Allocate and initialize a vx_req_account_list_auto_accept_rules object.
VIVOXSDK_DLLEXPORT int	vx_req_account_update_account_create(vx_req_account_update_account_t ** req) Allocate and initialize a vx_req_account_update_account object.
VIVOXSDK_DLLEXPORT int	vx_req_account_get_account_create(vx_req_account_get_account_t ** req) Allocate and initialize a vx_req_account_get_account object.
VIVOXSDK_DLLEXPORT int	vx_req_account_send_sms_create(vx_req_account_send_sms_t ** req) Allocate and initialize a vx_req_account_send_sms object.
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_aux_get_render_devices_create(vx_req_aux_get_render_devices_t ** req) Allocate and initialize a vx_req_aux_get_render_devices object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_get_capture_devices_create(vx_req_aux_get_capture_devices_t ** req) Allocate and initialize a vx_req_aux_get_render_devices object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_set_render_device_create(vx_req_aux_set_render_device_t ** req) Allocate and initialize a vx_req_aux_set_render_device object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_set_capture_device_create(vx_req_aux_set_capture_device_t ** req) Allocate and initialize a vx_req_aux_set_capture_device object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_get_mic_level_create(vx_req_aux_get_mic_level_t ** req) Allocate and initialize a vx_req_aux_get_mic_level object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_get_speaker_level_create(vx_req_aux_get_speaker_level_t ** req) Allocate and initialize a vx_req_aux_get_speaker_level object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_set_mic_level_create(vx_req_aux_set_mic_level_t ** req) Allocate and initialize a vx_req_aux_set_mic_level object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_set_speaker_level_create(vx_req_aux_set_speaker_level_t ** req) Allocate and initialize a vx_req_aux_set_speaker_level object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_render_audio_start_create(vx_req_aux_render_audio_start_t ** req) Allocate and initialize a vx_req_aux_render_audio_start object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_render_audio_modify_create(vx_req_aux_render_audio_modify_t ** req) Allocate and initialize a vx_req_aux_render_audio_modify object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_get_vad_properties_create(vx_req_aux_get_vad_properties_t ** req) Allocate and initialize a vx_req_aux_get_vad_properties object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_set_vad_properties_create(vx_req_aux_set_vad_properties_t ** req) Allocate and initialize a vx_req_aux_set_vad_properties object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_get_derumbler_properties_create(vx_req_aux_get_derumbler_properties_t ** req) Allocate and initialize a vx_req_aux_get_derumbler_properties object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_set_derumbler_properties_create(vx_req_aux_set_derumbler_properties_t ** req) Allocate and initialize a vx_req_aux_set_derumbler_properties object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_render_audio_stop_create(vx_req_aux_render_audio_stop_t ** req) Allocate and initialize a vx_req_aux_render_audio_stop object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_capture_audio_start_create(vx_req_aux_capture_audio_start_t ** req) Allocate and initialize a vx_req_aux_capture_audio_start object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_capture_audio_stop_create(vx_req_aux_capture_audio_stop_t ** req) Allocate and initialize a vx_req_aux_capture_audio_stop object.
VIVOXSDK_DLLEXPORT int	vx_req_account_get_session_fonts_create(vx_req_account_get_session_fonts_t ** req) Allocate and initialize a vx_req_account_get_session_fonts object.
VIVOXSDK_DLLEXPORT int	vx_req_account_get_template_fonts_create(vx_req_account_get_template_fonts_t ** req) Allocate and initialize a vx_req_account_get_template_fonts object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_start_buffer_capture_create(vx_req_aux_start_buffer_capture_t ** req) Allocate and initialize a vx_req_aux_start_buffer_capture object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_play_audio_buffer_create(vx_req_aux_play_audio_buffer_t ** req) Allocate and initialize a vx_req_aux_play_audio_buffer object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_global_monitor_keyboard_mouse_create(vx_req_aux_global_monitor_keyboard_mouse_t ** req) Allocate and initialize a vx_req_aux_global_monitor_keyboard_mouse object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_set_idle_timeout_create(vx_req_aux_set_idle_timeout_t ** req) Allocate and initialize a vx_req_aux_set_idle_timeout object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_create_account_create(vx_req_aux_create_account_t ** req) Allocate and initialize a vx_req_aux_create_account object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_reactivate_account_create(vx_req_aux_reactivate_account_t ** req) Allocate and initialize a vx_req_aux_create_account object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_deactivate_account_create(vx_req_aux_deactivate_account_t ** req) Allocate and initialize a vx_req_aux_create_account 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 int	vx_req_aux_reset_password_create(vx_req_aux_reset_password_t ** req) Allocate and initialize a vx_req_aux_reset_password object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_diagnostic_state_dump_create(vx_req_aux_diagnostic_state_dump_t ** req) Allocate and initialize a vx_req_aux_diagnostic_state_dump object.
VIVOXSDK_DLLEXPORT int	vx_req_account_web_call_create(vx_req_account_web_call_t ** req) Allocate and initialize a vx_req_account_web_call object.
VIVOXSDK_DLLEXPORT int	vx_req_sessiongroup_get_stats_create(vx_req_sessiongroup_get_stats_t ** req) Allocate and initialize a vx_req_sessiongroup_get_stats object.
VIVOXSDK_DLLEXPORT int	vx_req_account_send_message_create(vx_req_account_send_message_t ** req) Allocate and initialize a vx_req_session_send_message object.
VIVOXSDK_DLLEXPORT int	vx_req_account_delete_message_create(vx_req_account_delete_message_t ** req) Allocate and initialize a vx_req_account_delete_message object.
VIVOXSDK_DLLEXPORT int	vx_req_account_edit_message_create(vx_req_account_edit_message_t ** req) Allocate and initialize a vx_req_account_edit_message object.
VIVOXSDK_DLLEXPORT int	vx_req_account_archive_query_create(vx_req_account_archive_query_t ** req) Allocate and initialize a vx_req_account_archive_query object.
VIVOXSDK_DLLEXPORT int	vx_req_account_chat_history_query_create(vx_req_account_chat_history_query_t ** req) Allocate and initialize a vx_req_account_chat_history_query object.
VIVOXSDK_DLLEXPORT int	vx_req_account_get_conversations_create(vx_req_account_get_conversations_t ** req) Allocate and initialize a vx_req_account_req_conversations object.
VIVOXSDK_DLLEXPORT int	vx_req_account_chat_history_set_marker_create(vx_req_account_chat_history_set_marker_t ** req) Allocate and initialize a vx_req_account_chat_history_set_marker object.
VIVOXSDK_DLLEXPORT int	vx_req_aux_notify_application_state_change_create(vx_req_aux_notify_application_state_change_t ** req) Allocate and initialize a vx_req_aux_notify_application_state_change object.
VIVOXSDK_DLLEXPORT int	vx_req_account_control_communications_create(vx_req_account_control_communications_t ** req) Allocate and initialize a vx_req_account_control_communications object.
VIVOXSDK_DLLEXPORT int	vx_req_session_transcription_control_create(vx_req_session_transcription_control_t ** req) Allocate and initialize a vx_req_session_transcription_control object.
VIVOXSDK_DLLEXPORT int	destroy_req(vx_req_base_t * pCmd) Destroy a request of any type.
VIVOXSDK_DLLEXPORT int	vx_req_account_safe_voice_update_consent_create(vx_req_account_safe_voice_update_consent_t ** req) Allocate and initialize a vx_req_account_mint_login_token object.
VIVOXSDK_DLLEXPORT int	vx_req_account_safe_voice_get_consent_create(vx_req_account_safe_voice_get_consent_t ** req) Allocate and initialize a vx_req_account_mint_login_token object.

Defines

	Name
	MAX_CHANNEL_URI_LENGTH The maximum length of the session URI.

Types Documentation

enum vx_password_hash_algorithm_t

Enumerator	Value	Description
password_hash_algorithm_cleartext	0	The password is sent in cleartext.
password_hash_algorithm_sha1_username_hash	1	The password is sent as a SHA1 hash of the password and SIP URI of the user, Base64-encoded, with any trailing '=' characters stripped off.

The type of password hash algorithm to use when joining password-protected channels.

enum req_disposition_type_t

Enumerator	Value	Description
req_disposition_reply_required		Return a response to the application.
req_disposition_no_reply_required		Do not return a response to the application.

Control whether the SDK returns a response for potential high volume requests, specifically, a vx_req_session_set_3d_position_t request.

typedef vx_req_connector_create_t


typedef struct vx_req_connector_create vx_req_connector_create_t;

Connect the application to the Vivox service. See: vx_resp_connector_create

typedef vx_req_connector_initiate_shutdown_t


typedef struct vx_req_connector_initiate_shutdown vx_req_connector_initiate_shutdown_t;

Call this when the application is shutting down to gracefully release resources. See: vx_resp_connector_initiate_shutdown

typedef vx_req_account_login_t


typedef struct vx_req_account_login vx_req_account_login_t;

See: vx_resp_account_login Note: This can only be called after connector initialization has successfully completed.

typedef vx_req_account_authtoken_login_t


typedef struct vx_req_account_authtoken_login vx_req_account_authtoken_login_t;

See: vx_resp_account_authtoken_login Note: This can only be called after connector initialization has successfully completed.

typedef vx_req_account_anonymous_login_t


typedef struct vx_req_account_anonymous_login vx_req_account_anonymous_login_t;

Log in anonymously to the Vivox network. See: vx_resp_account_anonymous_login Note: This can only be called after connector initialization has successfully completed. This allows a user to log in and receive a temporary SIP URI and a user-generated display name, if supplied.

typedef vx_req_account_logout_t


typedef struct vx_req_account_logout vx_req_account_logout_t;

Log a user out of the Vivox system. See: vx_resp_account_logout

typedef vx_req_account_set_login_properties_t


typedef struct vx_req_account_set_login_properties vx_req_account_set_login_properties_t;

Set some of the properties passed in on the login command. See: vx_resp_account_set_login_properties

typedef vx_req_sessiongroup_create_t


typedef struct vx_req_sessiongroup_create vx_req_sessiongroup_create_t;

See: vx_resp_sessiongroup_create Note: A session group handle is required to change these aspects within the session group. If the session create command is used, a session group is automatically created.

typedef vx_req_sessiongroup_terminate_t


typedef struct vx_req_sessiongroup_terminate vx_req_sessiongroup_terminate_t;

See: vx_resp_sessiongroup_terminate

typedef vx_req_sessiongroup_add_session_t


typedef struct vx_req_sessiongroup_add_session vx_req_sessiongroup_add_session_t;

Sessions represent a connection to a media session with one or more participants. See: vx_resp_sessiongroup_add_session Sessions can be connected to session audio, text chat, or both session audio and text chat.

typedef vx_req_sessiongroup_remove_session_t


typedef struct vx_req_sessiongroup_remove_session vx_req_sessiongroup_remove_session_t;

End an established session (hang-up or disconnect). See: vx_resp_sessiongroup_remove_session

typedef vx_req_sessiongroup_set_focus_t


typedef struct vx_req_sessiongroup_set_focus vx_req_sessiongroup_set_focus_t;

Set the audio focus of a session when there are multiple sessions in a session group. See: vx_resp_sessiongroup_set_focus The effect of this request is to bring the specific session within the group to the foreground. The audible volume is relatively raised with respect to the channels that are not in focus. To set all of the sessions to be equal (for example, to have no specific focus), make an Unset Focus request.

typedef vx_req_sessiongroup_unset_focus_t


typedef struct vx_req_sessiongroup_unset_focus vx_req_sessiongroup_unset_focus_t;

Unset the focus of a specific channel that previously was set to have focus. See: vx_resp_sessiongroup_unset_focus

typedef vx_req_sessiongroup_reset_focus_t


typedef struct vx_req_sessiongroup_reset_focus vx_req_sessiongroup_reset_focus_t;

Reset all sessions in a group so they have equal priority or focus. See: vx_resp_sessiongroup_reset_focus

typedef vx_req_sessiongroup_set_tx_session_t


typedef struct vx_req_sessiongroup_set_tx_session vx_req_sessiongroup_set_tx_session_t;

Set the session within the session group to which to user's voice is transmitted. See: vx_resp_sessiongroup_set_tx_session If the user is currently transmitting to all sessions, then using this command forces transmission to only the specified session.

typedef vx_req_sessiongroup_set_tx_all_sessions_t


typedef struct vx_req_sessiongroup_set_tx_all_sessions vx_req_sessiongroup_set_tx_all_sessions_t;

Transmit the user's voice to all sessions within the specified session group. See: vx_resp_sessiongroup_set_tx_all_sessions

typedef vx_req_sessiongroup_set_tx_no_session_t


typedef struct vx_req_sessiongroup_set_tx_no_session vx_req_sessiongroup_set_tx_no_session_t;

Disables transmission to all sessions within a session group. See: vx_resp_sessiongroup_set_tx_no_session

typedef vx_req_sessiongroup_set_session_3d_position_t


typedef struct vx_req_sessiongroup_set_session_3d_position vx_req_sessiongroup_set_session_3d_position_t;

Set the position of any entire channel so all audio from that channel sounds like it comes from that position. See: vx_resp_sessiongroup_set_session_3d_position

typedef vx_req_sessiongroup_control_audio_injection_t


typedef struct vx_req_sessiongroup_control_audio_injection vx_req_sessiongroup_control_audio_injection_t;

Start or stop session group audio injection. See: vx_resp_sessiongroup_control_audio_injection

typedef vx_req_session_create_t


typedef struct vx_req_session_create vx_req_session_create_t;

Note: Creating a session automatically connects to the audio media, and you do not need to call Session.Connect. This request can be used as a shortcut to creating a session group and then adding a session to the session group. This request creates a new session group, creates a new session, and then returns the handles to both in the response.

typedef vx_req_session_media_connect_t


typedef struct vx_req_session_media_connect vx_req_session_media_connect_t;

Connect media (audio) in a session. See: vx_resp_session_media_connect Note: To use this request, a session must have already been created with media disconnected.

typedef vx_req_session_media_disconnect_t


typedef struct vx_req_session_media_disconnect vx_req_session_media_disconnect_t;

See: vx_resp_session_media_disconnect Note: To use this request, a session must have already been created and connected. This can also be used to hang up a call that the user is in, or to refuse an incoming call.

typedef vx_req_session_text_connect_t


typedef struct vx_req_session_text_connect vx_req_session_text_connect_t;

Add text to a session. See: vx_resp_session_text_connect Note: To use this request, a session must have already been created.

typedef vx_req_session_text_disconnect_t


typedef struct vx_req_session_text_disconnect vx_req_session_text_disconnect_t;

Disconnect text in a session. See: vx_req_session_text_disconnect Note: To use this request, a session must have already been created and connected.

typedef vx_req_session_terminate_t


typedef struct vx_req_session_terminate vx_req_session_terminate_t;

End an established session (hang-up or disconnect). See: vx_req_session_terminate

typedef vx_req_session_mute_local_speaker_t


typedef struct vx_req_session_mute_local_speaker vx_req_session_mute_local_speaker_t;

Mute or unmute the audio render or the incoming text messages of the logged in user for the specified session. See: vx_req_session_mute_local_speaker

typedef vx_req_session_set_local_render_volume_t


typedef struct vx_req_session_set_local_render_volume vx_req_session_set_local_render_volume_t;

Set the audio render volume for the specified session. See: vx_resp_session_set_local_render_volume

typedef vx_req_session_set_local_speaker_volume_t


typedef struct vx_req_session_set_local_speaker_volume vx_req_session_set_local_speaker_volume_t;

See: vx_resp_session_set_local_speaker_volume

typedef vx_req_session_channel_invite_user_t


typedef struct vx_req_session_channel_invite_user vx_req_session_channel_invite_user_t;

This command sends an invitation to a specified user to join the channel that corresponds to the provided session handle. See: vx_resp_session_channel_invite_user The user who sends the invite does not receive any feedback after the invite call is made, and does not know if the other user received the invitation, if they are online, or if they rejected or ignored the invitation. The user who sends the invitation can only determine whether an invitation was accepted if they see the user who received the invitation enter the channel. Sending an invite to a user is not the same as making a P2P call, because you do not get the events that you would receive when a P2P call is made. Invites work well for inviting PSTN callers into a channel.

typedef vx_req_session_set_participant_volume_for_me_t


typedef struct vx_req_session_set_participant_volume_for_me vx_req_session_set_participant_volume_for_me_t;

Set the volume for a participant in the current session. See: vx_resp_session_set_participant_volume_for_me This only affects the audio that is heard locally, and does not change the audio that is heard by any of the other participants. These changes are only valid for the current session; if the participant with the audio that is set leaves the session and rejoins, then the settings are lost.

typedef vx_req_session_set_participant_mute_for_me_t


typedef struct vx_req_session_set_participant_mute_for_me vx_req_session_set_participant_mute_for_me_t;

Mute a participant in the current session. See: vx_resp_session_set_participant_mute_for_me Note: This command only applies to channels (3D and static), and is not applicable for person-to-person calls. This only affects the audio that is heard locally, and does not change the audio that is heard by any of the other participants. These changes are only valid for the current session; if the participant with the audio that is set leaves the session and rejoins, then the settings are lost.

typedef vx_req_session_set_3d_position_t


typedef struct vx_req_session_set_3d_position vx_req_session_set_3d_position_t;

Set and get the 3D position of the speaker and listener. See: vx_req_session_set_3d_position For most applications, it is expected that the speaker and listener positions are the same. The SDK also supports the decoupling of these positions (for example, for the implementation of a camera audio zoom, the virtual "mouth" is where the avatar is, and the virtual "ears" are where the camera view is).

typedef vx_req_session_set_voice_font_t


typedef struct vx_req_session_set_voice_font vx_req_session_set_voice_font_t;

Apply a voice font to an already established voice session. See: vx_resp_session_set_voice_font

typedef vx_req_account_channel_change_owner_t


typedef struct vx_req_account_channel_change_owner vx_req_account_channel_change_owner_t;

Note: This can only be performed by the current owner of the channel. After the ownership change, the original owner remains a moderator of the channel.

typedef vx_req_account_send_user_app_data_t


typedef struct vx_req_account_send_user_app_data vx_req_account_send_user_app_data_t;

Send specified data directly to a user. See: vx_evt_user_app_data

typedef vx_req_account_channel_add_acl_t


typedef struct vx_req_account_channel_add_acl vx_req_account_channel_add_acl_t;

See: vx_resp_account_channel_add_acl

typedef vx_req_account_channel_remove_acl_t


typedef struct vx_req_account_channel_remove_acl vx_req_account_channel_remove_acl_t;

See: vx_resp_account_channel_remove_acl

typedef vx_req_account_channel_get_acl_t


typedef struct vx_req_account_channel_get_acl vx_req_account_channel_get_acl_t;

See: vx_resp_account_channel_get_acl

typedef vx_req_channel_mute_user_t


typedef struct vx_req_channel_mute_user vx_req_channel_mute_user_t;

Mute or unmute a participant in a specific channel. See: vx_resp_channel_mute_user Note: This request is only valid if the account making the request has moderator privileges on the target channel. This request mutes or unmutes the user for all users in the channel.

typedef vx_req_channel_ban_user_t


typedef struct vx_req_channel_ban_user vx_req_channel_ban_user_t;

See: vx_resp_channel_ban_user Note: This request is only valid if the account that makes the request has moderator privileges on the target channel.

typedef vx_req_channel_get_banned_users_t


typedef struct vx_req_channel_get_banned_users vx_req_channel_get_banned_users_t;

See: vx_resp_channel_get_banned_users

typedef vx_req_channel_kick_user_t


typedef struct vx_req_channel_kick_user vx_req_channel_kick_user_t;

Kick a user out of a channel and automatically allow the user back in after 60 seconds. See: vx_resp_channel_kick_user

typedef vx_req_channel_mute_all_users_t


typedef struct vx_req_channel_mute_all_users vx_req_channel_mute_all_users_t;

Mute or unmute all current users in a channel. See: vx_resp_channel_mute_all_users Note: New users who join the channel are not muted.

typedef vx_req_channel_set_lock_mode_t


typedef struct vx_req_channel_set_lock_mode vx_req_channel_set_lock_mode_t;

See: vx_resp_channel_set_lock_mode Note: The user who issues this request must have moderator privileges. A channel becomes unlocked when all participants have left the channel.

typedef vx_req_connector_mute_local_mic_t


typedef struct vx_req_connector_mute_local_mic vx_req_connector_mute_local_mic_t;

Mute or unmute the microphone. See: vx_resp_connector_mute_local_mic

typedef vx_req_connector_mute_local_speaker_t


typedef struct vx_req_connector_mute_local_speaker vx_req_connector_mute_local_speaker_t;

Mute or unmute the speaker (the render device of incoming audio). See: vx_resp_connector_mute_local_speaker Note: This setting applies universally to all connected audio sessions.

typedef vx_req_connector_set_local_mic_volume_t


typedef struct vx_req_connector_set_local_mic_volume vx_req_connector_set_local_mic_volume_t;

See: vx_resp_connector_set_local_mic_volume Note: The setting applies to all connected audio sessions.

typedef vx_req_connector_set_local_speaker_volume_t


typedef struct vx_req_connector_set_local_speaker_volume vx_req_connector_set_local_speaker_volume_t;

See: vx_resp_connector_set_local_speaker_volume

typedef vx_req_connector_get_local_audio_info_t


typedef struct vx_req_connector_get_local_audio_info vx_req_connector_get_local_audio_info_t;

Retrieve the current volume and mute status of the local render and capture devices. See: vx_resp_connector_get_local_audio_info

typedef vx_req_account_buddy_set_t


typedef struct vx_req_account_buddy_set vx_req_account_buddy_set_t;

Add a buddy to a buddy list or update the properties of a buddy. See:

The buddy is added to the account implied by the account_handle provided in the call. All relevant data about a buddy must be supplied when updating the buddy. If a display name is not specified when updating a the data field, the display name will be blank.

typedef vx_req_account_buddy_delete_t


typedef struct vx_req_account_buddy_delete vx_req_account_buddy_delete_t;

Delete a buddy from a user's buddy list. See: vx_resp_account_buddy_delete

typedef vx_req_account_list_buddies_and_groups_t


typedef struct vx_req_account_list_buddies_and_groups vx_req_account_list_buddies_and_groups_t;

Retrieve a list of all buddies and buddy groups for a given account.

typedef vx_req_session_send_message_t


typedef struct vx_req_session_send_message vx_req_session_send_message_t;

Send a message to all participants in the session. See: vx_resp_session_send_message

typedef vx_req_session_delete_message_t


typedef struct vx_req_session_delete_message vx_req_session_delete_message_t;

Delete a message for all participants in the session. See: vx_resp_session_delete_message

typedef vx_req_session_edit_message_t


typedef struct vx_req_session_edit_message vx_req_session_edit_message_t;

Edit a message for all participants in the session. See: vx_resp_session_edit_message

typedef vx_req_session_archive_query_t


typedef struct vx_req_session_archive_query vx_req_session_archive_query_t;

Query messages that were archived by the server for the specified channel. See: vx_resp_session_archive_query This includes all messages that are sent and received by using vx_req_session_send_message. This does not include any message that is sent or received by using vx_req_account_send_message. Messages can appear in the archive with a delay of up to several seconds after being sent or received. To query P2P message history, use vx_req_account_archive_query.

typedef vx_req_session_chat_history_query_t


typedef struct vx_req_session_chat_history_query vx_req_session_chat_history_query_t;

Query messages that were archived by the server for the specified channel. See: vx_resp_session_chat_history_query This includes all messages that are sent and received by using vx_req_session_send_message. This does not include any message that is sent or received by using vx_req_account_send_message. Messages can appear in the archive with a delay of up to several seconds after being sent or received. To query P2P message history, use vx_req_account_chat_history_query.

typedef vx_req_account_chat_history_get_last_read_t


typedef struct vx_req_account_chat_history_get_last_read vx_req_account_chat_history_get_last_read_t;

Get the last read message from a specified channel. See: vx_resp_account_chat_history_get_last_read The last read message is updated when a user disconnects from a channel.

typedef vx_req_account_set_presence_t


typedef struct vx_req_account_set_presence vx_req_account_set_presence_t;

Set the presence (online/offline status) of an account. See: vx_resp_account_set_presence

typedef vx_req_account_send_subscription_reply_t


typedef struct vx_req_account_send_subscription_reply vx_req_account_send_subscription_reply_t;

Respond to an incoming subscription event. See: vx_resp_account_send_subscription_reply For example, a request from another user to put a user on their buddy list.

typedef vx_req_session_send_notification_t


typedef struct vx_req_session_send_notification vx_req_session_send_notification_t;

Send a notification about the properties of the current session (for example, whether a user is typing). See: vx_resp_session_send_notification

typedef vx_req_session_send_dtmf_t


typedef struct vx_req_session_send_dtmf vx_req_session_send_dtmf_t;

See: vx_resp_session_send_dtmf

typedef vx_req_account_create_block_rule_t


typedef struct vx_req_account_create_block_rule vx_req_account_create_block_rule_t;

Define rules to block individuals or groups of individuals. See: vx_resp_account_create_block_rule

typedef vx_req_account_delete_block_rule_t


typedef struct vx_req_account_delete_block_rule vx_req_account_delete_block_rule_t;

Delete a block rule. See: vx_resp_account_delete_block_rule

typedef vx_req_account_list_block_rules_t


typedef struct vx_req_account_list_block_rules vx_req_account_list_block_rules_t;

Retrieve a list of block rules for a given account. See: vx_resp_account_list_block_rules The order of rules returned in the list is unspecified. The calling application must sequence the resultant data.

typedef vx_req_account_create_auto_accept_rule_t


typedef struct vx_req_account_create_auto_accept_rule vx_req_account_create_auto_accept_rule_t;

Set up rules to automatically accept individuals or groups of individuals when they request presence subscriptions. See: vx_resp_account_create_auto_accept_rule

typedef vx_req_account_delete_auto_accept_rule_t


typedef struct vx_req_account_delete_auto_accept_rule vx_req_account_delete_auto_accept_rule_t;

Delete an auto accept rule. See: vx_resp_account_delete_auto_accept_rule

typedef vx_req_account_list_auto_accept_rules_t


typedef struct vx_req_account_list_auto_accept_rules vx_req_account_list_auto_accept_rules_t;

Retrieve a list of auto accept rules for a given account. See: vx_resp_account_list_auto_accept_rule The order of rules returned in the list is unspecified. The calling application must sequence the resultant data.

typedef vx_req_account_update_account_t


typedef struct vx_req_account_update_account vx_req_account_update_account_t;

See: vx_resp_account_update_account

typedef vx_req_account_get_account_t


typedef struct vx_req_account_get_account vx_req_account_get_account_t;

See: vx_resp_account_get_account

typedef vx_req_account_send_sms_t


typedef struct vx_req_account_send_sms vx_req_account_send_sms_t;

See: vx_resp_account_send_sms

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_aux_get_render_devices_t


typedef struct vx_req_aux_get_render_devices vx_req_aux_get_render_devices_t;

Retrieve a list of audio render devices for the current computer. See: vx_resp_aux_get_render_devices Note: This list could be smaller than the list of all available render devices. Most machines have at least one audio render device. The application programmer can call this method without initializing the SDK or logging in (similar to the network connectivity methods).

typedef vx_req_aux_get_capture_devices_t


typedef struct vx_req_aux_get_capture_devices vx_req_aux_get_capture_devices_t;

Return a list of available audio capture devices. See: vx_resp_aux_get_capture_devices Note: This list could be smaller than the list of all available capture devices.

typedef vx_req_aux_set_render_device_t


typedef struct vx_req_aux_set_render_device vx_req_aux_set_render_device_t;

Instruct the Vivox SDK sound system to set the render device to a specific value. See: vx_resp_aux_set_render_device Note: On PlayStation 4, the render_device_specifier can be the string representation of the user ID. The "render device specifier" is a string that must match the device string of the vx_device_t structs that are returned from a "get render devices" call. This value is retained across various voice sessions.

typedef vx_req_aux_set_capture_device_t


typedef struct vx_req_aux_set_capture_device vx_req_aux_set_capture_device_t;

Instruct the Vivox SDK sound system to set the capture device to a specific value. See: vx_resp_aux_set_capture_device

typedef vx_req_aux_get_mic_level_t


typedef struct vx_req_aux_get_mic_level vx_req_aux_get_mic_level_t;

This method returns the master microphone (capture) level of the Vivox SDK sound system. See: vx_resp_aux_get_mic_level This is a non-negative integer value between 0 and 100 (inclusive). The scale is logarithmic, which means that a level increase of 6 represents a doubling in energy, and a level increase of 20 represents a ten-fold increase in energy. The default value is 50.

typedef vx_req_aux_get_speaker_level_t


typedef struct vx_req_aux_get_speaker_level vx_req_aux_get_speaker_level_t;

This method returns the master speaker (render) level of the Vivox SDK sound system. See: vx_resp_aux_get_speaker_level This is a non-negative integer value between 0 and 100 (inclusive). The scale is logarithmic, which means that a level increase of 6 represents a doubling in energy, and a level increase of 20 represents a ten-fold increase in energy. The default value is 50.

typedef vx_req_aux_set_mic_level_t


typedef struct vx_req_aux_set_mic_level vx_req_aux_set_mic_level_t;

Set the master microphone level of the Vivox SDK sound system. See: vx_resp_aux_set_mic_level Valid values are non-negative integers between 0 and 100 (inclusive). The default value is 50.

typedef vx_req_aux_set_speaker_level_t


typedef struct vx_req_aux_set_speaker_level vx_req_aux_set_speaker_level_t;

Set the master speaker level of the Vivox SDK sound system. See: vx_resp_aux_set_speaker_level Valid values are non-negative integers between 0 and 100 (inclusive). The default value is 50.

typedef vx_req_aux_render_audio_start_t


typedef struct vx_req_aux_render_audio_start vx_req_aux_render_audio_start_t;

Ensure that a specific selected render device is functioning properly. See: vx_resp_aux_render_audio_start The sound_file_path should point to a local directory path that contains a monaural .wav or .au sound file. If the loop value is set to 1, then the sound system plays the file in a continuous loop until the "render audio stop" method is called.

typedef vx_req_aux_render_audio_modify_t


typedef struct vx_req_aux_render_audio_modify vx_req_aux_render_audio_modify_t;

Modify the applied font of the aux audio buffer that is rendering. If no audio buffer is rendering, then the method immediately returns.

typedef vx_req_aux_get_vad_properties_t


typedef struct vx_req_aux_get_vad_properties vx_req_aux_get_vad_properties_t;

Get the connector VAD (Voice Activity Detector) properties. See: vx_req_aux_get_vad_properties

typedef vx_req_aux_set_vad_properties_t


typedef struct vx_req_aux_set_vad_properties vx_req_aux_set_vad_properties_t;

Set the connector VAD (Voice Activity Detector) properties. The following properties update when capture audio is active:

vad_hangover
vad_sensitivity
vad_auto The vad_noise_floor property requires capture audio restart to update (for example, the update occurs after rejoining a voice channel). vx_req_aux_set_vad_properties

typedef vx_req_aux_get_derumbler_properties_t


typedef struct vx_req_aux_get_derumbler_properties vx_req_aux_get_derumbler_properties_t;

Get the derumbler (high-pass filter) properties. See: vx_req_aux_get_derumbler_properties

typedef vx_req_aux_set_derumbler_properties_t


typedef struct vx_req_aux_set_derumbler_properties vx_req_aux_set_derumbler_properties_t;

Set the derumbler (high-pass filter) properties. See: vx_req_aux_set_derumbler_properties

typedef vx_req_aux_render_audio_stop_t


typedef struct vx_req_aux_render_audio_stop vx_req_aux_render_audio_stop_t;

Immediately stop audio render playback. See: vx_resp_aux_render_audio_stop If no audio files are being played back, then the method immediately returns.

typedef vx_req_aux_capture_audio_start_t


typedef struct vx_req_aux_capture_audio_start vx_req_aux_capture_audio_start_t;

Ensure that a specific selected capture device is functioning properly. See: vx_resp_aux_capture_audio_start This can only be successfully invoked if the capture device is not currently in use (such as if it is in a voice session). After the start audio capture method successfully completes, the Vivox SDK sound system starts sending VxAudioEvent_t events at one half the capture frame rate.

typedef vx_req_aux_capture_audio_stop_t


typedef struct vx_req_aux_capture_audio_stop vx_req_aux_capture_audio_stop_t;

Immediately stop audio capture. See: vx_resp_aux_capture_audio_stop If no audio files are being played back, then the method immediately returns.

typedef vx_req_account_get_session_fonts_t


typedef struct vx_req_account_get_session_fonts vx_req_account_get_session_fonts_t;

Get the list of fonts that are eligible for use in a session by the current user. See: vx_resp_account_get_session_fonts

typedef vx_req_account_get_template_fonts_t


typedef struct vx_req_account_get_template_fonts vx_req_account_get_template_fonts_t;

Get the list of fonts that the user can "try", including all user fonts and free root fonts. See: vx_resp_account_get_template_fonts

typedef vx_req_aux_start_buffer_capture_t


typedef struct vx_req_aux_start_buffer_capture vx_req_aux_start_buffer_capture_t;

Start audio capture from the selected audio capture device. See: vx_resp_aux_start_buffer_capture Audio is captured to the SDK internal capture buffer until the vx_req_aux_capture_audio_stop command is issued, or until 10 minutes has elapsed, whichever is earlier.

typedef vx_req_aux_play_audio_buffer_t


typedef struct vx_req_aux_play_audio_buffer vx_req_aux_play_audio_buffer_t;

Play a buffer from memory that was captured with the vx_req_aux_start_buffer_capture command. See: vx_resp_aux_play_audio_buffer To terminate playback, use vx_req_aux_render_audio_stop.

typedef vx_req_aux_global_monitor_keyboard_mouse_t


typedef struct vx_req_aux_global_monitor_keyboard_mouse vx_req_aux_global_monitor_keyboard_mouse_t;

See: vx_resp_aux_global_monitor_keyboard_mouse Note: On OSX, to use this feature, "Enable Access for Assistive Devices" must be enabled. Attention: This is not supported on the iPhone platform.

typedef vx_req_aux_set_idle_timeout_t


typedef struct vx_req_aux_set_idle_timeout vx_req_aux_set_idle_timeout_t;

See: vx_resp_aux_set_idle_timeout Note: Mouse movement events do not trigger the exit from idle condition. Attention: This is not supported on the iPhone platform.

typedef vx_req_aux_create_account_t


typedef struct vx_req_aux_create_account vx_req_aux_create_account_t;

See: vx_resp_aux_create_account Attention: This is not supported on the iPhone platform.

typedef vx_req_aux_reactivate_account_t


typedef struct vx_req_aux_reactivate_account vx_req_aux_reactivate_account_t;

See: vx_resp_aux_reactivate_account Attention: This is not supported on the iPhone platform.

typedef vx_req_aux_deactivate_account_t


typedef struct vx_req_aux_deactivate_account vx_req_aux_deactivate_account_t;

See: vx_resp_aux_deactivate_account Attention: This is not supported on the iPhone platform.

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_req_aux_reset_password_t


typedef struct vx_req_aux_reset_password vx_req_aux_reset_password_t;

Reset a user's password. See: vx_resp_aux_reset_password

typedef vx_req_aux_diagnostic_state_dump_t


typedef struct vx_req_aux_diagnostic_state_dump vx_req_aux_diagnostic_state_dump_t;

Get the current state of the SDK. See: vx_resp_aux_diagnostic_state_dump Attention: This is not supported on the iPhone platform. Get the initial state when connecting to an out of process Vivox SDK that is already running.

typedef vx_req_account_web_call_t


typedef struct vx_req_account_web_call vx_req_account_web_call_t;

See: vx_resp_account_web_call

typedef vx_req_sessiongroup_get_stats_t


typedef struct vx_req_sessiongroup_get_stats vx_req_sessiongroup_get_stats_t;

Retrieve network-related statistics for the call associated with the specified session group. See: vx_resp_sessiongroup_get_stats

typedef vx_req_account_send_message_t


typedef struct vx_req_account_send_message vx_req_account_send_message_t;

Send a message to a specific user. See: vx_resp_account_send_message

typedef vx_req_account_delete_message_t


typedef struct vx_req_account_delete_message vx_req_account_delete_message_t;

Delete an existing message sent to a specific user. See: vx_resp_account_delete_message

typedef vx_req_account_edit_message_t


typedef struct vx_req_account_edit_message vx_req_account_edit_message_t;

modify an existing message sent to a specific user. See: vx_resp_account_edit_message

typedef vx_req_account_archive_query_t


typedef struct vx_req_account_archive_query vx_req_account_archive_query_t;

Query messages that were archived by the server for the specified account. See: vx_req_session_archive_query This includes all messages that are sent and received by this account, including directed messages and channel messages. Messages can appear in the archive with a delay of up to several seconds after being sent or received. To query a specific channel's history, use vx_req_session_archive_query.

typedef vx_req_account_chat_history_query_t


typedef struct vx_req_account_chat_history_query vx_req_account_chat_history_query_t;

Query messages that were archived by the server for the specified account. See: vx_req_session_chat_history_query This includes all messages that are sent and received by this account, including directed messages and channel messages. Messages can appear in the archive with a delay of up to several seconds after being sent or received. To query a specific channel's history, use vx_req_session_chat_history_query.

typedef vx_req_account_get_conversations_t


typedef struct vx_req_account_get_conversations vx_req_account_get_conversations_t;

Returns a list of conversations a user is participating in, in reverse order. See: vx_resp_account_req_get_conversations Only returns conversations from a user's DMs and also from channels where a user sent a message.

typedef vx_req_account_chat_history_set_marker_t


typedef struct vx_req_account_chat_history_set_marker vx_req_account_chat_history_set_marker_t;

Sets the message as read in a given conversation, this information will be used to calculate the amount of unread messages in a conversation among other things. See: vx_resp_account_chat_history_set_marker

typedef vx_req_aux_notify_application_state_change_t


typedef struct vx_req_aux_notify_application_state_change vx_req_aux_notify_application_state_change_t;

Notify the SDK when important application-level changes occur. See: vx_resp_aux_notify_application_state_change

typedef vx_req_account_control_communications_t


typedef struct vx_req_account_control_communications vx_req_account_control_communications_t;

Manage communication between users. See: vx_resp_account_control_communications

typedef vx_req_session_transcription_control_t


typedef struct vx_req_session_transcription_control vx_req_session_transcription_control_t;

Enable or disable session transcription.

typedef vx_req_account_safe_voice_update_consent_t


typedef struct vx_req_account_safe_voice_update_consent vx_req_account_safe_voice_update_consent_t;

Update the player consent status in the Safe Voice service for consent tracking.

typedef vx_req_account_safe_voice_get_consent_t


typedef struct vx_req_account_safe_voice_get_consent vx_req_account_safe_voice_get_consent_t;

Pass a Unity Authentication token to be validated by the Mint service for channel joins.

Functions Documentation

function vx_req_connector_create_create


VIVOXSDK_DLLEXPORT int vx_req_connector_create_create(    vx_req_connector_create_t ** req)

Allocate and initialize a vx_req_connector_create object.

function vx_req_connector_initiate_shutdown_create


VIVOXSDK_DLLEXPORT int vx_req_connector_initiate_shutdown_create(    vx_req_connector_initiate_shutdown_t ** req)

Allocate and initialize a vx_req_connector_initiate_shutdown object.

function vx_req_account_login_create


VIVOXSDK_DLLEXPORT int vx_req_account_login_create(    vx_req_account_login_t ** req)

Allocate and initialize a vx_req_account_login object.

function vx_req_account_authtoken_login_create


VIVOXSDK_DLLEXPORT int vx_req_account_authtoken_login_create(    vx_req_account_authtoken_login_t ** req)

Allocate and initialize a vx_req_account_authtoken_login object.

function vx_req_account_anonymous_login_create


VIVOXSDK_DLLEXPORT int vx_req_account_anonymous_login_create(    vx_req_account_anonymous_login_t ** req)

Allocate and initialize a vx_req_account_anonymous_login object.

function vx_req_account_logout_create


VIVOXSDK_DLLEXPORT int vx_req_account_logout_create(    vx_req_account_logout_t ** req)

Allocate and initialize a vx_req_account_logout object.

function vx_req_account_set_login_properties_create


VIVOXSDK_DLLEXPORT int vx_req_account_set_login_properties_create(    vx_req_account_set_login_properties_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_account_set_login_properties object.

function vx_req_sessiongroup_create_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_create_create(    vx_req_sessiongroup_create_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_sessiongroup_create object.

function vx_req_sessiongroup_terminate_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_terminate_create(    vx_req_sessiongroup_terminate_t ** req)

Allocate and initialize a vx_req_sessiongroup_terminate object.

function vx_req_sessiongroup_add_session_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_add_session_create(    vx_req_sessiongroup_add_session_t ** req)

Allocate and initialize a vx_req_sessiongroup_add_session object.

function vx_req_sessiongroup_remove_session_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_remove_session_create(    vx_req_sessiongroup_remove_session_t ** req)

Allocate and initialize a vx_req_sessiongroup_remove_session object.

function vx_req_sessiongroup_set_focus_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_focus_create(    vx_req_sessiongroup_set_focus_t ** req)

Allocate and initialize a vx_req_sessiongroup_set_focus object.

function vx_req_sessiongroup_unset_focus_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_unset_focus_create(    vx_req_sessiongroup_unset_focus_t ** req)

Allocate and initialize a vx_req_sessiongroup_unset_focus object.

function vx_req_sessiongroup_reset_focus_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_reset_focus_create(    vx_req_sessiongroup_reset_focus_t ** req)

Allocate and initialize a vx_req_sessiongroup_reset_focus object.

function vx_req_sessiongroup_set_tx_session_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_tx_session_create(    vx_req_sessiongroup_set_tx_session_t ** req)

Allocate and initialize a vx_req_sessiongroup_set_tx_session object.

function vx_req_sessiongroup_set_tx_all_sessions_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_tx_all_sessions_create(    vx_req_sessiongroup_set_tx_all_sessions_t ** req)

Allocate and initialize a vx_req_sessiongroup_set_tx_all_sessions object.

function vx_req_sessiongroup_set_tx_no_session_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_tx_no_session_create(    vx_req_sessiongroup_set_tx_no_session_t ** req)

Allocate and initialize a vx_req_sessiongroup_set_tx_no_session object.

function vx_req_sessiongroup_set_session_3d_position_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_session_3d_position_create(    vx_req_sessiongroup_set_session_3d_position_t ** req)

Allocate and initialize a vx_req_sessiongroup_set_session_3d_position object.

function vx_req_sessiongroup_control_audio_injection_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_control_audio_injection_create(    vx_req_sessiongroup_control_audio_injection_t ** req)

Allocate and initialize a vx_req_sessiongroup_control_audio_injection object.

function vx_req_session_create_create


VIVOXSDK_DLLEXPORT int vx_req_session_create_create(    vx_req_session_create_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_session_create object.

function vx_req_session_media_connect_create


VIVOXSDK_DLLEXPORT int vx_req_session_media_connect_create(    vx_req_session_media_connect_t ** req)

Allocate and initialize a vx_req_session_media_connect object.

function vx_req_session_media_disconnect_create


VIVOXSDK_DLLEXPORT int vx_req_session_media_disconnect_create(    vx_req_session_media_disconnect_t ** req)

Allocate and initialize a vx_req_session_media_disconnect object.

function vx_req_session_text_connect_create


VIVOXSDK_DLLEXPORT int vx_req_session_text_connect_create(    vx_req_session_text_connect_t ** req)

Allocate and initialize a vx_req_session_text_connect object.

function vx_req_session_text_disconnect_create


VIVOXSDK_DLLEXPORT int vx_req_session_text_disconnect_create(    vx_req_session_text_disconnect_t ** req)

Allocate and initialize a vx_req_session_text_disconnect object.

function vx_req_session_terminate_create


VIVOXSDK_DLLEXPORT int vx_req_session_terminate_create(    vx_req_session_terminate_t ** req)

Allocate and initialize a vx_req_session_terminate object.

function vx_req_session_mute_local_speaker_create


VIVOXSDK_DLLEXPORT int vx_req_session_mute_local_speaker_create(    vx_req_session_mute_local_speaker_t ** req)

Allocate and initialize a vx_req_session_mute_local_speaker object.

function vx_req_session_set_local_render_volume_create


VIVOXSDK_DLLEXPORT int vx_req_session_set_local_render_volume_create(    vx_req_session_set_local_render_volume_t ** req)

Allocate and initialize a vx_req_session_set_local_render_volume object.

function vx_req_session_set_local_speaker_volume_create


VIVOXSDK_DLLEXPORT int vx_req_session_set_local_speaker_volume_create(    vx_req_session_set_local_speaker_volume_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_session_set_local_speaker_volume object.

function vx_req_session_channel_invite_user_create


VIVOXSDK_DLLEXPORT int vx_req_session_channel_invite_user_create(    vx_req_session_channel_invite_user_t ** req)

Create a vx_req_session_channel_invite_user_t request.

function vx_req_session_set_participant_volume_for_me_create


VIVOXSDK_DLLEXPORT int vx_req_session_set_participant_volume_for_me_create(    vx_req_session_set_participant_volume_for_me_t ** req)

Allocate and initialize a vx_req_session_set_participant_volume_for_me object.

function vx_req_session_set_participant_mute_for_me_create


VIVOXSDK_DLLEXPORT int vx_req_session_set_participant_mute_for_me_create(    vx_req_session_set_participant_mute_for_me_t ** req)

Allocate and initialize a vx_req_session_set_participant_mute_for_me object.

function vx_req_session_set_3d_position_create


VIVOXSDK_DLLEXPORT int vx_req_session_set_3d_position_create(    vx_req_session_set_3d_position_t ** req)

Allocate and initialize a vx_req_session_set_3d_position object.

function vx_req_session_set_voice_font_create


VIVOXSDK_DLLEXPORT int vx_req_session_set_voice_font_create(    vx_req_session_set_voice_font_t ** req)

Allocate and initialize a vx_req_session_set_voice_font object.

function vx_req_account_channel_change_owner_create


VIVOXSDK_DLLEXPORT int vx_req_account_channel_change_owner_create(    vx_req_account_channel_change_owner_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_account_channel_change_owner object.

function vx_req_account_send_user_app_data_create


VIVOXSDK_DLLEXPORT int vx_req_account_send_user_app_data_create(    vx_req_account_send_user_app_data_t ** req)

Allocate and initialize a vx_req_account_send_user_app_data object.

function vx_req_account_channel_add_acl_create


VIVOXSDK_DLLEXPORT int vx_req_account_channel_add_acl_create(    vx_req_account_channel_add_acl_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_account_channel_add_acl object.

function vx_req_account_channel_remove_acl_create


VIVOXSDK_DLLEXPORT int vx_req_account_channel_remove_acl_create(    vx_req_account_channel_remove_acl_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_account_channel_remove_acl object.

function vx_req_account_channel_get_acl_create


VIVOXSDK_DLLEXPORT int vx_req_account_channel_get_acl_create(    vx_req_account_channel_get_acl_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_account_channel_get_acl object.

function vx_req_channel_mute_user_create


VIVOXSDK_DLLEXPORT int vx_req_channel_mute_user_create(    vx_req_channel_mute_user_t ** req)

Allocate and initialize a vx_req_channel_mute_user object.

function vx_req_channel_ban_user_create


VIVOXSDK_DLLEXPORT int vx_req_channel_ban_user_create(    vx_req_channel_ban_user_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_channel_ban_user object.

function vx_req_channel_get_banned_users_create


VIVOXSDK_DLLEXPORT int vx_req_channel_get_banned_users_create(    vx_req_channel_get_banned_users_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_channel_get_banned_users object.

function vx_req_channel_kick_user_create


VIVOXSDK_DLLEXPORT int vx_req_channel_kick_user_create(    vx_req_channel_kick_user_t ** req)

Allocate and initialize a vx_req_channel_kick_user object.

function vx_req_channel_mute_all_users_create


VIVOXSDK_DLLEXPORT int vx_req_channel_mute_all_users_create(    vx_req_channel_mute_all_users_t ** req)

Allocate and initialize a vx_req_channel_mute_all_users object.

function vx_req_channel_set_lock_mode_create


VIVOXSDK_DLLEXPORT int vx_req_channel_set_lock_mode_create(    vx_req_channel_set_lock_mode_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_channel_set_lock_mode object.

function vx_req_connector_mute_local_mic_create


VIVOXSDK_DLLEXPORT int vx_req_connector_mute_local_mic_create(    vx_req_connector_mute_local_mic_t ** req)

Allocate and initialize a vx_req_connector_mute_local_mic object.

function vx_req_connector_mute_local_speaker_create


VIVOXSDK_DLLEXPORT int vx_req_connector_mute_local_speaker_create(    vx_req_connector_mute_local_speaker_t ** req)

Allocate and initialize a vx_req_connector_mute_local_speaker object.

function vx_req_connector_set_local_mic_volume_create


VIVOXSDK_DLLEXPORT int vx_req_connector_set_local_mic_volume_create(    vx_req_connector_set_local_mic_volume_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_connector_set_local_mic_volume object.

function vx_req_connector_set_local_speaker_volume_create


VIVOXSDK_DLLEXPORT int vx_req_connector_set_local_speaker_volume_create(    vx_req_connector_set_local_speaker_volume_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_connector_set_local_speaker_volume object.

function vx_req_connector_get_local_audio_info_create


VIVOXSDK_DLLEXPORT int vx_req_connector_get_local_audio_info_create(    vx_req_connector_get_local_audio_info_t ** req)

Allocate and initialize a vx_req_connector_get_local_audio_info object.

function vx_req_account_buddy_set_create


VIVOXSDK_DLLEXPORT int vx_req_account_buddy_set_create(    vx_req_account_buddy_set_t ** req)

Allocate and initialize a vx_req_account_buddy_set object.

function vx_req_account_buddy_delete_create


VIVOXSDK_DLLEXPORT int vx_req_account_buddy_delete_create(    vx_req_account_buddy_delete_t ** req)

Allocate and initialize a vx_req_account_buddy_delete object.

function vx_req_account_list_buddies_and_groups_create


VIVOXSDK_DLLEXPORT int vx_req_account_list_buddies_and_groups_create(    vx_req_account_list_buddies_and_groups_t ** req)

Allocate and initialize a vx_req_account_list_buddies_and_groups object.

function vx_req_session_send_message_create


VIVOXSDK_DLLEXPORT int vx_req_session_send_message_create(    vx_req_session_send_message_t ** req)

Allocate and initialize a vx_req_session_send_message object.

function vx_req_session_delete_message_create


VIVOXSDK_DLLEXPORT int vx_req_session_delete_message_create(    vx_req_session_delete_message_t ** req)

Allocate and initialize a vx_req_session_delete_message object.

function vx_req_session_edit_message_create


VIVOXSDK_DLLEXPORT int vx_req_session_edit_message_create(    vx_req_session_edit_message_t ** req)

Allocate and initialize a vx_req_session_edit_message object.

function vx_req_session_archive_query_create


VIVOXSDK_DLLEXPORT int vx_req_session_archive_query_create(    vx_req_session_archive_query_t ** req)

Allocate and initialize a vx_req_session_archive_query object.

function vx_req_session_chat_history_query_create


VIVOXSDK_DLLEXPORT int vx_req_session_chat_history_query_create(    vx_req_session_chat_history_query_t ** req)

Allocate and initialize a vx_req_session_chat_history_query object.

function vx_req_account_chat_history_get_last_read_create


VIVOXSDK_DLLEXPORT int vx_req_account_chat_history_get_last_read_create(    vx_req_account_chat_history_get_last_read_t ** req)

Allocate and initialize a vx_req_account_chat_history_get_last_read object.

function vx_req_account_set_presence_create


VIVOXSDK_DLLEXPORT int vx_req_account_set_presence_create(    vx_req_account_set_presence_t ** req)

Allocate and initialize a vx_req_account_set_presence object.

function vx_req_account_send_subscription_reply_create


VIVOXSDK_DLLEXPORT int vx_req_account_send_subscription_reply_create(    vx_req_account_send_subscription_reply_t ** req)

Allocate and initialize a vx_req_account_send_subscription_reply object.

function vx_req_session_send_notification_create


VIVOXSDK_DLLEXPORT int vx_req_session_send_notification_create(    vx_req_session_send_notification_t ** req)

Allocate and initialize a vx_req_session_send_notification object.

function vx_req_session_send_dtmf_create


VIVOXSDK_DLLEXPORT int vx_req_session_send_dtmf_create(    vx_req_session_send_dtmf_t ** req)

Deprecated: This is deprecated and should not be used. Allocate and initialize a vx_req_session_send_dtmf object.

function vx_req_account_create_block_rule_create


VIVOXSDK_DLLEXPORT int vx_req_account_create_block_rule_create(    vx_req_account_create_block_rule_t ** req)

Allocate and initialize a vx_req_account_create_block_rule object.

function vx_req_account_delete_block_rule_create


VIVOXSDK_DLLEXPORT int vx_req_account_delete_block_rule_create(    vx_req_account_delete_block_rule_t ** req)

Allocate and initialize a vx_req_account_delete_block_rule object.

function vx_req_account_list_block_rules_create


VIVOXSDK_DLLEXPORT int vx_req_account_list_block_rules_create(    vx_req_account_list_block_rules_t ** req)

Allocate and initialize a vx_req_account_list_block_rules object.

function vx_req_account_create_auto_accept_rule_create


VIVOXSDK_DLLEXPORT int vx_req_account_create_auto_accept_rule_create(    vx_req_account_create_auto_accept_rule_t ** req)

Allocate and initialize a vx_req_account_create_auto_accept_rule object.

function vx_req_account_delete_auto_accept_rule_create


VIVOXSDK_DLLEXPORT int vx_req_account_delete_auto_accept_rule_create(    vx_req_account_delete_auto_accept_rule_t ** req)

Allocate and initialize a vx_req_account_delete_auto_accept_rule object.

function vx_req_account_list_auto_accept_rules_create


VIVOXSDK_DLLEXPORT int vx_req_account_list_auto_accept_rules_create(    vx_req_account_list_auto_accept_rules_t ** req)

Allocate and initialize a vx_req_account_list_auto_accept_rules object.

function vx_req_account_update_account_create


VIVOXSDK_DLLEXPORT int vx_req_account_update_account_create(    vx_req_account_update_account_t ** req)

Allocate and initialize a vx_req_account_update_account object.

function vx_req_account_get_account_create


VIVOXSDK_DLLEXPORT int vx_req_account_get_account_create(    vx_req_account_get_account_t ** req)

Allocate and initialize a vx_req_account_get_account object.

function vx_req_account_send_sms_create


VIVOXSDK_DLLEXPORT int vx_req_account_send_sms_create(    vx_req_account_send_sms_t ** req)

Allocate and initialize a vx_req_account_send_sms object.

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_aux_get_render_devices_create


VIVOXSDK_DLLEXPORT int vx_req_aux_get_render_devices_create(    vx_req_aux_get_render_devices_t ** req)

Allocate and initialize a vx_req_aux_get_render_devices object.

function vx_req_aux_get_capture_devices_create


VIVOXSDK_DLLEXPORT int vx_req_aux_get_capture_devices_create(    vx_req_aux_get_capture_devices_t ** req)

Allocate and initialize a vx_req_aux_get_render_devices object.

function vx_req_aux_set_render_device_create


VIVOXSDK_DLLEXPORT int vx_req_aux_set_render_device_create(    vx_req_aux_set_render_device_t ** req)

Allocate and initialize a vx_req_aux_set_render_device object.

function vx_req_aux_set_capture_device_create


VIVOXSDK_DLLEXPORT int vx_req_aux_set_capture_device_create(    vx_req_aux_set_capture_device_t ** req)

Allocate and initialize a vx_req_aux_set_capture_device object.

function vx_req_aux_get_mic_level_create


VIVOXSDK_DLLEXPORT int vx_req_aux_get_mic_level_create(    vx_req_aux_get_mic_level_t ** req)

Allocate and initialize a vx_req_aux_get_mic_level object.

function vx_req_aux_get_speaker_level_create


VIVOXSDK_DLLEXPORT int vx_req_aux_get_speaker_level_create(    vx_req_aux_get_speaker_level_t ** req)

Allocate and initialize a vx_req_aux_get_speaker_level object.

function vx_req_aux_set_mic_level_create


VIVOXSDK_DLLEXPORT int vx_req_aux_set_mic_level_create(    vx_req_aux_set_mic_level_t ** req)

Allocate and initialize a vx_req_aux_set_mic_level object.

function vx_req_aux_set_speaker_level_create


VIVOXSDK_DLLEXPORT int vx_req_aux_set_speaker_level_create(    vx_req_aux_set_speaker_level_t ** req)

Allocate and initialize a vx_req_aux_set_speaker_level object.

function vx_req_aux_render_audio_start_create


VIVOXSDK_DLLEXPORT int vx_req_aux_render_audio_start_create(    vx_req_aux_render_audio_start_t ** req)

Allocate and initialize a vx_req_aux_render_audio_start object.

function vx_req_aux_render_audio_modify_create


VIVOXSDK_DLLEXPORT int vx_req_aux_render_audio_modify_create(    vx_req_aux_render_audio_modify_t ** req)

Allocate and initialize a vx_req_aux_render_audio_modify object.

function vx_req_aux_get_vad_properties_create


VIVOXSDK_DLLEXPORT int vx_req_aux_get_vad_properties_create(    vx_req_aux_get_vad_properties_t ** req)

Allocate and initialize a vx_req_aux_get_vad_properties object.

function vx_req_aux_set_vad_properties_create


VIVOXSDK_DLLEXPORT int vx_req_aux_set_vad_properties_create(    vx_req_aux_set_vad_properties_t ** req)

Allocate and initialize a vx_req_aux_set_vad_properties object.

function vx_req_aux_get_derumbler_properties_create


VIVOXSDK_DLLEXPORT int vx_req_aux_get_derumbler_properties_create(    vx_req_aux_get_derumbler_properties_t ** req)

Allocate and initialize a vx_req_aux_get_derumbler_properties object.

function vx_req_aux_set_derumbler_properties_create


VIVOXSDK_DLLEXPORT int vx_req_aux_set_derumbler_properties_create(    vx_req_aux_set_derumbler_properties_t ** req)

Allocate and initialize a vx_req_aux_set_derumbler_properties object.

function vx_req_aux_render_audio_stop_create


VIVOXSDK_DLLEXPORT int vx_req_aux_render_audio_stop_create(    vx_req_aux_render_audio_stop_t ** req)

Allocate and initialize a vx_req_aux_render_audio_stop object.

function vx_req_aux_capture_audio_start_create


VIVOXSDK_DLLEXPORT int vx_req_aux_capture_audio_start_create(    vx_req_aux_capture_audio_start_t ** req)

Allocate and initialize a vx_req_aux_capture_audio_start object.

function vx_req_aux_capture_audio_stop_create


VIVOXSDK_DLLEXPORT int vx_req_aux_capture_audio_stop_create(    vx_req_aux_capture_audio_stop_t ** req)

Allocate and initialize a vx_req_aux_capture_audio_stop object.

function vx_req_account_get_session_fonts_create


VIVOXSDK_DLLEXPORT int vx_req_account_get_session_fonts_create(    vx_req_account_get_session_fonts_t ** req)

Allocate and initialize a vx_req_account_get_session_fonts object.

function vx_req_account_get_template_fonts_create


VIVOXSDK_DLLEXPORT int vx_req_account_get_template_fonts_create(    vx_req_account_get_template_fonts_t ** req)

Allocate and initialize a vx_req_account_get_template_fonts object.

function vx_req_aux_start_buffer_capture_create


VIVOXSDK_DLLEXPORT int vx_req_aux_start_buffer_capture_create(    vx_req_aux_start_buffer_capture_t ** req)

Allocate and initialize a vx_req_aux_start_buffer_capture object.

function vx_req_aux_play_audio_buffer_create


VIVOXSDK_DLLEXPORT int vx_req_aux_play_audio_buffer_create(    vx_req_aux_play_audio_buffer_t ** req)

Allocate and initialize a vx_req_aux_play_audio_buffer object.

function vx_req_aux_global_monitor_keyboard_mouse_create


VIVOXSDK_DLLEXPORT int vx_req_aux_global_monitor_keyboard_mouse_create(    vx_req_aux_global_monitor_keyboard_mouse_t ** req)

Allocate and initialize a vx_req_aux_global_monitor_keyboard_mouse object. Attention: This is not supported on the iPhone platform.

function vx_req_aux_set_idle_timeout_create


VIVOXSDK_DLLEXPORT int vx_req_aux_set_idle_timeout_create(    vx_req_aux_set_idle_timeout_t ** req)

Allocate and initialize a vx_req_aux_set_idle_timeout object. Attention: This is not supported on the iPhone platform.

function vx_req_aux_create_account_create


VIVOXSDK_DLLEXPORT int vx_req_aux_create_account_create(    vx_req_aux_create_account_t ** req)

Allocate and initialize a vx_req_aux_create_account object. Attention: This is not supported on the iPhone platform.

function vx_req_aux_reactivate_account_create


VIVOXSDK_DLLEXPORT int vx_req_aux_reactivate_account_create(    vx_req_aux_reactivate_account_t ** req)

Allocate and initialize a vx_req_aux_create_account object. Attention: This is not supported on the iPhone platform.

function vx_req_aux_deactivate_account_create


VIVOXSDK_DLLEXPORT int vx_req_aux_deactivate_account_create(    vx_req_aux_deactivate_account_t ** req)

Allocate and initialize a vx_req_aux_create_account object. Attention: This is not supported on the iPhone platform.

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_req_aux_reset_password_create


VIVOXSDK_DLLEXPORT int vx_req_aux_reset_password_create(    vx_req_aux_reset_password_t ** req)

Allocate and initialize a vx_req_aux_reset_password object.

function vx_req_aux_diagnostic_state_dump_create


VIVOXSDK_DLLEXPORT int vx_req_aux_diagnostic_state_dump_create(    vx_req_aux_diagnostic_state_dump_t ** req)

Allocate and initialize a vx_req_aux_diagnostic_state_dump object. Attention: This is not supported on the iPhone platform.

function vx_req_account_web_call_create


VIVOXSDK_DLLEXPORT int vx_req_account_web_call_create(    vx_req_account_web_call_t ** req)

Allocate and initialize a vx_req_account_web_call object.

function vx_req_sessiongroup_get_stats_create


VIVOXSDK_DLLEXPORT int vx_req_sessiongroup_get_stats_create(    vx_req_sessiongroup_get_stats_t ** req)

Allocate and initialize a vx_req_sessiongroup_get_stats object.

function vx_req_account_send_message_create


VIVOXSDK_DLLEXPORT int vx_req_account_send_message_create(    vx_req_account_send_message_t ** req)

Allocate and initialize a vx_req_session_send_message object.

function vx_req_account_delete_message_create


VIVOXSDK_DLLEXPORT int vx_req_account_delete_message_create(    vx_req_account_delete_message_t ** req)

Allocate and initialize a vx_req_account_delete_message object.

function vx_req_account_edit_message_create


VIVOXSDK_DLLEXPORT int vx_req_account_edit_message_create(    vx_req_account_edit_message_t ** req)

Allocate and initialize a vx_req_account_edit_message object.

function vx_req_account_archive_query_create


VIVOXSDK_DLLEXPORT int vx_req_account_archive_query_create(    vx_req_account_archive_query_t ** req)

Allocate and initialize a vx_req_account_archive_query object.

function vx_req_account_chat_history_query_create


VIVOXSDK_DLLEXPORT int vx_req_account_chat_history_query_create(    vx_req_account_chat_history_query_t ** req)

Allocate and initialize a vx_req_account_chat_history_query object.

function vx_req_account_get_conversations_create


VIVOXSDK_DLLEXPORT int vx_req_account_get_conversations_create(    vx_req_account_get_conversations_t ** req)

Allocate and initialize a vx_req_account_req_conversations object.

function vx_req_account_chat_history_set_marker_create


VIVOXSDK_DLLEXPORT int vx_req_account_chat_history_set_marker_create(    vx_req_account_chat_history_set_marker_t ** req)

Allocate and initialize a vx_req_account_chat_history_set_marker object.

function vx_req_aux_notify_application_state_change_create


VIVOXSDK_DLLEXPORT int vx_req_aux_notify_application_state_change_create(    vx_req_aux_notify_application_state_change_t ** req)

Allocate and initialize a vx_req_aux_notify_application_state_change object.

function vx_req_account_control_communications_create


VIVOXSDK_DLLEXPORT int vx_req_account_control_communications_create(    vx_req_account_control_communications_t ** req)

Allocate and initialize a vx_req_account_control_communications object.

function vx_req_session_transcription_control_create


VIVOXSDK_DLLEXPORT int vx_req_session_transcription_control_create(    vx_req_session_transcription_control_t ** req)

Allocate and initialize a vx_req_session_transcription_control object.

function destroy_req


VIVOXSDK_DLLEXPORT int destroy_req(    vx_req_base_t * pCmd)

Destroy a request of any type.

function vx_req_account_safe_voice_update_consent_create


VIVOXSDK_DLLEXPORT int vx_req_account_safe_voice_update_consent_create(    vx_req_account_safe_voice_update_consent_t ** req)

Allocate and initialize a vx_req_account_mint_login_token object.

function vx_req_account_safe_voice_get_consent_create


VIVOXSDK_DLLEXPORT int vx_req_account_safe_voice_get_consent_create(    vx_req_account_safe_voice_get_consent_t ** req)

Allocate and initialize a vx_req_account_mint_login_token object.

Macros Documentation

define MAX_CHANNEL_URI_LENGTH


#define MAX_CHANNEL_URI_LENGTH 1024

The maximum length of the session URI.

Source code


/* Copyright (c) 2019 Unity Technologies. * * This software is subject to, and made available under, the Unity Terms of Service (see Unity Terms of Service). * Your use of this software constitutes your acceptance of such terms. * Unless expressly provided otherwise, the software under this license is made available strictly on an "AS IS" BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. * Please review the Terms of Service for details on these and other terms and conditions.” */#pragma once#include <Vxc.h>#pragma pack(push)#pragma pack(8)#ifdef __cplusplusextern "C" {#endif/* The Vivox request structs. * All of these structs begin with a vx_req (request), which is used for identification purposes. */#define MAX_CHANNEL_URI_LENGTH 1024typedef struct vx_req_connector_create {    vx_req_base_t base;    char *client_name;    char *acct_mgmt_server;    int minimum_port;    int maximum_port;    vx_attempt_stun attempt_stun;    vx_connector_mode mode;    char *log_folder;    char *log_filename_prefix;    char *log_filename_suffix;    int log_level;    vx_session_handle_type session_handle_type;    char *application;    int max_calls;    int allow_cross_domain_logins;    int default_codec;    char *user_agent_id;    char *media_probe_server;    char *http_proxy_server_name;    int http_proxy_server_port;    int enable_duplicate_participant_uris;    char *connector_handle;    unsigned int configured_codecs;} vx_req_connector_create_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_connector_create_create(vx_req_connector_create_t **req);#endiftypedef struct vx_req_connector_initiate_shutdown {    vx_req_base_t base;    VX_HANDLE connector_handle;    char *client_name;} vx_req_connector_initiate_shutdown_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_connector_initiate_shutdown_create(vx_req_connector_initiate_shutdown_t **req);#endiftypedef struct vx_req_account_login {    vx_req_base_t base;    VX_HANDLE connector_handle;    char *acct_name;    char *acct_password;    vx_session_answer_mode answer_mode;    vx_text_mode enable_text;    int participant_property_frequency;    int enable_buddies_and_presence;    vx_buddy_management_mode buddy_management_mode;    int enable_client_ringback;    int autopost_crash_dumps;    char *acct_mgmt_server;    char *application_token;    char *application_override;    char *client_ip_override;    int enable_presence_persistence;    char *account_handle;} vx_req_account_login_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_login_create(vx_req_account_login_t **req);#endiftypedef struct vx_req_account_authtoken_login {    vx_req_base_t base;    VX_HANDLE connector_handle;    char *authtoken;    vx_text_mode enable_text;    int participant_property_frequency;    int enable_buddies_and_presence;    vx_buddy_management_mode buddy_management_mode;    int autopost_crash_dumps;    char *acct_mgmt_server;    char *application_token;    char *application_override;    vx_session_answer_mode answer_mode;    char *client_ip_override;    int enable_presence_persistence;    char *account_handle;} vx_req_account_authtoken_login_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_authtoken_login_create(vx_req_account_authtoken_login_t **req);#endiftypedef struct vx_req_account_anonymous_login {    vx_req_base_t base;    VX_HANDLE connector_handle;    char *displayname;    int participant_property_frequency;    int enable_buddies_and_presence;    vx_buddy_management_mode buddy_management_mode;    int autopost_crash_dumps;    char *acct_mgmt_server;    char *application_token;    char *application_override;    char *client_ip_override;    int enable_presence_persistence;    char *account_handle;    char *acct_name;    char *access_token;    char **initial_buddy_uris;    char **initial_blocked_uris;    char **initial_blocked_uris_presence_only;    char **initial_allowed_uris;    char *languages;} vx_req_account_anonymous_login_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_anonymous_login_create(vx_req_account_anonymous_login_t **req);#endiftypedef struct vx_req_account_logout {    vx_req_base_t base;    VX_HANDLE account_handle;    char *logout_reason;} vx_req_account_logout_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_logout_create(vx_req_account_logout_t **req);#endiftypedef struct vx_req_account_set_login_properties {    vx_req_base_t base;    VX_HANDLE account_handle;    vx_session_answer_mode answer_mode;    int participant_property_frequency;} vx_req_account_set_login_properties_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_set_login_properties_create(vx_req_account_set_login_properties_t **req);#endiftypedef enum {    password_hash_algorithm_cleartext = 0,    password_hash_algorithm_sha1_username_hash = 1} vx_password_hash_algorithm_t;typedef struct vx_req_sessiongroup_create {    vx_req_base_t base;    VX_HANDLE account_handle;    vx_sessiongroup_type type;    int loop_mode_duration_seconds;    char *capture_device_id;    char *render_device_id;    char *alias_username;    char *sessiongroup_handle;} vx_req_sessiongroup_create_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_create_create(vx_req_sessiongroup_create_t **req);#endiftypedef struct vx_req_sessiongroup_terminate {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;} vx_req_sessiongroup_terminate_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_terminate_create(vx_req_sessiongroup_terminate_t **req);#endiftypedef struct vx_req_sessiongroup_add_session {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;    char *uri;    char *name;    char *password;    int connect_audio;    vx_password_hash_algorithm_t password_hash_algorithm;    int session_font_id;    int connect_text;    int jitter_compensation;    char *session_handle;    char *access_token;    VX_HANDLE account_handle;} vx_req_sessiongroup_add_session_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_add_session_create(vx_req_sessiongroup_add_session_t **req);#endiftypedef struct vx_req_sessiongroup_remove_session {    vx_req_base_t base;    VX_HANDLE session_handle;    VX_HANDLE sessiongroup_handle;} vx_req_sessiongroup_remove_session_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_remove_session_create(vx_req_sessiongroup_remove_session_t **req);#endiftypedef struct vx_req_sessiongroup_set_focus {    vx_req_base_t base;    VX_HANDLE session_handle;    VX_HANDLE sessiongroup_handle;} vx_req_sessiongroup_set_focus_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_focus_create(vx_req_sessiongroup_set_focus_t **req);#endiftypedef struct vx_req_sessiongroup_unset_focus {    vx_req_base_t base;    VX_HANDLE session_handle;    VX_HANDLE sessiongroup_handle;} vx_req_sessiongroup_unset_focus_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_unset_focus_create(vx_req_sessiongroup_unset_focus_t **req);#endiftypedef struct vx_req_sessiongroup_reset_focus {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;} vx_req_sessiongroup_reset_focus_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_reset_focus_create(vx_req_sessiongroup_reset_focus_t **req);#endiftypedef struct vx_req_sessiongroup_set_tx_session {    vx_req_base_t base;    VX_HANDLE session_handle;    VX_HANDLE sessiongroup_handle;} vx_req_sessiongroup_set_tx_session_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_tx_session_create(vx_req_sessiongroup_set_tx_session_t **req);#endiftypedef struct vx_req_sessiongroup_set_tx_all_sessions {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;} vx_req_sessiongroup_set_tx_all_sessions_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_tx_all_sessions_create(vx_req_sessiongroup_set_tx_all_sessions_t **req);#endiftypedef struct vx_req_sessiongroup_set_tx_no_session {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;} vx_req_sessiongroup_set_tx_no_session_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_tx_no_session_create(vx_req_sessiongroup_set_tx_no_session_t **req);#endiftypedef struct vx_req_sessiongroup_set_session_3d_position {    vx_req_base_t base;    VX_HANDLE session_handle;    VX_HANDLE sessiongroup_handle;    double speaker_position[3];  // {x, y, z}    double speaker_at_orientation[3];  // {x, y, z}} vx_req_sessiongroup_set_session_3d_position_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_set_session_3d_position_create(vx_req_sessiongroup_set_session_3d_position_t **req);#endiftypedef struct vx_req_sessiongroup_control_audio_injection {    vx_req_base_t base;    vx_sessiongroup_audio_injection_control_type audio_injection_control_type;    VX_HANDLE sessiongroup_handle;    char *filename;} vx_req_sessiongroup_control_audio_injection_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_control_audio_injection_create(vx_req_sessiongroup_control_audio_injection_t **req);#endiftypedef struct vx_req_session_create {    vx_req_base_t base;    VX_HANDLE account_handle;    char *name;    char *uri;    char *password;    int connect_audio;    int join_audio;    int join_text;    vx_password_hash_algorithm_t password_hash_algorithm;    int connect_text;    int session_font_id;    int jitter_compensation;    char *alias_username;    char *sessiongroup_handle;    char *session_handle;    char *access_token;} vx_req_session_create_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_create_create(vx_req_session_create_t **req);#endiftypedef struct vx_req_session_media_connect {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;    VX_HANDLE session_handle;    int session_font_id;    vx_media_type media;    char *capture_device_id;    char *render_device_id;    int jitter_compensation;    int loop_mode_duration_seconds;} vx_req_session_media_connect_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_media_connect_create(vx_req_session_media_connect_t **req);#endiftypedef struct vx_req_session_media_disconnect {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;    VX_HANDLE session_handle;    vx_media_type media;    vx_termination_status termination_status;} vx_req_session_media_disconnect_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_media_disconnect_create(vx_req_session_media_disconnect_t **req);#endiftypedef struct vx_req_session_text_connect {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;    VX_HANDLE session_handle;} vx_req_session_text_connect_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_text_connect_create(vx_req_session_text_connect_t **req);#endiftypedef struct vx_req_session_text_disconnect {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;    VX_HANDLE session_handle;} vx_req_session_text_disconnect_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_text_disconnect_create(vx_req_session_text_disconnect_t **req);#endiftypedef struct vx_req_session_terminate {    vx_req_base_t base;    VX_HANDLE session_handle;} vx_req_session_terminate_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_terminate_create(vx_req_session_terminate_t **req);#endiftypedef struct vx_req_session_mute_local_speaker {    vx_req_base_t base;    VX_HANDLE session_handle;    int mute_level;    vx_mute_scope scope;} vx_req_session_mute_local_speaker_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_mute_local_speaker_create(vx_req_session_mute_local_speaker_t **req);#endiftypedef struct vx_req_session_set_local_render_volume {    vx_req_base_t base;    VX_HANDLE session_handle;    int volume;} vx_req_session_set_local_render_volume_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_set_local_render_volume_create(vx_req_session_set_local_render_volume_t **req);#endiftypedef struct vx_req_session_set_local_speaker_volume {    vx_req_base_t base;    VX_HANDLE session_handle;    int volume;} vx_req_session_set_local_speaker_volume_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_set_local_speaker_volume_create(vx_req_session_set_local_speaker_volume_t **req);#endiftypedef struct vx_req_session_channel_invite_user {    vx_req_base_t base;    VX_HANDLE session_handle;    char *participant_uri;} vx_req_session_channel_invite_user_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_channel_invite_user_create(vx_req_session_channel_invite_user_t **req);#endiftypedef struct vx_req_session_set_participant_volume_for_me {    vx_req_base_t base;    VX_HANDLE session_handle;    char *participant_uri;    int volume;} vx_req_session_set_participant_volume_for_me_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_set_participant_volume_for_me_create(vx_req_session_set_participant_volume_for_me_t **req);#endiftypedef struct vx_req_session_set_participant_mute_for_me {    vx_req_base_t base;    VX_HANDLE session_handle;    char *participant_uri;    int mute;    vx_mute_scope scope;} vx_req_session_set_participant_mute_for_me_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_set_participant_mute_for_me_create(vx_req_session_set_participant_mute_for_me_t **req);#endiftypedef enum {    req_disposition_reply_required,    req_disposition_no_reply_required} req_disposition_type_t;typedef struct vx_req_session_set_3d_position {    vx_req_base_t base;    VX_HANDLE session_handle;    double speaker_position[3];  // {x, y, z}    double speaker_velocity[3];  // {x, y, z}    double speaker_at_orientation[3];  // {x, y, z}    double speaker_up_orientation[3];  // {x, y, z}    double speaker_left_orientation[3];  // {x, y, z}    double listener_position[3];  // {x, y, z}    double listener_velocity[3];  // {x, y, z}    double listener_at_orientation[3];  // {x, y, z}    double listener_up_orientation[3];  // {x, y, z}    double listener_left_orientation[3];  // {x, y, z}    orientation_type type;    req_disposition_type_t req_disposition_type;} vx_req_session_set_3d_position_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_set_3d_position_create(vx_req_session_set_3d_position_t **req);#endiftypedef struct vx_req_session_set_voice_font {    vx_req_base_t base;    VX_HANDLE session_handle;    int session_font_id;} vx_req_session_set_voice_font_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_set_voice_font_create(vx_req_session_set_voice_font_t **req);#endiftypedef struct vx_req_account_channel_change_owner {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_uri;    char *new_owner_uri;} vx_req_account_channel_change_owner_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_channel_change_owner_create(vx_req_account_channel_change_owner_t **req);#endiftypedef struct vx_req_account_send_user_app_data {    vx_req_base_t base;    VX_HANDLE account_handle;    char *to_uri;    char *content_type;    char *content;} vx_req_account_send_user_app_data_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_send_user_app_data_create(vx_req_account_send_user_app_data_t **req);#endiftypedef struct vx_req_account_channel_add_acl {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_uri;    char *acl_uri;} vx_req_account_channel_add_acl_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_channel_add_acl_create(vx_req_account_channel_add_acl_t **req);#endiftypedef struct vx_req_account_channel_remove_acl {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_uri;    char *acl_uri;} vx_req_account_channel_remove_acl_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_channel_remove_acl_create(vx_req_account_channel_remove_acl_t **req);#endiftypedef struct vx_req_account_channel_get_acl {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_uri;} vx_req_account_channel_get_acl_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_channel_get_acl_create(vx_req_account_channel_get_acl_t **req);#endiftypedef struct vx_req_channel_mute_user {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_name;    char *channel_uri;    char *participant_uri;    int set_muted;    vx_mute_scope scope;    char *access_token;} vx_req_channel_mute_user_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_channel_mute_user_create(vx_req_channel_mute_user_t **req);#endiftypedef struct vx_req_channel_ban_user {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_name;    char *channel_uri;    char *participant_uri;    int set_banned;} vx_req_channel_ban_user_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_channel_ban_user_create(vx_req_channel_ban_user_t **req);#endiftypedef struct vx_req_channel_get_banned_users {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_uri;} vx_req_channel_get_banned_users_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_channel_get_banned_users_create(vx_req_channel_get_banned_users_t **req);#endiftypedef struct vx_req_channel_kick_user {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_name;    char *channel_uri;    char *participant_uri;    char *access_token;} vx_req_channel_kick_user_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_channel_kick_user_create(vx_req_channel_kick_user_t **req);#endiftypedef struct vx_req_channel_mute_all_users {    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_name;    char *channel_uri;    int set_muted;    vx_mute_scope scope;    char *access_token;} vx_req_channel_mute_all_users_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_channel_mute_all_users_create(vx_req_channel_mute_all_users_t **req);#endiftypedef struct vx_req_channel_set_lock_mode{    vx_req_base_t base;    VX_HANDLE account_handle;    char *channel_uri;    vx_channel_lock_mode lock_mode;} vx_req_channel_set_lock_mode_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_channel_set_lock_mode_create(vx_req_channel_set_lock_mode_t **req);#endiftypedef struct vx_req_connector_mute_local_mic {    vx_req_base_t base;    VX_HANDLE connector_handle;    int mute_level;    VX_HANDLE account_handle;} vx_req_connector_mute_local_mic_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_connector_mute_local_mic_create(vx_req_connector_mute_local_mic_t **req);#endiftypedef struct vx_req_connector_mute_local_speaker {    vx_req_base_t base;    VX_HANDLE connector_handle;    int mute_level;    VX_HANDLE account_handle;} vx_req_connector_mute_local_speaker_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_connector_mute_local_speaker_create(vx_req_connector_mute_local_speaker_t **req);#endiftypedef struct vx_req_connector_set_local_mic_volume {    vx_req_base_t base;    VX_HANDLE connector_handle;    int volume;    VX_HANDLE account_handle;} vx_req_connector_set_local_mic_volume_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_connector_set_local_mic_volume_create(vx_req_connector_set_local_mic_volume_t **req);#endiftypedef struct vx_req_connector_set_local_speaker_volume {    vx_req_base_t base;    VX_HANDLE connector_handle;    int volume;    VX_HANDLE account_handle;} vx_req_connector_set_local_speaker_volume_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_connector_set_local_speaker_volume_create(vx_req_connector_set_local_speaker_volume_t **req);#endiftypedef struct vx_req_connector_get_local_audio_info {    vx_req_base_t base;    VX_HANDLE connector_handle;    VX_HANDLE account_handle;} vx_req_connector_get_local_audio_info_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_connector_get_local_audio_info_create(vx_req_connector_get_local_audio_info_t **req);#endiftypedef struct vx_req_account_buddy_set {    vx_req_base_t base;    VX_HANDLE account_handle;    char *buddy_uri;    char *display_name;    char *buddy_data;    int group_id;    char *message;} vx_req_account_buddy_set_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_buddy_set_create(vx_req_account_buddy_set_t **req);#endiftypedef struct vx_req_account_buddy_delete {    vx_req_base_t base;    VX_HANDLE account_handle;    char *buddy_uri;} vx_req_account_buddy_delete_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_buddy_delete_create(vx_req_account_buddy_delete_t **req);#endiftypedef struct vx_req_account_list_buddies_and_groups {    vx_req_base_t base;    VX_HANDLE account_handle;    int refresh;} vx_req_account_list_buddies_and_groups_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_list_buddies_and_groups_create(vx_req_account_list_buddies_and_groups_t **req);#endiftypedef struct vx_req_session_send_message {    vx_req_base_t base;    VX_HANDLE session_handle;    char *message_header;    char *message_body;    char *language;    char *application_stanza_namespace;    char *application_stanza_body;} vx_req_session_send_message_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_send_message_create(vx_req_session_send_message_t **req);#endiftypedef struct vx_req_session_delete_message {    vx_req_base_t base;    VX_HANDLE session_handle;    char *message_id;} vx_req_session_delete_message_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_delete_message_create(vx_req_session_delete_message_t **req);#endiftypedef struct vx_req_session_edit_message {    vx_req_base_t base;    VX_HANDLE session_handle;    char *message_id;    char *new_message;    char *language;} vx_req_session_edit_message_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_edit_message_create(vx_req_session_edit_message_t **req);#endif#ifndef DOXYGEN_MAM_SKIPtypedef struct vx_req_session_archive_query {    vx_req_base_t base;    VX_HANDLE session_handle;    char *time_start;    char *time_end;    char *cursor;    char *search_text;    char *participant_uri;    unsigned int max;    char *before_id;    char *after_id;    int first_message_index;    char *display_name;    VX_DEPRECATED(5.21)    char *application_stanza_namespace;    VX_DEPRECATED(5.21)    char *application_stanza_body;} vx_req_session_archive_query_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_archive_query_create(vx_req_session_archive_query_t **req);#endif#endiftypedef struct vx_req_session_chat_history_query {    vx_req_base_t base;    VX_HANDLE session_handle;    char *time_start;    char *time_end;    char *cursor;    char *search_text;    char *display_name;    char *participant_uri;    unsigned int max;    char *before_id;    char *after_id;    int first_message_index;    VX_DEPRECATED(5.21)    char *application_stanza_namespace;    VX_DEPRECATED(5.21)    char *application_stanza_body;} vx_req_session_chat_history_query_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_chat_history_query_create(vx_req_session_chat_history_query_t **req);#endiftypedef struct vx_req_account_chat_history_get_last_read {    vx_req_base_t base;    VX_HANDLE account_handle;    VX_HANDLE session_handle;} vx_req_account_chat_history_get_last_read_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_chat_history_get_last_read_create(vx_req_account_chat_history_get_last_read_t **req);#endiftypedef struct vx_req_account_set_presence {    vx_req_base_t base;    VX_HANDLE account_handle;    vx_buddy_presence_state presence;    char *custom_message;    char *alias_username;} vx_req_account_set_presence_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_set_presence_create(vx_req_account_set_presence_t **req);#endiftypedef struct vx_req_account_send_subscription_reply {    vx_req_base_t base;    VX_HANDLE account_handle;    vx_rule_type rule_type;    int auto_accept;    char *buddy_uri;    char *subscription_handle;} vx_req_account_send_subscription_reply_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_send_subscription_reply_create(vx_req_account_send_subscription_reply_t **req);#endiftypedef struct vx_req_session_send_notification {    vx_req_base_t base;    VX_HANDLE session_handle;    vx_notification_type notification_type;} vx_req_session_send_notification_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_send_notification_create(vx_req_session_send_notification_t **req);#endiftypedef struct vx_req_session_send_dtmf {    vx_req_base_t base;    VX_HANDLE session_handle;    vx_dtmf_type dtmf_type;} vx_req_session_send_dtmf_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_send_dtmf_create(vx_req_session_send_dtmf_t **req);#endiftypedef struct vx_req_account_create_block_rule {    vx_req_base_t base;    VX_HANDLE account_handle;    char *block_mask;    int presence_only;} vx_req_account_create_block_rule_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_create_block_rule_create(vx_req_account_create_block_rule_t **req);#endiftypedef struct vx_req_account_delete_block_rule {    vx_req_base_t base;    VX_HANDLE account_handle;    char *block_mask;} vx_req_account_delete_block_rule_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_delete_block_rule_create(vx_req_account_delete_block_rule_t **req);#endiftypedef struct vx_req_account_list_block_rules {    vx_req_base_t base;    VX_HANDLE account_handle;    int refresh;} vx_req_account_list_block_rules_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_list_block_rules_create(vx_req_account_list_block_rules_t **req);#endiftypedef struct vx_req_account_create_auto_accept_rule {    vx_req_base_t base;    VX_HANDLE account_handle;    char *auto_accept_mask;    int auto_add_as_buddy;    char *auto_accept_nickname;} vx_req_account_create_auto_accept_rule_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_create_auto_accept_rule_create(vx_req_account_create_auto_accept_rule_t **req);#endiftypedef struct vx_req_account_delete_auto_accept_rule {    vx_req_base_t base;    VX_HANDLE account_handle;    char *auto_accept_mask;} vx_req_account_delete_auto_accept_rule_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_delete_auto_accept_rule_create(vx_req_account_delete_auto_accept_rule_t **req);#endiftypedef struct vx_req_account_list_auto_accept_rules {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_account_list_auto_accept_rules_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_list_auto_accept_rules_create(vx_req_account_list_auto_accept_rules_t **req);#endiftypedef struct vx_req_account_update_account {    vx_req_base_t base;    VX_HANDLE account_handle;    char *displayname;} vx_req_account_update_account_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_update_account_create(vx_req_account_update_account_t **req);#endiftypedef struct vx_req_account_get_account {    vx_req_base_t base;    VX_HANDLE account_handle;    char *uri;} vx_req_account_get_account_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_get_account_create(vx_req_account_get_account_t **req);#endiftypedef struct vx_req_account_send_sms {    vx_req_base_t base;    VX_HANDLE account_handle;    char *recipient_uri;    char *content;} vx_req_account_send_sms_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_send_sms_create(vx_req_account_send_sms_t **req);#endiftypedef struct vx_req_aux_connectivity_info {    vx_req_base_t base;    char *well_known_ip;    char *stun_server;    char *echo_server;    int echo_port;    int timeout;    char *acct_mgmt_server;} vx_req_aux_connectivity_info_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_connectivity_info_create(vx_req_aux_connectivity_info_t **req);#endiftypedef struct vx_req_aux_get_render_devices {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_get_render_devices_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_get_render_devices_create(vx_req_aux_get_render_devices_t **req);#endiftypedef struct vx_req_aux_get_capture_devices {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_get_capture_devices_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_get_capture_devices_create(vx_req_aux_get_capture_devices_t **req);#endiftypedef struct vx_req_aux_set_render_device {    vx_req_base_t base;    char *render_device_specifier;    VX_HANDLE account_handle;} vx_req_aux_set_render_device_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_set_render_device_create(vx_req_aux_set_render_device_t **req);#endiftypedef struct vx_req_aux_set_capture_device {    vx_req_base_t base;    char *capture_device_specifier;    VX_HANDLE account_handle;} vx_req_aux_set_capture_device_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_set_capture_device_create(vx_req_aux_set_capture_device_t **req);#endiftypedef struct vx_req_aux_get_mic_level {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_get_mic_level_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_get_mic_level_create(vx_req_aux_get_mic_level_t **req);#endiftypedef struct vx_req_aux_get_speaker_level {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_get_speaker_level_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_get_speaker_level_create(vx_req_aux_get_speaker_level_t **req);#endiftypedef struct vx_req_aux_set_mic_level {    vx_req_base_t base;    int level;    VX_HANDLE account_handle;} vx_req_aux_set_mic_level_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_set_mic_level_create(vx_req_aux_set_mic_level_t **req);#endiftypedef struct vx_req_aux_set_speaker_level {    vx_req_base_t base;    int level;    VX_HANDLE account_handle;} vx_req_aux_set_speaker_level_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_set_speaker_level_create(vx_req_aux_set_speaker_level_t **req);#endiftypedef struct vx_req_aux_render_audio_start {    vx_req_base_t base;    char *sound_file_path;    int loop;    char *path;    VX_HANDLE account_handle;} vx_req_aux_render_audio_start_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_render_audio_start_create(vx_req_aux_render_audio_start_t **req);#endiftypedef struct vx_req_aux_render_audio_modify {    vx_req_base_t base;    char *font_str;    VX_HANDLE account_handle;} vx_req_aux_render_audio_modify_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_render_audio_modify_create(vx_req_aux_render_audio_modify_t **req);#endiftypedef struct vx_req_aux_get_vad_properties {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_get_vad_properties_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_get_vad_properties_create(vx_req_aux_get_vad_properties_t **req);#endiftypedef struct vx_req_aux_set_vad_properties {    vx_req_base_t base;    int vad_hangover;    int vad_sensitivity;    int vad_noise_floor;    int vad_auto;    VX_HANDLE account_handle;} vx_req_aux_set_vad_properties_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_set_vad_properties_create(vx_req_aux_set_vad_properties_t **req);#endiftypedef struct vx_req_aux_get_derumbler_properties {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_get_derumbler_properties_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_get_derumbler_properties_create(vx_req_aux_get_derumbler_properties_t **req);#endiftypedef struct vx_req_aux_set_derumbler_properties {    vx_req_base_t base;    int enabled;    int stopband_corner_frequency;    VX_HANDLE account_handle;} vx_req_aux_set_derumbler_properties_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_set_derumbler_properties_create(vx_req_aux_set_derumbler_properties_t **req);#endiftypedef struct vx_req_aux_render_audio_stop {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_render_audio_stop_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_render_audio_stop_create(vx_req_aux_render_audio_stop_t **req);#endiftypedef struct vx_req_aux_capture_audio_start {    vx_req_base_t base;    int duration;    int loop_to_render_device;    VX_HANDLE account_handle;} vx_req_aux_capture_audio_start_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_capture_audio_start_create(vx_req_aux_capture_audio_start_t **req);#endiftypedef struct vx_req_aux_capture_audio_stop {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_capture_audio_stop_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_capture_audio_stop_create(vx_req_aux_capture_audio_stop_t **req);#endiftypedef struct vx_req_account_get_session_fonts {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_account_get_session_fonts_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_get_session_fonts_create(vx_req_account_get_session_fonts_t **req);#endiftypedef struct vx_req_account_get_template_fonts {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_account_get_template_fonts_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_get_template_fonts_create(vx_req_account_get_template_fonts_t **req);#endiftypedef struct vx_req_aux_start_buffer_capture {    vx_req_base_t base;    VX_HANDLE account_handle;} vx_req_aux_start_buffer_capture_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_start_buffer_capture_create(vx_req_aux_start_buffer_capture_t **req);#endiftypedef struct vx_req_aux_play_audio_buffer {    vx_req_base_t base;    VX_HANDLE account_handle;    int template_font_id;    char *font_delta;} vx_req_aux_play_audio_buffer_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_play_audio_buffer_create(vx_req_aux_play_audio_buffer_t **req);#endiftypedef struct vx_req_aux_global_monitor_keyboard_mouse {    vx_req_base_t base;    char *name;    int code_count;    int codes[10];} vx_req_aux_global_monitor_keyboard_mouse_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_global_monitor_keyboard_mouse_create(vx_req_aux_global_monitor_keyboard_mouse_t **req);#endiftypedef struct vx_req_aux_set_idle_timeout {    vx_req_base_t base;    int seconds;} vx_req_aux_set_idle_timeout_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_set_idle_timeout_create(vx_req_aux_set_idle_timeout_t **req);#endiftypedef struct {    char *admin_username;    char *admin_password;    char *grant_document;    char *server_url;} vx_generic_credentials;typedef struct vx_req_aux_create_account {    vx_req_base_t base;    vx_generic_credentials credentials;    char *user_name;    char *password;    char *email;    char *number;    char *displayname;    char *firstname;    char *lastname;    char *phone;    char *lang;    char *age;    char *gender;    char *timezone;    char *ext_profile;    char *ext_id;} vx_req_aux_create_account_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_create_account_create(vx_req_aux_create_account_t **req);#endiftypedef struct vx_req_aux_reactivate_account {    vx_req_base_t base;    vx_generic_credentials credentials;    char *user_name;} vx_req_aux_reactivate_account_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_reactivate_account_create(vx_req_aux_reactivate_account_t **req);#endiftypedef struct vx_req_aux_deactivate_account {    vx_req_base_t base;    vx_generic_credentials credentials;    char *user_name;} vx_req_aux_deactivate_account_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_deactivate_account_create(vx_req_aux_deactivate_account_t **req);#endiftypedef struct vx_req_account_post_crash_dump {    vx_req_base_t base;    VX_HANDLE account_handle;    char *crash_dump;} vx_req_account_post_crash_dump_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_post_crash_dump_create(vx_req_account_post_crash_dump_t **req);#endiftypedef struct vx_req_aux_reset_password {    vx_req_base_t base;    char *user_uri;    char *user_email;    char *server_url;} vx_req_aux_reset_password_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_reset_password_create(vx_req_aux_reset_password_t **req);#endiftypedef struct vx_req_aux_diagnostic_state_dump {    vx_req_base_t base;    vx_diagnostic_dump_level level;} vx_req_aux_diagnostic_state_dump_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_diagnostic_state_dump_create(vx_req_aux_diagnostic_state_dump_t **req);#endiftypedef struct vx_req_account_web_call {    vx_req_base_t base;    VX_HANDLE account_handle;    char *relative_path;    int parameter_count;    vx_name_value_pairs_t parameters;} vx_req_account_web_call_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_web_call_create(vx_req_account_web_call_t **req);#endiftypedef struct vx_req_sessiongroup_get_stats {    vx_req_base_t base;    VX_HANDLE sessiongroup_handle;    int reset_stats;} vx_req_sessiongroup_get_stats_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_sessiongroup_get_stats_create(vx_req_sessiongroup_get_stats_t **req);#endiftypedef struct vx_req_account_send_message {    vx_req_base_t base;    VX_HANDLE account_handle;    char *user_uri;    char *message_header;    char *message_body;    char *alias_username;    char *language;    char *application_stanza_namespace;    char *application_stanza_body;} vx_req_account_send_message_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_send_message_create(vx_req_account_send_message_t **req);#endiftypedef struct vx_req_account_delete_message {    vx_req_base_t base;    VX_HANDLE account_handle;    char *message_id;    VX_DEPRECATED(5.21)    char *user_uri;} vx_req_account_delete_message_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_delete_message_create(vx_req_account_delete_message_t **req);#endiftypedef struct vx_req_account_edit_message {    vx_req_base_t base;    VX_HANDLE account_handle;    VX_DEPRECATED(5.21)    char *user_uri;    char *message_id;    char *new_message;    char *language;} vx_req_account_edit_message_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_edit_message_create(vx_req_account_edit_message_t **req);#endif#ifndef DOXYGEN_MAM_SKIPtypedef struct vx_req_account_archive_query {    vx_req_base_t base;    VX_HANDLE account_handle;    char *time_start;    char *time_end;    char *cursor;    char *search_text;    char *channel_uri;    char *participant_uri;    char *display_name;    unsigned int max;    char *before_id;    char *after_id;    int first_message_index;    VX_DEPRECATED(5.21)    char *application_stanza_namespace;    VX_DEPRECATED(5.21)    char *application_stanza_body;} vx_req_account_archive_query_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_archive_query_create(vx_req_account_archive_query_t **req);#endif#endiftypedef struct vx_req_account_chat_history_query {    vx_req_base_t base;    VX_HANDLE account_handle;    char *time_start;    char *time_end;    char *cursor;    char *search_text;    char *channel_uri;    char *participant_uri;    char *display_name;    unsigned int max;    char *before_id;    char *after_id;    int first_message_index;    VX_DEPRECATED(5.21)    char *application_stanza_namespace;    VX_DEPRECATED(5.21)    char *application_stanza_body;} vx_req_account_chat_history_query_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_chat_history_query_create(vx_req_account_chat_history_query_t **req);#endiftypedef struct vx_req_account_get_conversations {    vx_req_base_t base;    VX_HANDLE account_handle;    int cursor;    long long request_time;    int page_size;} vx_req_account_get_conversations_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_get_conversations_create(vx_req_account_get_conversations_t **req);#endiftypedef struct vx_req_account_chat_history_set_marker {    vx_req_base_t base;    VX_HANDLE account_handle;    char *with_uri;    char *message_id;    long long seen_at;} vx_req_account_chat_history_set_marker_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_chat_history_set_marker_create(vx_req_account_chat_history_set_marker_t **req);#endiftypedef struct vx_req_aux_notify_application_state_change {    vx_req_base_t base;    vx_application_state_notification_type_t notification_type;} vx_req_aux_notify_application_state_change_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_aux_notify_application_state_change_create(vx_req_aux_notify_application_state_change_t **req);#endiftypedef struct vx_req_account_control_communications {    vx_req_base_t base;    VX_HANDLE account_handle;    vx_control_communications_operation operation;    char *user_uris;    vx_mute_scope scope;} vx_req_account_control_communications_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_control_communications_create(vx_req_account_control_communications_t **req);#endiftypedef struct vx_req_session_transcription_control {    vx_req_base_t base;    VX_HANDLE session_handle;    int enable;    char *access_token;} vx_req_session_transcription_control_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_session_transcription_control_create(vx_req_session_transcription_control_t **req);#endif#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int destroy_req(vx_req_base_t *pCmd);#endiftypedef struct vx_req_account_safe_voice_update_consent {    vx_req_base_t base;    VX_HANDLE account_handle;    char *unity_environment_id;    char *unity_authentication_token;    char *unity_project_id;    char *player_id;    bool consent_status;} vx_req_account_safe_voice_update_consent_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_safe_voice_update_consent_create(vx_req_account_safe_voice_update_consent_t **req);#endiftypedef struct vx_req_account_safe_voice_get_consent {    vx_req_base_t base;    VX_HANDLE account_handle;    char *unity_environment_id;    char *unity_authentication_token;    char *unity_project_id;    char *player_id;} vx_req_account_safe_voice_get_consent_t;#ifndef VIVOX_TYPES_ONLYVIVOXSDK_DLLEXPORT int vx_req_account_safe_voice_get_consent_create(vx_req_account_safe_voice_get_consent_t **req);#endif#ifdef __cplusplus}#endif#pragma pack(pop)

sdk/VxcRequests.h

Classes

Name

Types

Name

Functions

Name

Defines

Name

Types Documentation

enum vx_password_hash_algorithm_t

Enumerator

Value

Description

enum req_disposition_type_t

Enumerator

Value

Description

typedef vx_req_connector_create_t

typedef vx_req_connector_initiate_shutdown_t

typedef vx_req_account_login_t

typedef vx_req_account_authtoken_login_t

typedef vx_req_account_anonymous_login_t

typedef vx_req_account_logout_t

typedef vx_req_account_set_login_properties_t

typedef vx_req_sessiongroup_create_t

typedef vx_req_sessiongroup_terminate_t

typedef vx_req_sessiongroup_add_session_t

typedef vx_req_sessiongroup_remove_session_t

typedef vx_req_sessiongroup_set_focus_t

typedef vx_req_sessiongroup_unset_focus_t

typedef vx_req_sessiongroup_reset_focus_t

typedef vx_req_sessiongroup_set_tx_session_t

typedef vx_req_sessiongroup_set_tx_all_sessions_t

typedef vx_req_sessiongroup_set_tx_no_session_t

typedef vx_req_sessiongroup_set_session_3d_position_t

typedef vx_req_sessiongroup_control_audio_injection_t

typedef vx_req_session_create_t

typedef vx_req_session_media_connect_t

typedef vx_req_session_media_disconnect_t

typedef vx_req_session_text_connect_t

typedef vx_req_session_text_disconnect_t

typedef vx_req_session_terminate_t

typedef vx_req_session_mute_local_speaker_t

typedef vx_req_session_set_local_render_volume_t

typedef vx_req_session_set_local_speaker_volume_t

typedef vx_req_session_channel_invite_user_t

typedef vx_req_session_set_participant_volume_for_me_t

typedef vx_req_session_set_participant_mute_for_me_t

typedef vx_req_session_set_3d_position_t

typedef vx_req_session_set_voice_font_t

typedef vx_req_account_channel_change_owner_t

typedef vx_req_account_send_user_app_data_t

typedef vx_req_account_channel_add_acl_t

typedef vx_req_account_channel_remove_acl_t

typedef vx_req_account_channel_get_acl_t

typedef vx_req_channel_mute_user_t

typedef vx_req_channel_ban_user_t

typedef vx_req_channel_get_banned_users_t

typedef vx_req_channel_kick_user_t

typedef vx_req_channel_mute_all_users_t

typedef vx_req_channel_set_lock_mode_t

typedef vx_req_connector_mute_local_mic_t

typedef vx_req_connector_mute_local_speaker_t

typedef vx_req_connector_set_local_mic_volume_t

typedef vx_req_connector_set_local_speaker_volume_t

typedef vx_req_connector_get_local_audio_info_t

typedef vx_req_account_buddy_set_t

typedef vx_req_account_buddy_delete_t

typedef vx_req_account_list_buddies_and_groups_t

typedef vx_req_session_send_message_t

typedef vx_req_session_delete_message_t

typedef vx_req_session_edit_message_t

typedef vx_req_session_archive_query_t

typedef vx_req_session_chat_history_query_t

typedef vx_req_account_chat_history_get_last_read_t

typedef vx_req_account_set_presence_t

typedef vx_req_account_send_subscription_reply_t

typedef vx_req_session_send_notification_t

typedef vx_req_session_send_dtmf_t