Documentation

Support

Vivox Core SDK

Vivox Core SDK

Join a channel

Follow this workflow to join a Vivox channel and enable voice or text communication.
Read time 1 minuteLast updated 2 months ago
To join a channel, the game uses the 
vx_req_sessiongroup_add_session
message and the channel URI that is generated by the game that maps to an audio element in the game.
Note
Developers must ensure that their game checks the permissions for the capture device at runtime before it join a Vivox voice channel on desktop or mobile.
Joining a channel requires an access token. For more information, refer to the Access Token Developer Guide. The game can choose to join a channel with audio capability, which enables the player to participate in group audio. The game can also choose to join a channel with text capability, which enables the player to participate in group text.
Note
A user can join a maximum of 10 non-positional channels at a time. Attempts to join a channel beyond that limit fail with a 
VxXmppServerErrorServiceUnavailable (20502)
error.
Note
Channels have a maximum occupancy of 200 participants. Attempts to join a channel that has reached 200 participants will fail with a 
VxXmppServerErrorServiceUnavailable (20502)
error.