This function is part of the Lobby Interface.
Join a lobby, creating a local instance under a given lobby ID. Backend will validate various conditions to make sure it is possible to join the lobby.
If the lobby is successfully join has an RTC Room enabled, the lobby system will automatically join and maintain the connection to the RTC room as long as the
local user remains in the lobby. Applications can use the EOS_Lobby_GetRTCRoomName to get the name of the RTC Room associated with a lobby, which may be used with
many of the EOS_RTC_* suite of functions. This can be useful to: register for notifications for talking status; to mute or unmute the local user's audio output;
to block or unblock room participants; to set local audio device settings; and more.
Return Value
Parameters
Lobby.LobbyInterface.JoinLobby
Parameter Type And Name
|
Usage Information
|
JoinLobbyOptions options
|
Structure containing information about the lobby to be joined
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
OnJoinLobbyCallback completionDelegate
|
A callback that is fired when the join operation completes, either successfully or in error
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate
parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void*
parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnJoinLobbyCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Lobby_JoinLobby
Callback Parameters
Lobby.OnJoinLobbyCallback
Parameter Type And Name
|
Usage Information
|
JoinLobbyCallbackInfo data
|
A EOS_Lobby_JoinLobby CallbackInfo containing the output information and result
|