Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_account_set_login_properties

Reference the Vivox Core SDK API.
Read time 1 minuteLast updated 20 hours ago

Set some of the properties passed in on the login command. More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
VX_HANDLEaccount_handle
The handle returned from a successful login request.
vx_session_answer_modeanswer_mode
intparticipant_property_frequency
An integer that specifies the maximum number of participant property events the SDK sends while in a channel.

Detailed Description

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

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable account_handle

VX_HANDLE account_handle;
The handle returned from a successful login request.

variable answer_mode

vx_session_answer_mode answer_mode;
Deprecated: 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.

variable participant_property_frequency

int participant_property_frequency;
An integer that specifies the maximum number of participant property events the SDK sends while in a channel. If this is set, then the SDK attempts to generate an event at the given frequency, but does not generate two identical events in a row. If this is not set, then the default is "on state change", which means that events are sent when the participant starts talking, stops talking, is muted, or is unmuted. The following list details valid values for this integer:
  • 0 - Never
  • 5 - 10 times per second
  • 10 - 5 times per second
  • 50 - 1 time per second
  • 100 - On participant state change (this is the default)