vx_req_connector_create
Reference the Vivox Core SDK API.
Read time 5 minutesLast updated a day ago
Connect the application to the Vivox service. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| char * | client_name |
| char * | acct_mgmt_server The URL for the Vivox account management server. |
| int | minimum_port An optional parameter that specifies the minimum UDP source port for the SDK to use. |
| int | maximum_port An optional parameter that specifies the maximum UDP source port for the SDK to use. |
| vx_attempt_stun | attempt_stun Control how the SDK attempts to traverse NAT devices. |
| vx_connector_mode | mode Specify which mode to start the connector in: connector_mode_legacy or connector_mode_normal. |
| char * | log_folder The folder where logs are created. |
| char * | log_filename_prefix The prefix that is prepended to each log file. |
| char * | log_filename_suffix The suffix or extension that is appended to each log file. |
| int | log_level Specify the log level for the Vivox SDK to use. |
| vx_session_handle_type | session_handle_type The type of session handle to generate. |
| char * | application A unique string value that identifies the application that is integrated with the SDK. |
| int | max_calls The maximum number of calls that can be active at any one time. |
| int | allow_cross_domain_logins Determine whether to allow cross-domain logins. |
| int | default_codec |
| char * | user_agent_id A unique alphanumeric-only string value that identifies the application that is integrated with the SDK. |
| char * | media_probe_server Enter a server by using the following format: ip-address:starting-port. |
| char * | http_proxy_server_name The DNS name of an HTTP proxy server to use to successfully connect to the account management server. |
| int | http_proxy_server_port The port that the HTTP proxy server is listening on. |
| int | enable_duplicate_participant_uris |
| char * | connector_handle The preferred connector handle. |
| unsigned int | configured_codecs A bitmask that specifies the set of codecs that this application permits. |
Detailed Description
Connect the application to the Vivox service. See: vx_resp_connector_createstruct vx_req_connector_create;
Public Attributes Documentation
variable base
The common properties for all requests.vx_req_base_t base;
variable client_name
Deprecated: Do not use.char * client_name;
variable acct_mgmt_server
The URL for the Vivox account management server. Note: This value is provided by Vivox.char * acct_mgmt_server;
variable minimum_port
An optional parameter that specifies the minimum UDP source port for the SDK to use. If the value is 0 (the recommended setting), then the Vivox SDK uses ephemeral ports assigned by the operating system. If a range of ports on the client needs to be specified (this is not recommended), then enter the minimum port number and the maximum port number to create a range of ports for the Vivox SDK.int minimum_port;
- The specified range must be at least 32 ports.
- Only ports above 1024 are allowed. minimum_port and maximum_port should both be set to 0 or both be set to a specific port range.
variable maximum_port
An optional parameter that specifies the maximum UDP source port for the SDK to use. If the value is 0 (the recommended setting), then the Vivox SDK uses ephemeral ports assigned by the operating system. If a range of ports on the client needs to be specified (this is not recommended), then enter the minimum port number and the maximum port number to create a range of ports for the Vivox SDK.int maximum_port;
- The specified range must be at least 32 ports.
- Only ports above 1024 are allowed. minimum_port and maximum port should both be set to 0 or both be set to a specific port range.
variable attempt_stun
Control how the SDK attempts to traverse NAT devices.vx_attempt_stun attempt_stun;
variable mode
Specify which mode to start the connector in: connector_mode_legacy or connector_mode_normal. The default setting is connector_mode_normal.vx_connector_mode mode;
variable log_folder
The folder where logs are created.char * log_folder;
variable log_filename_prefix
The prefix that is prepended to each log file.char * log_filename_prefix;
variable log_filename_suffix
The suffix or extension that is appended to each log file.char * log_filename_suffix;
variable log_level
Specify the log level for the Vivox SDK to use.int log_level;
- -1: NONE - No logging.
- 0: ERROR - Log errors only.
- 1: WARNING - Log errors and warnings.
- 2: INFO - Log errors, warnings, and info.
- 3: DEBUG - Log errors, warnings, info, and debug.
- 4: TRACE - Verbose logging. Likely to have significant performance implications.
- 5: ALL - Log almost everything. Very likely to have significant performance implications.
variable session_handle_type
The type of session handle to generate.vx_session_handle_type session_handle_type;
variable application
A unique string value that identifies the application that is integrated with the SDK. Note: This is an optional value that is provided by Vivox. Any value passed in on this field is present on events received by others that pertain to your identity:char * application;
- vx_evt_message_t
- vx_evt_subscription_t
- vx_evt_buddy_presence_t
- vx_evt_session_added_t
variable max_calls
The maximum number of calls that can be active at any one time.int max_calls;
- The default is 3
- The minimum is 2
- The maximum is 1000 Each call is preallocated at a cost of 56K per call.
variable allow_cross_domain_logins
Determine whether to allow cross-domain logins.int allow_cross_domain_logins;
variable default_codec
Deprecated: Use the configured_codecs field instead. The default codec.int default_codec;
variable user_agent_id
A unique alphanumeric-only string value that identifies the application that is integrated with the SDK. Note: This is an optional value. This value is restricted to alphanumeric characters only, and is limited to three characters. Any value passed in on this field is present on SIP messages in the user agent string. Attention: Do not set this value unless instructed to by your Vivox representative.char * user_agent_id;
variable media_probe_server
Enter a server by using the following format: ip-address:starting-port.char * media_probe_server;
variable http_proxy_server_name
The DNS name of an HTTP proxy server to use to successfully connect to the account management server.char * http_proxy_server_name;
variable http_proxy_server_port
The port that the HTTP proxy server is listening on. If no value is set, then this defaults to 80.int http_proxy_server_port;
variable enable_duplicate_participant_uris
Deprecated: This is deprecated and should not be used. Handle multiple participants with the same SIP URI more gracefully in a channel.int enable_duplicate_participant_uris;
variable connector_handle
The preferred connector handle. Attention: This cannot match any existing handle (for example, account_handle or session_handle). This is a string. This must include at least one non-numeric character. If this is empty, then a handle is automatically generated.char * connector_handle;
variable configured_codecs
A bitmask that specifies the set of codecs that this application permits. This should be one or a combination of values from the vx_codec enumeration.unsigned int configured_codecs;