Documentation

Support

Vivox Core SDK

Vivox Core SDK

Verify your implementation

Learn about verify your implementation.
Read time 1 minuteLast updated 20 hours ago
Goal: Confirm that Vivox is initializing successfully. Run through these steps to verify your implementation:
  1. Launch your client application. Navigate past the point where the Vivox SDK should be initialized.
  2. Set a break point on the SDK message callback or observe a client log file.
  3. Add or remove an audio headset multiple times.
  4. Observe that the listener wakes up and vx_get_message() retrieves events.
  5. Navigate past the point where the connector_create request is submitted.
  6. Verify that the message callback picks up a vx_resp_connector_create response.
  7. Rerun the connector_create test with no internet connection, verify that error handling and logging work as expected.
When your game client receives an event from the Vivox SDK, your first step is to evaluate if it was successful. For the initialization process, check for success with the connector_create call. If successful, the status_code field will be 0. If it is not zero, your game client should follow the below steps to initiate a retry.

If connector_create is unsuccessful

  1. Print an error to debug log or the client event capture location.
  2. Attempt to retry vx_req_connector_create initialization.
  3. Delay for 10 seconds between retries.
  4. After 5 retries, give up, and inform the user that voice chat services are not available.
  5. Retry on the next match or party invite or in 15 minutes, whichever comes first.
  6. Write the failure to a client log or a server log. Include the status_code
Once you have confirmed that Vivox is initializing properly you can continue on to Logging in.