This function is part of the Lobby Interface.
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 Name
|
Usage Information
|
EOS_HLobby Handle
|
|
const EOS_Lobby_CreateLobbyOptions* Options
|
Required fields for the creation of a lobby such as a user count and its starting advertised state
|
void* ClientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
const EOS_Lobby_OnCreateLobbyCallback CompletionDelegate
|
A callback that is fired when the create 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_OnCreateLobbyCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Lobby_CreateLobby
Callback Parameters
EOS_Lobby_OnCreateLobbyCallback
Parameter Type And Name
|
Usage Information
|
const EOS_Lobby_CreateLobbyCallbackInfo* Data
|
A EOS_Lobby_CreateLobby CallbackInfo containing the output information and result
|
This function is part of the Lobby Interface.
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
Lobby.LobbyInterface.CreateLobby
Parameter Type And Name
|
Usage Information
|
CreateLobbyOptions options
|
Required fields for the creation of a lobby such as a user count and its starting advertised state
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
OnCreateLobbyCallback completionDelegate
|
A callback that is fired when the create 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_OnCreateLobbyCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_Lobby_CreateLobby
Callback Parameters
Lobby.OnCreateLobbyCallback
Parameter Type And Name
|
Usage Information
|
CreateLobbyCallbackInfo data
|
A EOS_Lobby_CreateLobby CallbackInfo containing the output information and result
|
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no