Deprecated List

---

Global [connector_mode_legacy]

• This is deprecated and should not be used.

Global [log_to_file]

• File logging is not supported. Use log_to_none instead. Log to the native configured logfile.

Global [log_to_file_and_callback]

• File logging is not supported. Use log_to_callback instead. Log to the native configured log file and the client application through the registered callback method.

Global [mode_auto_answer]

• This is deprecated and should not be used. The incoming call is automatically connected if a call is not already established.

Global [VIVOX_V_V2_AUDIO_DATA_MONO_SIREN14_32000]

• Use VIVOX_V_V2_AUDIO_DATA_MONO_SIREN14_32000_EXPANDED instead of VIVOX_V_V2_AUDIO_DATA_MONO_SIREN14_32000.

Global [VIVOX_VANI_PCMU]

• PCMU functionality has been removed. Please discontinue use.

Global [vx_call_stats::codec_mode]

• This is deprecated and should not be used.

Global vx_channel::capacity

• This is deprecated and should not be used. The forecasted number of participants in the channel.

Global vx_channel::channel_id

• This is deprecated and should not be used. The numeric identifier of the channel.

Global vx_channel::size

• This is deprecated and should not be used.

Global vx_evt_aux_audio_properties::state

• This is deprecated and should not be used.

Global vx_evt_buddy_changed::account_id

• This is deprecated and should not be used. The account ID of the buddy.

Global vx_evt_buddy_presence::state

• This is deprecated and should not be used.

Global vx_evt_message::state

• This is deprecated and should not be used.

Global vx_evt_participant_added::application

• This is deprecated and should not be used.

Global vx_evt_participant_added::display_name

• Use displayname instead.

Global vx_evt_participant_added::participant_type

• This is deprecated and should not be used.

Global vx_evt_session_added::application

• This is deprecated and should not be used.

Global vx_evt_session_added::displayname

• This is deprecated and should not be used.

Global vx_evt_session_notification::state

• This is deprecated and should not be used.

Global vx_evt_sessiongroup_updated::current_playback_mode

• This is deprecated and should not be used. Indicates the playback mode.

Global vx_evt_sessiongroup_updated::current_playback_speed

• This is deprecated and should not be used. Indicates the playback speed.

Global vx_evt_sessiongroup_updated::current_recording_filename

• This is deprecated and should not be used. The filename currently being recorded. This is empty if no file is being recorded.

Global vx_evt_sessiongroup_updated::first_frame_timestamp_us

This is deprecated and should not be used. The timestamp associated with the first frame in microseconds.

• On non-Windows platforms, this is computed from gettimeofday().
• On Windows platforms, this is computed from GetSystemTimeAsFileTime()

Global vx_evt_sessiongroup_updated::first_loop_frame

• This is deprecated and should not be used. The sequence number of first frame in the loop buffer. This starts increasing when the loop buffer fills.

Global vx_evt_sessiongroup_updated::in_delayed_playback

• This is deprecated and should not be used. Indicates whether in delayed playback. When in delayed playback, the mic is not active.

Global vx_evt_sessiongroup_updated::last_loop_frame_played

• This is deprecated and should not be used. The sequence number of the last frame played.

Global vx_evt_sessiongroup_updated::loop_buffer_capacity

• This is deprecated and should not be used. The total capacity of the loop buffer.

Global vx_evt_sessiongroup_updated::playback_paused

• This is deprecated and should not be used. Indicates whether playback is paused.

Global vx_evt_sessiongroup_updated::total_loop_frames_captured

• This is deprecated and should not be used. The total number of frames captured to the loop buffer since recording started. This peaks when the loop buffer fills.

Global vx_evt_sessiongroup_updated::total_recorded_frames

• This is deprecated and should not be used. The total number of frames recorded to file.

Global vx_get_log_file_path (void)

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

Global vx_initialize (void)

• Use vx_initialize3() instead. An application must call this API before calling any other Vivox API.

Global vx_issue_request (vx_req_base_t *request)

• Use vx_issue_request2 instead. Execute the given request. On V4: This function initializes the SDK automatically if not already initialized (see vx_initialize3()). On V5: This function has the same behavior as vx_issue_request2.

Global vx_req_account_archive_query::application_stanza_body

• This is deprecated and should not be used. The body of the custom application stanza.

Global vx_req_account_archive_query::application_stanza_namespace

• This is deprecated and should not be used. The namespace of the custom application stanza.

Global vx_req_account_authtoken_login_t

