EOS_RTC_AddNotifyDisconnected

EOS API reference page for EOS_RTC_AddNotifyDisconnected

2 분 소요

This function is part of the RTC Interface.

Remarks

Register to receive notifications when disconnected from the room. If the returned NotificationId is valid, you must call EOS_RTC_RemoveNotifyDisconnected when you no longer wish to have your CompletionDelegate called. This function will always return EOS_INVALID_NOTIFICATIONID when used with lobby RTC room. To be notified of the connection status of a Lobby-managed RTC room, use the EOS_Lobby_AddNotifyRTCRoomConnectionChanged function instead.

Return Value

Notification ID representing the registered callback if successful, an invalid NotificationId if not

See Also

EOS_INVALID_NOTIFICATIONID, EOS_RTC_RemoveNotifyDisconnected

Parameters

EOS_RTC_AddNotifyDisconnected

Parameter Type And NameUsage Information
EOS_HRTC Handle
const EOS_RTC_AddNotifyDisconnectedOptions* Options
void* ClientDataArbitrary data that is passed back in the CompletionDelegate
const EOS_RTC_OnDisconnectedCallback CompletionDelegateThe callback to be fired when a presence change occurs

Callback Function Information

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

Callback Parameters

EOS_RTC_OnDisconnectedCallback

Parameter Type And NameUsage Information
const EOS_RTC_DisconnectedCallbackInfo* DataThis struct is passed in with a call to EOS_RTC_AddNotifyDisconnected registered event.