Deprecated List

• This is deprecated and should not be used.

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

• 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.

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

• Use VIVOX_V_V2_AUDIO_DATA_MONO_SIREN14_32000_EXPANDED instead of VIVOX_V_V2_AUDIO_DATA_MONO_SIREN14_32000.

• PCMU functionality has been removed. Please discontinue use.

• This is deprecated and should not be used.

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

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

• This is deprecated and should not be used.

• This is deprecated and should not be used.

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

• This is deprecated and should not be used.

• This is deprecated and should not be used.

• This is deprecated and should not be used.

• Use displayname instead.

• This is deprecated and should not be used.

• This is deprecated and should not be used.

• This is deprecated and should not be used.

• This is deprecated and should not be used.

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

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

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

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

• 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.

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

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

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

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

• 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.

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

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

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

• 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

• This field is not used.

• This flag does not affect anything.

• 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.

• This is deprecated and should not be used.

• 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.

• 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.

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

• This is deprecated and should not be used.

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

• This is deprecated and should not be used.

• 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.

• Debug use only.

• 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.

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

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

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

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

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

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

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

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

• 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.

• Do not use.

• Use the configured_codecs field instead. The default codec.

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

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

• This is deprecated and should not be used.

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

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

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

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

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

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

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

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

• 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.

• This is deprecated and should not be used.

• 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.

• 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.

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

• 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.

• This is deprecated and should not be used.

• 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.

• Do not use. This structure member is ignored.

• This is deprecated and should not be used.

• Do not use. This structure member is ignored.

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

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

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

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

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

• Do not use. This structure member is ignored.

• Do not use. This structure member is ignored.

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

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

• 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.

• 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.

• This field is deprecated and should not be used.

• This field is ignored.

• This field is ignored.

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

• 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).

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

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

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

• This is deprecated and should not be used.

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

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

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

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

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

• Use vx_req_account_anonymous_login instead. The response for vx_req_account_authtoken_login

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

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

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

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

• This is deprecated and should not be used.

• Use vx_resp_aux_set_mic_level instead. The response for vx_req_connector_set_local_mic_volume

• Use vx_resp_aux_set_speaker_level instead. The response for vx_req_connector_set_local_speaker_volume

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

• Use vx_req_aux_set_speaker_level_t instead. The response for vx_req_session_set_local_speaker_volume_t

• This is deprecated and should not be used.

• 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.

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

• 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.

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

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

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

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

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

• This function pointer is unused and is never called.