Use vx_req_account_anonymous_login instead. Log in to specific user accounts by using an authorization token (authtoken) that is retrieved from the Vivox server API. Global vx_req_account_channel_add_acl_create (vx_req_account_channel_add_acl_t **req)

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

Global vx_req_account_channel_add_acl_t

This is deprecated and should not be used. Add accounts that are allowed to participate in the channel (access control list). Global vx_req_account_channel_change_owner_create (vx_req_account_channel_change_owner_t **req)

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

Global vx_req_account_channel_change_owner_t

• This is deprecated and should not be used. Change ownership of a channel to a specified account.

Global vx_req_account_channel_get_acl_create (vx_req_account_channel_get_acl_t **req)

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

Global vx_req_account_channel_get_acl_t

• This is deprecated and should not be used. Retrieve the access control list for the specified channel.

Global vx_req_account_channel_remove_acl_create (vx_req_account_channel_remove_acl_t **req)

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

Global vx_req_account_channel_remove_acl_t

• This is deprecated and should not be used. Remove an access control list entry from a channel.

Global vx_req_account_chat_history_query::application_stanza_body

• This is deprecated and should not be used. The body of the custom application stanza.

Global vx_req_account_chat_history_query::application_stanza_namespace

• This is deprecated and should not be used. The namespace of the custom application stanza.

Global vx_req_account_delete_message::user_uri

• This is deprecated and should not be used. The destination URI.

Global vx_req_account_edit_message::user_uri

• This is deprecated and should not be used. The destination URI.

Global vx_req_account_get_account::uri

• This field is not used.

Global vx_req_account_get_account_t

This is deprecated and should not be used. Return basic information about the user's account. Global vx_req_account_login::enable_client_ringback

• This flag does not affect anything.

Global vx_req_account_login_t

Use vx_req_account_anonymous_login instead. Log in and log out of specific user accounts. Global vx_req_account_logout::logout_reason

• This is deprecated and should not be used. A generic string that is returned in the logout event. Applications can use this to determine the reason for logout, if needed.

Global vx_req_account_send_message::alias_username

• This is deprecated and should not be used.

Global vx_req_account_send_sms_t

• This is deprecated and should not be used. Send an SMS message to another user if that user's phone and carrier have been properly set. If the recipient's phone or carrier is not set, a response is immediately returned with a return code of 1. If the message could not be delivered for any other unforeseen reason downstream, the error is not reported in the response.

Global vx_req_account_set_login_properties::answer_mode

• This field is deprecated and should not be used. Control how the SDK responds to incoming voice calls. The default value is mode_verify_answer.

Global vx_req_account_set_login_properties_create (vx_req_account_set_login_properties_t **req)

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

Global vx_req_account_set_presence::alias_username

• This is deprecated and should not be used.

Global vx_req_account_update_account_t

This is deprecated and should not be used. Update information about the currently logged in account. Global vx_req_account_web_call_t

• This is deprecated and should not be used. Submit a generic web request to the Vivox account management server.

Global vx_req_aux_capture_audio_start::duration

• This is deprecated and should not be used.

Global vx_req_aux_create_account_t

This is deprecated and should not be used. Create a new user account. Global vx_req_aux_deactivate_account_t

This is deprecated and should not be used. Deactivate an account. Global vx_req_aux_global_monitor_keyboard_mouse_t

• This is deprecated and should not be used. Monitor the keyboard and mouse buttons when the application does not have focus. When the vx_req_aux_global_monitor_keyboard_mouse_t request is issued to the SDK, the SDK raises vx_evt_keyboard_mouse_t events when a key or mouse button combination is pressed or released. This only supports the first three mouse buttons. The request can be issued multiple times for different combinations of key codes.

Global vx_req_aux_reactivate_account_t

This is deprecated and should not be used. Reactivate an account that has been deactivated. Global vx_req_aux_render_audio_start::path

• Debug use only.

Global vx_req_aux_set_idle_timeout_t

• This is deprecated and should not be used. Monitor the keyboard and mouse to detect when a user has been idle for a specific period of time. To do this, issue a vx_req_aux_set_idle_timeout_t request, and the SDK then raises an vx_evt_idle_state_changed event when the user transitions to and from an idle state.

Global vx_req_channel_ban_user::channel_name

• This field is ignored. The name of the channel.

Global vx_req_channel_ban_user_create (vx_req_channel_ban_user_t **req)

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

Global vx_req_channel_ban_user_t

