Initial implementation check list
Review implementation requirements and checklist.
Read time 1 minuteLast updated 20 hours 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.
- Add Vivox DLLs and header files to the client build process.
- 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.
-
Use anonymous logins and the echo channel () until basic integration testing is complete.
sip:confctl-2@\<your vivox domain> -
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
- Switch to enforced access-token-authenticated logins after basic settings have been tested and are verified to be working.
- If you are using 3D channels, send positional updates for the channel by using the Vivox APIs as necessary (not for every frame).
-
Create a code handler for the event.
vx_evt_account_login_state_change -
Create a code handler for the event, check
vx_evt_media_stream_updatedandstatus_code. This handles a disconnected state, such as a voice server dropping an end user.status_string -
Create a code handler for the event for speaking indicators.
vx_evt_participant_updated - Update the existing event handlers to update UI elements to reflect the correct state and expose the User settings you created.