EOS_RTC_JoinRoom

EOS API reference page for EOS_RTC_JoinRoom

Choose your implementation method:

C

C#

This function is part of the RTC Interface.

Remarks

Use this function to join a room. 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.

Parameters

EOS_RTC_JoinRoom

Parameter Type And Name

Usage Information

EOS_HRTC Handle

const EOS_RTC_JoinRoomOptions* Options

structure containing the parameters for the operation.

void* ClientData

Arbitrary data that is passed back in the CompletionDelegate

const EOS_RTC_OnJoinRoomCallback CompletionDelegate

a callback that is fired when the async 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.

Callback Function Information

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

Callback Remarks

Callback for completion of room join request.

Callback Parameters

EOS_RTC_OnJoinRoomCallback

Parameter Type And Name

Usage Information

const EOS_RTC_JoinRoomCallbackInfo* Data

Related API Members

This function is part of the RTC Interface.

Remarks

Use this function to join a room. This function does not need to called for the Lobby RTC Room system; doing so will return {Result.AccessDenied}. The lobby system will automatically join and leave RTC Rooms for all lobbies that have RTC rooms enabled.

Parameters

RTC.RTCInterface.JoinRoom

Parameter Type And Name

Usage Information

JoinRoomOptions options

structure containing the parameters for the operation.

object clientData

Arbitrary data that is passed back in the CompletionDelegate

OnJoinRoomCallback completionDelegate

a callback that is fired when the async 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 object 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.

Callback Function Information

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

Callback Remarks

Callback for completion of room join request.

Callback Parameters

RTC.OnJoinRoomCallback

Parameter Type And Name

Usage Information

JoinRoomCallbackInfo data

Related API Members