This is deprecated and should not be used. Ban a user from joining a channel, or un-ban a user if they have already been banned. This kicks the user out from the channel and bans the user from rejoining the channel. Global vx_req_channel_get_banned_users_create (vx_req_channel_get_banned_users_t **req)

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

Global vx_req_channel_get_banned_users_t

• This is deprecated and should not be used. Return a list of users who are banned from the specified channel.

Global vx_req_channel_kick_user::channel_name

• This field is ignored. The name of the channel.

Global vx_req_channel_mute_all_users::channel_name

• This field is ignored. The name of the channel.

Global vx_req_channel_mute_user::channel_name

• This field is ignored. The name of the channel.

Global vx_req_channel_set_lock_mode_create (vx_req_channel_set_lock_mode_t **req)

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

Global vx_req_channel_set_lock_mode_t

• This is deprecated and should not be used. Set the lock mode of a channel. When a channel is locked, no additional participants can join the channel. This command can also unlock the channel.

Global vx_req_connector_create::client_name

• Do not use.

Global vx_req_connector_create::default_codec

• Use the configured_codecs field instead. The default codec.

Global vx_req_connector_create::enable_duplicate_participant_uris

• This is deprecated and should not be used. Handle multiple participants with the same SIP URI more gracefully in a channel.

Global vx_req_connector_get_local_audio_info::connector_handle

• This parameter is ignored. The handle returned from a successful vx_req_connector_create request.

Global vx_req_connector_initiate_shutdown::client_name

• This is deprecated and should not be used.

Global vx_req_connector_set_local_mic_volume::connector_handle

• This parameter is ignored. The handle returned from a successful vx_req_connector_create request.

Global vx_req_connector_set_local_mic_volume_create (vx_req_connector_set_local_mic_volume_t **req)

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

Global vx_req_connector_set_local_mic_volume_t

Use vx_req_aux_set_mic_level_t instead. Set the microphone volume. Raising or lowering the boost applies to the speaking volume that is heard by others. Global vx_req_connector_set_local_speaker_volume::connector_handle

• This parameter is ignored. The handle returned from a successful vx_req_connector_create request.

Global vx_req_connector_set_local_speaker_volume_create (vx_req_connector_set_local_speaker_volume_t **req)

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

Global vx_req_connector_set_local_speaker_volume_t

Use vx_req_aux_set_speaker_level_t instead. Set the speaker volume. This setting provides a relative volume that applies to all connected audio sessions. Global vx_req_session_archive_query::application_stanza_body

• This is deprecated and should not be used. The body of the custom application stanza.

Global vx_req_session_archive_query::application_stanza_namespace

• This is deprecated and should not be used. The namespace of the custom application stanza.

Global vx_req_session_chat_history_query::application_stanza_body

• This is deprecated and should not be used. The body of the custom application stanza.

Global vx_req_session_chat_history_query::application_stanza_namespace

• This is deprecated and should not be used. The namespace of the custom application stanza.

Global vx_req_session_chat_history_query::participant_uri

• This is deprecated and should not be used. Currently not implemented in the backend and attempting to use will result in an error. The fully specified URI of the participant. Only messages to or from the specified participant are returned. This is optional. The default setting is NULL.

Global vx_req_session_create::alias_username

• This is deprecated and should not be used.

Global vx_req_session_create::join_audio

• Replaced with connect_audio. Determine whether the session will join audio.
  • 1 indicates that audio will be joined.
  • 0 indicates that audio will not be joined. The default value is 1.

Global vx_req_session_create::join_text

• Replaced with connect_text. Text is now enabled at the account level and the default is to have text enabled. Determine whether the session is going to join text.
  • 1 indicates that text will be joined
  • 0 indicates that text will not be joined. The default value is 0.

Global vx_req_session_create_create (vx_req_session_create_t **req)

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

Global vx_req_session_create_t

This is deprecated and should not be used. Generate an outbound call to another user or channel. Sessions typically represent a connection to a media session with one or more participants. The specifics depend on the media types involved. A session handle is required to control local user functions within the session (or remote users, if the current account has the appropriate rights). Global vx_req_session_media_connect::capture_device_id

• Use vx_req_aux_set_capture_device to set the capture device instead. The device ID of the capture device to use. Use NULL or empty to use the last selected capture device.

Global vx_req_session_media_connect::media

• This is deprecated and should not be used.

Global vx_req_session_media_connect::render_device_id

• Use vx_req_aux_set_render_device to set the capture device instead. The device ID of the render device to use. Use NULL or empty to use the last selected render device.

Global vx_req_session_media_connect::sessiongroup_handle

• Do not use. This structure member is ignored.

