Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Transmission

Learn how transmission changed in the upgrade.
Read time 1 minuteLast updated 2 days ago

Various functions in the VivoxVoiceChat module are replaced by the functionality of Transmission. For code examples and usage notes, see Transmission. The following list provides the name of the function in the VivoxVoiceChat module, the comparable function in VivoxCore, and supplemental information for completing a version switch.
  • TransmitToAllChannels()
    is replaced by
    SetTransmissionMode(TransmissionMode::All)
    • Calling ILoginSession::SetTransmissionMode(TransmissionMode::All) on an ILoginSession causes it to transmit to all connected channels.
  • TransmitToNoChannels()
    is replaced by
    SetTransmissionMode(TransmissionMode::None)
    • Calling ILoginSession::SetTransmissionMode(TransmissionMode::None) stops the ILoginSession from transmitting to any channel.
  • TransmitToSpecificChannel()
    is replaced by
    SetTransmissionMode(TransmissionMode::Single, ChannelId singleChannel)
    • Calling ILoginSession::SetTransmissionMode(TransmissionMode::Single, ChannelId singleChannel) with TransmissionMode::Single and a ChannelId that the ILoginSession is connected to makes it transmit to that channel.
  • GetTransmitMode()
    is replaced by
    GetTransmissionMode()
    • Calling ILoginSession::GetTransmissionMode() on an ILoginSession returns the TransmissionMode that the ILoginSession is currently in.
  • GetTransmitChannel()
    is replaced by
    GetTransmittingChannels(), IsTransmitting()
    • Calling ILoginSession::GetTransmittingChannels() on an ILoginSession returns an array of all ChannelIds that the login session is transmitting to. You can also call IChannelSession::IsTransmitting() on a specific IChannelSession to see if it is currently being transmitted into.