EOS API reference page for EOS_Lobby_JoinLobby


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

  • EOS_Success if the destroy completes successfully

  • EOS_InvalidParameters if any of the options are incorrect



Parameter Type And NameUsage Information
EOS_HLobby Handle
const EOS_Lobby_JoinLobbyOptions* OptionsStructure containing information about the lobby to be joined
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Lobby_OnJoinLobbyCallback CompletionDelegateA callback that is fired when the join operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnJoinLobbyCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_JoinLobby

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Lobby_JoinLobbyCallbackInfo* DataA EOS_Lobby_JoinLobby CallbackInfo containing the output information and result