Documentation

Support

Vivox Core SDK

Vivox Core SDK

UI integration

Recommended voice related UI elements for your game interface.
Read time 1 minuteLast updated 16 days ago

Depending on the configuration and the number of voice communication features in your game, you must create various UI elements to display feedback for settings like volume and speaking indicators. Users also need access to controls for voice-related actions like configuring a microphone or loudspeaker, locally muting users, and selecting input and output devices.

Recommended in-game UI elements

Roster VoIP IndicatorThis lets the user know if a team member is in voice chat.
Roster Speaking IndicatorThis allows the user to know which team member is speaking at any given time. It is also good to have a speaking indicator on the other characters or above their head. This allows for quick identification of who is speaking.
Roster Mute button for each team memberThis allows the user to mute someone if there is either communications that they do not want to hear or to eliminate background noise.
Self-mute buttonThis allows a user to quickly mute themselves.
The Vivox Client API operates by using a series of requests, responses, and generated events. After you create the UI elements, you can attach them to the signaling of requests or the processing of associated responses or events. For more information, refer to the following UI examples.