Classes
Reference the Vivox Core SDK API.
Read time 18 minutesLast updated 20 hours ago
- struct vx_account
- struct vx_auto_accept_rule
- struct vx_before_recv_audio_mixed_participant_data_t
A struct that holds per-participant data for a callback. - struct vx_block_rule
- struct vx_buddy
- struct vx_call_stats
The common structure for holding call-related statistics. - struct vx_channel
Channel struct. - struct vx_connectivity_test_result
test_type - Enumeration that defines the test performed (for values, see appendix ?15.8). - struct vx_conversation
- struct vx_device
- struct vx_evt_account_archive_message
Presented when a message is found in response to [vx_req_account_archive_query] or [vx_req_account_chat_history_query] request. - struct vx_evt_account_archive_query_end
Presented when an account message archive query is completed. - struct vx_evt_account_delete_message
Presented when an incoming message has arrived from a participant with message-deleted. - struct vx_evt_account_edit_message
Presented when an incoming message has arrived from a participant with message-edited. - struct vx_evt_account_login_state_change
Sent whenever the login state of the particular account has transitioned from one value to another. - struct vx_evt_account_send_message_failed
Raised when a server reports a directed message send failure. - struct vx_evt_audio_device_hot_swap
Raised when audio device changes are made that impact the audio capture or rendering experience, or when other audio devices are added or removed. - struct vx_evt_aux_audio_properties
Used by the SDK sound system to present audio information to the application, which can be used to create a visual representation of the speaker (for example, a "VU" meter). - struct vx_evt_base
- struct vx_evt_buddy_and_group_list_changed
Presented when the buddy or group list undergoes a significant change. - struct vx_evt_buddy_changed
Presented when a buddy is either set (added or updated) or removed. - struct vx_evt_buddy_group_changed
Presented when a buddy group is set (added or updated) or removed. - struct vx_evt_buddy_presence
Presented when a buddy has issued presence information. - struct vx_evt_connection_state_changed
Raised when the network connection state has changed. - struct vx_evt_idle_state_changed
Raised to indicate to the application that the user has transitioned between an idle and non-idle state (in either order). - struct vx_evt_keyboard_mouse
Raised to indicate to the application that a particular keyboard/mouse button combination has been pressed or cleared. - struct vx_evt_media_completion
Received when certain media requests have completed. - struct vx_evt_media_stream_updated
Sent when session media has been altered. - struct vx_evt_message
Presented when an incoming message has arrived from a participant in an open session with text enabled. - struct vx_evt_network_message
Raised when the network sends a message to a user (as opposed to a user to user message). - struct vx_evt_participant_added
Presented when a participant is added to a session. - struct vx_evt_participant_removed
Presented when a participant is removed from a session. - struct vx_evt_participant_updated
Received when the properties of the participant change For example: mod muted, speaking, volume, energy, or typing notifications. - struct vx_evt_presence_updated
Raised when presence status of the signed in user changes. - struct vx_evt_publication_state_changed
Raised when the publication state has changed. - struct vx_evt_server_app_data
The server can send messages to the SDK that the SDK does not need to consume. - struct vx_evt_session_added
Sent when a session is added. - struct vx_evt_session_archive_message
Presented when a message is found in response to a [vx_req_session_archive_query] or [vx_req_session_chat_history_query] request. - struct vx_evt_session_archive_query_end
Presented when a channel history query is completed. - struct vx_evt_session_delete_message
Presented when an incoming message has arrived from a participant in an open session with message-deleted. - struct vx_evt_session_edit_message
Presented when an incoming message has arrived from a participant in an open session with message-edited. - struct vx_evt_session_notification
Received when another user has started or stopped typing, or has raised or lowered their hand, within the context of a session. - struct vx_evt_session_removed
Sent when a session is removed. - struct vx_evt_session_updated
Sent when a session is updated. - struct vx_evt_sessiongroup_added
Sent when a session group is added. - struct vx_evt_sessiongroup_playback_frame_played
Posted after a frame has been played. - struct vx_evt_sessiongroup_removed
Sent when a session group is removed. - struct vx_evt_sessiongroup_updated
Sent when a session group is updated. - struct vx_evt_stt_failed
Raised when the transcription (STT) service has a failure. - struct vx_evt_subscription
Generated when a buddy wants to request presence visibility. - struct vx_evt_text_stream_updated
Sent when the session text has been altered. - struct vx_evt_transcribed_message
Presented when an incoming transcribed text has arrived from a participant in an open session. - struct vx_evt_tts_injection_ended
Raised when an injection of a text-to-speech (TTS) message has ended. - struct vx_evt_tts_injection_failed
Raised when an injection of a text-to-speech (TTS) message has failed. - struct vx_evt_tts_injection_started
Raised when a text-to-speech (TTS) message injection has started. - struct vx_evt_user_app_data
Raised when a message from another user is received. - struct vx_evt_user_to_user_message
Raised when a message from another user is received. - struct vx_evt_voice_service_connection_state_changed
Raised when the SDK is running out of process and the connection state of the Vivox Voice Service (VVS) changes. - struct vx_generic_credentials
Credentials for creating Vivox accounts. - struct vx_group
- struct vx_message_base
- struct vx_name_value_pair
- struct vx_participant
Channel participant. - struct vx_req_account_anonymous_login
Log in anonymously to the Vivox network. - struct vx_req_account_archive_query
Query messages that were archived by the server for the specified account. - struct vx_req_account_authtoken_login
- struct vx_req_account_buddy_delete
Delete a buddy from a user's buddy list. - struct vx_req_account_buddy_set
Add a buddy to a buddy list or update the properties of a buddy. - struct vx_req_account_channel_add_acl
- struct vx_req_account_channel_change_owner
- struct vx_req_account_channel_get_acl
- struct vx_req_account_channel_remove_acl
- struct vx_req_account_chat_history_get_last_read
Get the last read message from a specified channel. - struct vx_req_account_chat_history_query
Query messages that were archived by the server for the specified account. - 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_account_control_communications
Manage communication between users. - 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_create_block_rule
Define rules to block individuals or groups of individuals. - struct vx_req_account_delete_auto_accept_rule
Delete an auto accept rule. - struct vx_req_account_delete_block_rule
Delete a block rule. - 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_get_account
- struct vx_req_account_get_conversations
Returns a list of conversations a user is participating in, in reverse order. - 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_account_list_auto_accept_rules
Retrieve a list of auto accept rules for a given account. - struct vx_req_account_list_block_rules
Retrieve a list of block rules for a given account. - struct vx_req_account_list_buddies_and_groups
Retrieve a list of all buddies and buddy groups for a given account. - struct vx_req_account_login
- struct vx_req_account_logout
Log a user out of the Vivox system. - struct vx_req_account_post_crash_dump
Post crash dump data to the server. - struct vx_req_account_safe_voice_get_consent
Pass a Unity Authentication token to be validated by the Mint service for channel joins. - 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_send_message
Send a message to a specific user. - struct vx_req_account_send_sms
- struct vx_req_account_send_subscription_reply
Respond to an incoming subscription event. - struct vx_req_account_send_user_app_data
Send specified data directly to a user. - struct vx_req_account_set_login_properties
Set some of the properties passed in on the login command. - struct vx_req_account_set_presence
Set the presence (online/offline status) of an account. - struct vx_req_account_update_account
- struct vx_req_account_web_call
- 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_aux_connectivity_info
Perform a network test. - struct vx_req_aux_create_account
- struct vx_req_aux_deactivate_account
- struct vx_req_aux_diagnostic_state_dump
Get the current state of the SDK. - struct vx_req_aux_get_capture_devices
Return a list of available audio capture devices. - struct vx_req_aux_get_derumbler_properties
Get the derumbler (high-pass filter) properties. - 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_render_devices
Retrieve a list of audio render devices for the current computer. - 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_get_vad_properties
Get the connector VAD (Voice Activity Detector) properties. - struct vx_req_aux_global_monitor_keyboard_mouse
- struct vx_req_aux_notify_application_state_change
Notify the SDK when important application-level changes occur. - 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_reactivate_account
- struct vx_req_aux_render_audio_modify
Modify the applied font of the aux audio buffer that is rendering. - struct vx_req_aux_render_audio_start
Ensure that a specific selected render device is functioning properly. - struct vx_req_aux_render_audio_stop
Immediately stop audio render playback. - struct vx_req_aux_reset_password
Reset a user's password. - 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_set_derumbler_properties
Set the derumbler (high-pass filter) properties. - struct vx_req_aux_set_idle_timeout
- struct vx_req_aux_set_mic_level
Set the master microphone level of the Vivox SDK sound system. - 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_speaker_level
Set the master speaker level of the Vivox SDK sound system. - struct vx_req_aux_set_vad_properties
Set the connector VAD (Voice Activity Detector) properties. - struct vx_req_aux_start_buffer_capture
Start audio capture from the selected audio capture device. - struct vx_req_base
- 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_mute_user
Mute or unmute a participant in a specific channel. - struct vx_req_channel_set_lock_mode
- struct vx_req_connector_create
Connect the application to the Vivox service. - 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_connector_initiate_shutdown
Call this when the application is shutting down to gracefully release resources. - 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_session_archive_query
Query messages that were archived by the server for the specified channel. - 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_chat_history_query
Query messages that were archived by the server for the specified channel. - struct vx_req_session_create
- 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_media_connect
Connect media (audio) in a session. - struct vx_req_session_media_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_send_dtmf
- struct vx_req_session_send_message
Send a message to all participants in the session. - 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_set_3d_position
Set and get the 3D position of the speaker and listener. - 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_set_participant_mute_for_me
Mute a participant in the current session. - struct vx_req_session_set_participant_volume_for_me
Set the volume for a participant in the current session. - struct vx_req_session_set_voice_font
Apply a voice font to an already established voice session. - struct vx_req_session_terminate
End an established session (hang-up or 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_transcription_control
Enable or disable session transcription. - struct vx_req_sessiongroup_add_session
Sessions represent a connection to a media session with one or more participants. - struct vx_req_sessiongroup_control_audio_injection
Start or stop session group audio injection. - struct vx_req_sessiongroup_create
- struct vx_req_sessiongroup_get_stats
Retrieve network-related statistics for the call associated with the specified session group. - struct vx_req_sessiongroup_remove_session
End an established session (hang-up or disconnect). - struct vx_req_sessiongroup_reset_focus
Reset all sessions in a group so they have equal priority or focus. - 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_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_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_tx_session
Set the session within the session group to which to user's voice is transmitted. - struct vx_req_sessiongroup_terminate
- struct vx_req_sessiongroup_unset_focus
Unset the focus of a specific channel that previously was set to have focus. - struct vx_resp_account_anonymous_login
The response for vx_req_account_anonymous_login. - struct vx_resp_account_archive_query
The response for vx_req_account_archive_query. - struct vx_resp_account_authtoken_login
- struct vx_resp_account_buddy_delete
The response for vx_req_account_buddy_delete. - struct vx_resp_account_buddy_set
The response for vx_req_account_buddy_set. - struct vx_resp_account_channel_add_acl
- struct vx_resp_account_channel_change_owner
The response for vx_req_account_channel_change_owner. - struct vx_resp_account_channel_get_acl
- struct vx_resp_account_channel_remove_acl
- struct vx_resp_account_chat_history_get_last_read
The response for vx_req_account_chat_history_get_last_read. - struct vx_resp_account_chat_history_query
The response for vx_req_account_chat_history_query. - struct vx_resp_account_chat_history_set_marker
The response for vx_req_account_chat_history_set_marker. - struct vx_resp_account_control_communications
The response for vx_req_account_control_communications. - struct vx_resp_account_create_auto_accept_rule
The response for vx_req_account_create_auto_accept_rule. - struct vx_resp_account_create_block_rule
The response for vx_req_account_create_block_rule. - struct vx_resp_account_delete_auto_accept_rule
The response for vx_req_account_delete_auto_accept_rule. - struct vx_resp_account_delete_block_rule
The response for vx_req_account_delete_block_rule. - struct vx_resp_account_delete_message
The response for vx_req_account_delete_message. - struct vx_resp_account_edit_message
The response for vx_req_account_edit_message. - struct vx_resp_account_get_account
- struct vx_resp_account_get_conversations
- struct vx_resp_account_get_session_fonts
The response for vx_req_account_get_session_fonts. - struct vx_resp_account_get_template_fonts
The response for vx_req_account_get_template_fonts. - struct vx_resp_account_list_auto_accept_rules
The response for vx_req_account_list_auto_accept_rules. - struct vx_resp_account_list_block_rules
The response for vx_req_account_list_block_rules. - struct vx_resp_account_list_buddies_and_groups
- struct vx_resp_account_login
- struct vx_resp_account_logout
The response for vx_req_account_logout. - struct vx_resp_account_post_crash_dump
The response for vx_req_account_post_crash_dump. - struct vx_resp_account_safe_voice_get_consent
- struct vx_resp_account_safe_voice_update_consent
- struct vx_resp_account_send_message
The response for vx_req_account_send_message. - struct vx_resp_account_send_sms
The response for vx_req_account_send_sms. - struct vx_resp_account_send_subscription_reply
The response for vx_req_account_send_subscription_reply. - struct vx_resp_account_send_user_app_data
The response for vx_req_account_send_user_app_data. - struct vx_resp_account_set_login_properties
- struct vx_resp_account_set_presence
The response for vx_req_account_set_presence. - struct vx_resp_account_update_account
- struct vx_resp_account_web_call
- struct vx_resp_aux_capture_audio_start
The response for vx_req_aux_capture_audio_start. - struct vx_resp_aux_capture_audio_stop
The response for vx_req_aux_capture_audio_stop. - struct vx_resp_aux_connectivity_info
The response for vx_req_aux_connectivity_info. - struct vx_resp_aux_create_account
The response for vx_req_aux_create_account. - struct vx_resp_aux_deactivate_account
The response for vx_req_aux_deactivate_account. - struct vx_resp_aux_diagnostic_state_dump
The response for vx_req_aux_diagnostic_state_dump. - struct vx_resp_aux_get_capture_devices
The response for vx_req_aux_get_capture_devices. - struct vx_resp_aux_get_derumbler_properties
The response for vx_req_aux_get_derumbler_properties. - struct vx_resp_aux_get_mic_level
The response for vx_req_aux_get_mic_level. - struct vx_resp_aux_get_render_devices
The response for vx_req_aux_get_render_devices. - struct vx_resp_aux_get_speaker_level
The response for vx_req_aux_get_speaker_level. - struct vx_resp_aux_get_vad_properties
The response for vx_req_aux_get_vad_properties. - struct vx_resp_aux_global_monitor_keyboard_mouse
The response for vx_req_aux_global_monitor_keyboard_mouse. - struct vx_resp_aux_notify_application_state_change
The response for vx_req_aux_notify_application_state_change. - struct vx_resp_aux_play_audio_buffer
The response for vx_req_aux_play_audio_buffer. - struct vx_resp_aux_reactivate_account
The response for vx_req_aux_reactivate_account. - struct vx_resp_aux_render_audio_modify
The response for vx_req_aux_render_audio_modify. - struct vx_resp_aux_render_audio_start
The response for vx_req_aux_render_audio_start. - struct vx_resp_aux_render_audio_stop
The response for vx_req_aux_render_audio_stop. - struct vx_resp_aux_reset_password
The response for vx_req_aux_reset_password. - struct vx_resp_aux_set_capture_device
The response for vx_req_aux_set_capture_device. - struct vx_resp_aux_set_derumbler_properties
The response for vx_req_aux_set_derumbler_properties. - struct vx_resp_aux_set_idle_timeout
The response for vx_req_aux_set_idle_timeout. - struct vx_resp_aux_set_mic_level
The response for vx_req_aux_set_mic_level. - struct vx_resp_aux_set_render_device
The response for vx_req_aux_set_render_device. - struct vx_resp_aux_set_speaker_level
The response for vx_req_aux_set_speaker_level. - struct vx_resp_aux_set_vad_properties
The response for vx_req_aux_set_vad_properties. - struct vx_resp_aux_start_buffer_capture
The response for vx_req_aux_start_buffer_capture. - struct vx_resp_base
- struct vx_resp_channel_ban_user
- struct vx_resp_channel_get_banned_users
- struct vx_resp_channel_kick_user
The response for vx_req_channel_kick_user. - struct vx_resp_channel_mute_all_users
The response for vx_req_channel_mute_all_users. - struct vx_resp_channel_mute_user
The response for vx_req_channel_mute_user. - struct vx_resp_channel_set_lock_mode
- struct vx_resp_connector_create
The response for vx_req_connector_create. - struct vx_resp_connector_get_local_audio_info
The response for vx_req_connector_get_local_audio_info. - struct vx_resp_connector_initiate_shutdown
The response for vx_req_connector_initiate_shutdown. - struct vx_resp_connector_mute_local_mic
The response for vx_req_connector_mute_local_mic. - struct vx_resp_connector_mute_local_speaker
The response for vx_req_connector_mute_local_speaker. - struct vx_resp_connector_set_local_mic_volume
- struct vx_resp_connector_set_local_speaker_volume
- struct vx_resp_session_archive_query
The response for vx_req_session_archive_query. - struct vx_resp_session_channel_invite_user
The response for vx_req_session_channel_invite_user. - struct vx_resp_session_chat_history_query
The response for vx_req_session_chat_history_query. - struct vx_resp_session_create
- struct vx_resp_session_delete_message
The response for vx_req_session_delete_message. - struct vx_resp_session_edit_message
The response for vx_req_session_edit_message. - struct vx_resp_session_media_connect
The response for vx_req_session_media_connect. - struct vx_resp_session_media_disconnect
The response for vx_req_session_media_disconnect. - struct vx_resp_session_mute_local_speaker
The response for vx_req_session_mute_local_speaker. - struct vx_resp_session_send_dtmf
- struct vx_resp_session_send_message
The response for vx_req_session_send_message. - struct vx_resp_session_send_notification
The response for vx_req_session_send_notification. - struct vx_resp_session_set_3d_position
The response for vx_req_session_set_3d_position. - struct vx_resp_session_set_local_render_volume
The response for vx_req_session_set_local_render_volume. - struct vx_resp_session_set_local_speaker_volume
- struct vx_resp_session_set_participant_mute_for_me
The response for vx_req_session_set_participant_mute_for_me. - struct vx_resp_session_set_participant_volume_for_me
The response for vx_req_session_set_participant_volume_for_me. - struct vx_resp_session_set_voice_font
The response for vx_req_session_set_voice_font. - struct vx_resp_session_terminate
The response for vx_req_session_terminate. - struct vx_resp_session_text_connect
The response for vx_req_session_text_connect. - struct vx_resp_session_text_disconnect
The response for vx_req_session_text_disconnect. - struct vx_resp_session_transcription_control
The response for vx_req_session_transcription_control. - struct vx_resp_sessiongroup_add_session
The response for vx_req_sessiongroup_add_session. - struct vx_resp_sessiongroup_control_audio_injection
The response for vx_req_sessiongroup_control_audio_injection. - struct vx_resp_sessiongroup_create
- struct vx_resp_sessiongroup_get_stats
Get the network statistics associated with a particular session group. - struct vx_resp_sessiongroup_remove_session
The response for vx_req_sessiongroup_remove_session. - struct vx_resp_sessiongroup_reset_focus
The response for vx_req_sessiongroup_reset_focus. - struct vx_resp_sessiongroup_set_focus
The response for vx_req_sessiongroup_set_focus. - struct vx_resp_sessiongroup_set_session_3d_position
The response for vx_req_sessiongroup_set_session_3d_position. - struct vx_resp_sessiongroup_set_tx_all_sessions
The response for vx_req_sessiongroup_set_tx_all_sessions. - struct vx_resp_sessiongroup_set_tx_no_session
The response for vx_req_sessiongroup_set_tx_no_session. - struct vx_resp_sessiongroup_set_tx_session
The response for vx_req_sessiongroup_set_tx_session. - struct vx_resp_sessiongroup_terminate
- struct vx_resp_sessiongroup_unset_focus
The response for vx_req_sessiongroup_unset_focus. - struct vx_sdk_config
Configuration options that are passed to [vx_initialize3()]. - struct vx_stat_sample
- struct vx_stat_thread
- struct vx_state_account
State account. - struct vx_state_buddy
- struct vx_state_buddy_contact
- struct vx_state_buddy_group
- struct vx_state_connector
State connector. - struct vx_state_participant
State participant. - struct vx_state_session
State session. - struct vx_state_sessiongroup
State session group. - struct vx_system_stats
- struct vx_tts_utterance
Text-to-speech utterance. - struct vx_tts_voice
Text-to-speech voice. - struct vx_user_channel
- struct vx_voice_font
Voice font struct. - struct vx_vxd
The Vivox eXtended Data (VXD) that is received. - struct vxa_capture_device_stats_t
Get statistics that are useful for debugging audio capture issues. - struct vxa_render_device_stats_t
Get statistics that are useful for debugging audio render issues.