Global vx_req_session_media_disconnect::media

• This is deprecated and should not be used.

Global vx_req_session_media_disconnect::sessiongroup_handle

• Do not use. This structure member is ignored.

Global vx_req_session_media_disconnect_t

• This is deprecated and should not be used. Disconnect the media (audio) in the session.

Global vx_req_session_send_dtmf_create (vx_req_session_send_dtmf_t **req)

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

Global vx_req_session_send_dtmf_t

• This is deprecated and should not be used. Send a dual-tone multi-frequency (DTMF) signal for a given session.

Global vx_req_session_set_local_speaker_volume_create (vx_req_session_set_local_speaker_volume_t **req)

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

Global vx_req_session_set_local_speaker_volume_t

• Use vx_req_session_set_local_render_volume_t instead. Set the speaker volume for the specified session.

Global vx_req_session_text_connect::sessiongroup_handle

• Do not use. This structure member is ignored.

Global vx_req_session_text_disconnect::sessiongroup_handle

• Do not use. This structure member is ignored.

Global vx_req_sessiongroup_add_session::name

• This is deprecated and should not be used. The display name of the entity being called (user or channel).

Global vx_req_sessiongroup_add_session::password

• This is deprecated and should not be used. The password that is used if the user is joining a password-protected channel.

Global vx_req_sessiongroup_add_session::password_hash_algorithm

• This is deprecated and should not be used. Indicates the hashing algorithm used on the password that is passed in to the SDK. This can be password_hash_algorithm_cleartext or password_hash_algorithm_sha1_username_hash.
  • For password_hash_algorithm_cleartext, the password that is passed in is in cleartext.
  • For password_hash_algorithm_sha1_username_hash, the password that is passed in is the SHA1 hash of the password and the SIP URI of the user, Base64-encoded, with any trailing '=' characters stripped off.

Global vx_req_sessiongroup_add_session::session_font_id

• This is deprecated and should not be used. The ID of the voice font to apply to the session. You can obtain a list of available voice font IDs with vx_req_account_get_session_fonts. Set to 0 for none.

Global vx_req_sessiongroup_create::alias_username

• This field is deprecated and should not be used.

Global vx_req_sessiongroup_create::capture_device_id

• This field is ignored.

Global vx_req_sessiongroup_create::render_device_id

• This field is ignored.

Global vx_req_sessiongroup_create_create (vx_req_sessiongroup_create_t **req)

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

Global vx_req_sessiongroup_create_t

• This is deprecated and should not be used. A session group is a container object that holds one or more sessions. Session groups are used to support multi-channel mode. A session group is local to an application and does not imply symmetrical association or view for other participants in individual channels. If the client application needs to provide the ability for users to listen to multiple channels at the same time, then the session group is used to add or remove channels (sessions). An example of multi-channel use is an MMO with a hierarchical organizational structure, such as fleets, nested groups, or gangs. As another example, a multi-channel mode can be used to provide one channel to talk to others located near a user, and a second channel to bridge non-proximate participants from various regions in a virtual world. A session group is also used to manage the channels in a session group. There are cases where one channel might need to be the focus channel, and all other channels are in the background (which makes the focus channel louder and the other channels quieter).

Global vx_req_sessiongroup_get_stats::sessiongroup_handle

• This field is ignored. The handle returned from a successful vx_req_sessiongroup_create request.

Global vx_req_sessiongroup_set_focus::sessiongroup_handle

• This field is ignored. The handle returned from a successful vx_req_sessiongroup_create request.

Global vx_req_sessiongroup_set_session_3d_position::sessiongroup_handle

• This field is ignored. The handle returned from a successful vx_req_sessiongroup_create request.

Global vx_req_sessiongroup_set_session_3d_position::speaker_at_orientation [3]

• This is deprecated and should not be used.

Global vx_req_sessiongroup_set_tx_all_sessions::sessiongroup_handle

• This field is ignored. The handle returned from a successful vx_req_sessiongroup_create request.

Global vx_req_sessiongroup_set_tx_no_session::sessiongroup_handle

• This field is ignored. The handle returned from a successful vx_req_sessiongroup_create request.

Global vx_req_sessiongroup_set_tx_session::sessiongroup_handle

• This field is ignored. The handle returned from a successful vx_req_sessiongroup_create request.

Global vx_req_sessiongroup_terminate::sessiongroup_handle

• This field is ignored. The handle returned from a successful vx_req_sessiongroup_create request.

Global vx_req_sessiongroup_terminate_t

