This function is part of the Lobby Interface.
Register to receive notifications of when the RTC Room for a particular lobby has a connection status change.
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 notification is entirely informational and requires no action in response by the application. If the connected status is offline
(bIsConnected is EOS_FALSE), the connection will automatically attempt to reconnect. The purpose of this notification is to allow
applications to show the current connection status of the RTC room when the connection is not established.
Unlike EOS_RTC_AddNotifyDisconnected, EOS_RTC_LeaveRoom should not be called when the RTC room is disconnected.
This function will only succeed when called on a lobby the local user is currently a member of.
Return Value
A valid notification ID if the NotificationFn was successfully registered, or EOS_INVALID_NOTIFICATIONID if the input was invalid, the lobby did not exist, or the lobby did not have an RTC room.
See Also
EOS_Lobby_RemoveNotifyRTCRoomConnectionChanged
Parameters
Lobby.LobbyInterface.AddNotifyRTCRoomConnectionChanged
Parameter Type And Name
|
Usage Information
|
AddNotifyRTCRoomConnectionChangedOptions options
|
Structure containing information about the lobby to receive updates about
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate.
|
OnRTCRoomConnectionChangedCallback notificationFn
|
The function to call if the RTC Room's connection status changes
|
This function enables your callback (the NotificationFn
parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.
Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnRTCRoomConnectionChangedCallback to report the results of its operation.
Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyRTCRoomConnectionChanged
Callback Parameters
Lobby.OnRTCRoomConnectionChangedCallback
Parameter Type And Name
|
Usage Information
|
RTCRoomConnectionChangedCallbackInfo data
|
containing the connection state of the RTC Room for a lobby
|