Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Join a channel

Follow this workflow to join a Vivox channel and enable voice or text communication.
Read time 1 minuteLast updated 2 days ago

To join a channel, use the IChannelSession::BeginConnect() method on an IChannelSession that you create by using a game-selected identifier for the channel and a channel type. Joining a channel requires an access token.For more information, refer to the Access Token Developer Guide. When joining a channel, the game can choose whether to join with audio capability, which enables the player to participate in group audio, and whether to join text capability, which enables the player to participate in group text. This is set with the
connectAudio
and
connectText
arguments to
BeginConnect()
, respectively. You can add or drop these capabilities without having to leave or rejoin the channel by calling IChannelSession::BeginSetAudioConnected() or IChannelSession::BeginSetTextConnected().
You can also set the argument
switchTransmission
to
true
to automatically switch audio transmission into only the new channel when connected. This overrides and changes the TransmissionMode that is set in ILoginSession. You can manage channel transmission at any time by using ILoginSession::SetTransmissionMode().