EOS_Lobby_CreateLobby

EOS API reference page for EOS_Lobby_CreateLobby

3 분 소요

This function is part of the Lobby Interface.

Remarks

Creates a lobby and adds the user to the lobby membership. There is no data associated with the lobby at the start and can be added vis EOS_Lobby_UpdateLobbyModification If the lobby is successfully created with 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 creation completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_LimitExceeded if the number of allowed lobbies is exceeded

Parameters

EOS_Lobby_CreateLobby

Parameter Type And NameUsage Information
EOS_HLobby Handle
const EOS_Lobby_CreateLobbyOptions* OptionsRequired fields for the creation of a lobby such as a user count and its starting advertised state
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Lobby_OnCreateLobbyCallback CompletionDelegateA callback that is fired when the create operation completes, either successfully or in error

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_CreateLobby

Callback Parameters

EOS_Lobby_OnCreateLobbyCallback

Parameter Type And NameUsage Information
const EOS_Lobby_CreateLobbyCallbackInfo* DataA EOS_Lobby_CreateLobby CallbackInfo containing the output information and result