EOS API reference page for EOS_Lobby_IsRTCRoomConnected

2 mins to read

This function is part of the Lobby Interface.


Get the current connection status of the RTC Room for a lobby. The RTC Room connection status is independent of the lobby connection status, however the lobby system will attempt to keep them consistent, automatically connecting to the RTC room after joining a lobby which has an associated RTC room and disconnecting from the RTC room when a lobby is left or disconnected. This function will only succeed when called on a lobby the local user is currently a member of.

Return Value

  • EOS_Success if we are connected to the specified lobby, the input options and parameters were valid and we were able to write to bOutIsConnected successfully.

  • EOS_NotFound if the lobby doesn't exist

  • EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created

  • EOS_InvalidParameters if bOutIsConnected is NULL, or any other parameters are NULL or invalid

See Also




Parameter Type And NameUsage Information
EOS_HLobby Handle
const EOS_Lobby_IsRTCRoomConnectedOptions* OptionsStructure containing information about the lobby to query the RTC Room connection status for
EOS_Bool* bOutIsConnectedIf the result is EOS_Success, this will be set to EOS_TRUE if we are connected, or EOS_FALSE if we are not yet connected.