文档

支持

Vivox Core SDK

Vivox Core SDK

Roster list

Add a roster list to show players who is online.
阅读时间1 分钟最后更新于 12 天前

A roster list allows players to see who is online or in-game. If you require a roster list, create a code handler for the
vx_participant_added
event updates to the roster list you create.
  • Hooking this event is the best way to confirm that the user is in the channel that they joined.
  • The account name field is the user's Vivox account name.
When creating a roster list, determine how to display users:
  • Can an existing lobby/match/region roster list be used?
    • Will there be an active speaker indication, and if so, where?
    • In the roster list.
  • Rendered in game, usually over a character's head or by flashing a game piece representing that user.
  • Will users be allowed to set the local volume for individual users in their roster list?
  • Will users be allowed to mute or unmute an individual user in their roster list?
  • Will a text ignore setting also apply to voice? (Recommended)