This is deprecated and should not be used. Terminate a session group. This also ends any established sessions within the session group. Global vx_req_sessiongroup_unset_focus::sessiongroup_handle

• This field is ignored. The handle returned from a successful vx_req_sessiongroup_create request.

Global vx_resp_account_authtoken_login_t

• Use vx_req_account_anonymous_login instead. The response for vx_req_account_authtoken_login

Global vx_resp_account_channel_add_acl_t

This is deprecated and should not be used. The response for vx_req_account_channel_add_acl Global vx_resp_account_channel_get_acl_t

• This is deprecated and should not be used. The response for vx_req_account_channel_get_acl

Global vx_resp_account_channel_remove_acl_t

This is deprecated and should not be used. The response for vx_req_account_channel_remove_acl Global vx_resp_account_get_account_t

This is deprecated and should not be used. The response for vx_req_account_get_account Global vx_resp_account_list_buddies_and_groups_t

This is deprecated and should not be used. The response for vx_req_account_list_buddies_and_groups Global vx_resp_account_login_t

This is deprecated and should not be used. The response for vx_req_account_login Global vx_resp_account_set_login_properties_t

• This is deprecated and should not be used. The response for vx_req_account_set_login_properties

Global vx_resp_account_update_account_t

This is deprecated and should not be used. The response for vx_req_account_update_account Global vx_resp_account_web_call_t

• This is deprecated and should not be used. The response for vx_req_account_web_call

Global vx_resp_channel_ban_user_t

This is deprecated and should not be used. The response for vx_req_channel_ban_user Global vx_resp_channel_get_banned_users_t

• This is deprecated and should not be used. The response for vx_req_channel_get_banned_users

Global vx_resp_channel_set_lock_mode_t

This is deprecated and should not be used. The response for vx_req_channel_set_lock_mode Global vx_resp_connector_initiate_shutdown::client_name

• This is deprecated and should not be used.

Global vx_resp_connector_set_local_mic_volume_t

• Use vx_resp_aux_set_mic_level instead. The response for vx_req_connector_set_local_mic_volume

Global vx_resp_connector_set_local_speaker_volume_t

• Use vx_resp_aux_set_speaker_level instead. The response for vx_req_connector_set_local_speaker_volume

Global vx_resp_session_create_t

• This is deprecated and should not be used. The response for vx_req_session_create

Global vx_resp_session_send_dtmf_t

This is deprecated and should not be used. The response for vx_req_session_send_dtmf Global vx_resp_session_set_local_speaker_volume_t

• Use vx_req_aux_set_speaker_level_t instead. The response for vx_req_session_set_local_speaker_volume_t

Global vx_resp_sessiongroup_create_t

This is deprecated and should not be used. The response for vx_req_sessiongroup_create Global vx_resp_sessiongroup_get_stats::codec_mode

• This is deprecated and should not be used.

Global vx_resp_sessiongroup_get_stats::current_bars

• This is deprecated and should not be used. An indication of the network quality in the range of 1-5, with 5 indicating the best quality.

Global vx_resp_sessiongroup_terminate_t

• This is deprecated and should not be used. The response for vx_req_sessiongroup_terminate

Global vx_sdk_config::default_render_to_receiver

• Do not use this parameter, because it has no effect. By default, audio output goes to the mobile device's speakers, unless the value is set to 1. On the iOS platform, when the audio session is set to the category "PlayAndRecord", the receiver, which is the mobile device speaker that is put to your ear for voice calls, is used.

Global vx_sdk_config::enable_advanced_auto_levels

• Do not use this parameter, because it has no effect. Enable advanced automatic setting of audio levels.

Global vx_sdk_config::mic_makeup_gain

• Do not use this parameter, because it has no effect. For platforms with soft mics, apply linear gain in dB before processing.

Global vx_sdk_config::num_codec_threads

• Do not use this parameter, because it has no effect. The number of threads used for encoding and decoding audio.

Global vx_sdk_config::num_voice_threads

• Do not use this parameter, because it has no effect. The number of threads used for voice processing.

Global vx_sdk_config::num_web_threads

• Do not use this parameter, because it has no effect. The number of threads used for web requests.

Global vx_sdk_config::pf_request_permission_for_network )(void)

• This function pointer is unused and is never called.

Global vx_sdk_config::preferred_sip_port

Do not use this parameter, because it has no effect. The preferred server SIP port. Set this parameter by using the environment variable "VIVOX_PREFERRED_SIP_PORT". For development purposes, setting this parameter to a value of 0 will use the network configuration.