This function is part of the RTC Interface.
Remarks
Use this function to leave a room and clean up all the resources associated with it. This function has to always be called when the room is abandoned even if the user is already disconnected for other reasons. This function does not need to called for the Lobby RTC Room system; doing so will return EOS_AccessDenied. The lobby system will automatically join and leave RTC Rooms for all lobbies that have RTC rooms enabled.
Return Value
-
EOS_Success if the operation succeeded
-
EOS_InvalidParameters if any of the parameters are incorrect
-
EOS_NotFound if not in the specified room
Parameters
EOS_RTC_LeaveRoom
Parameter Type And Name | Usage Information |
---|---|
EOS_HRTC Handle | |
const EOS_RTC_LeaveRoomOptions* Options | structure containing the parameters for the operation. |
void* ClientData | Arbitrary data that is passed back in the CompletionDelegate |
const EOS_RTC_OnLeaveRoomCallback CompletionDelegate | a callback that is fired when the async operation completes, either successfully or in error |
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_RTC_OnLeaveRoomCallback to report the results of its operation.
Callback Remarks
Callback for completion of room leave request.
Callback Parameters
EOS_RTC_OnLeaveRoomCallback
Parameter Type And Name | Usage Information |
---|---|
const EOS_RTC_LeaveRoomCallbackInfo* Data |