Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Core SDK

Vivox Core SDK

Vivox
​
​
Vivox Core SDK
  • Overview
  • Before you begin
  • Get started
  • Release notes
  • Developer Guide
    • Client SDK basics
      • Initialize the Vivox SDK
      • Handle messages
      • Message types
      • Character encoding
      • Requests and responses
      • Create the connector object
      • Sign in to a game
      • Sign out of a game
      • Uninitialize the Vivox SDK
    • Channels
    • Presence management
    • Messaging
    • Manage audio
    • Couch co-op
    • Android app development
    • iOS app development
    • macOS app development
    • Windows app development
    • Real-time recording
    • Speech-to-text audio transcription
    • Text-to-speech
    • Troubleshooting
  • Reference
  • Privacy overview
  1. Vivox Core SDK documentation

Create the connector object

How to create the connector object to fetch server configuration information.
Read time 2 minutes
Last updated 8 months ago
Use a connector object after initialization to fetch server configuration information necessary for your game to login and use Vivox. The connector object is usually only called once per application startup before the first sign in.
To create the connector object, use the 
vx_req_connector_create
request structure and the 
vx_req_connector_create_create()
function. This is typically the first request issued after 
vx_initialize3()
.
Note
There can only be one active connector object at a time.
When the Vivox SDK processes the 
vx_req_connector_create
request, it contacts the Vivox network and downloads configuration information to the client that's relevant to your game's communications infrastructure. This is a one-time HTTP request. The configuration information is loaded into memory before the sign in operation.
If the game's connection is lost, you don't need to issue 
vx_req_connector_create
a second time because the information is already in memory. Simply proceed to re-sign in to the game.
The connector object doesn't hold open any ports, use bandwidth, network resources, or CPU for heartbeats, and only requires a small amount of memory to hold the configuration.
The following code displays an example creating the connector object:
vx_req_connector_create *req;vx_req_connector_create_create(&req);req->connector_handle = vx_strdup("c1");req->acct_mgmt_server = vx_strdup("https://mt1s.www.vivox.com/api2/");int request_count;int vx_issue_request3_response = vx_issue_request3(&req->base, &request_count);
Note
To use the connector object effectively, it's important to understand that the connector object doesn't establish a persistent connection to the Vivox back end that needs to be maintained while using the service.
After the game receives the 
vx_resp_connector_create
message, the game can then sign in to Vivox.

Disconnect the connector object

Disconnecting the connector object unloads the configuration file from memory. You can disconnect the object by using the 
vx_req_connector_initiate_shutdown
request.
Note
It's never necessary to call 
vx_req_connector_initiate_shutdown
unless you intend to change which Vivox back end you connect to after the initial connection.
Use 
vx_uninitialize()
 instead of 
vx_req_connector_initiate_shutdown
on application exit to clean up Vivox resources.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • Disconnect the connector object

Report a problem with this page