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
  • Reference
  • Privacy overview
  1. Vivox Core SDK documentation

Initial implementation check list

Review implementation requirements and checklist.
Read time 1 minute
Last updated 8 months ago

The following list details a condensed version of the tasks that are required for completing a basic Vivox voice integration. For a more in-depth explanation follow the Integration guide.
  1. Add Vivox DLLs and header files to the client build process.
  2. Select a client code path for logging the user in to the Vivox network (for example, a character sign-in, a lobby, or a match). See Planning and organization for more details on in-game flows.
  3. Use anonymous logins and the echo channel (
    sip:confctl-2@\<your vivox domain>
    ) until basic integration testing is complete.
  4. Add console commands to perform the following actions:
    • Set the render device volume
    • Set the microphone volume
    • Mute and unmute the microphone
    • Set a push-to-talk (PTT) key
    • Set the Vivox log level for debugging purposes
    • Optional: Dynamically join a channel when a SIP URI is provided as a parameter
  5. Switch to enforced access-token-authenticated logins after basic settings have been tested and are verified to be working.
  6. If you are using 3D channels, send positional updates for the channel by using the Vivox APIs as necessary (not for every frame).
  7. Create a code handler for the
    vx_evt_account_login_state_change
    event.
  8. Create a code handler for the
    vx_evt_media_stream_updated
    event, check
    status_code
    and
    status_string
    .
    This handles a disconnected state, such as a voice server dropping an end user.
  9. Create a code handler for the
    vx_evt_participant_updated
    event for speaking indicators.
  10. Update the existing event handlers to update UI elements to reflect the correct state and expose the User settings you created.

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.


    Report a problem with this page