EOS_RTC_AddNotifyParticipantStatusChanged

EOS API reference page for EOS_RTC_AddNotifyParticipantStatusChanged

Choose your implementation method:

C

C#

This function is part of the [RTC Interface](Interfaces/RTC).

Remarks

Register to receive notifications when a participant's status changes (e.g: join or leave the room). If the returned NotificationId is valid, you must call EOS_RTC_RemoveNotifyParticipantStatusChanged when you no longer wish to have your CompletionDelegate called. If you register to this notification before joining a room, you will receive a notification for every member already in the room when you join said room. This allows you to know who is already in the room when you join. To be used effectively with a Lobby-managed RTC room, this should be registered during the EOS_Lobby_CreateLobby or EOS_Lobby_JoinLobby completion callbacks when the ResultCode is EOS_Success. If this notification is registered after that point, it is possible to miss notifications for already-existing room participants.

This notification is also raised when the local user joins the room, but NOT when the local user leaves the room.

Return Value

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

See Also

EOS_INVALID_NOTIFICATIONID, EOS_RTC_RemoveNotifyParticipantStatusChanged

Parameters

EOS_RTC_AddNotifyParticipantStatusChanged

Parameter Type And Name

Usage Information

EOS_HRTC Handle

EOS_RTC_AddNotifyParticipantStatusChangedOptions* Options

void* ClientData

Arbitrary data that is passed back in the CompletionDelegate

const EOS_RTC_OnParticipantStatusChangedCallback CompletionDelegate

The callback to be fired when a presence change occurs

This function enables your callback (the CompletionDelegate parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.

Callback Function Information

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

Callback Parameters

EOS_RTC_OnParticipantStatusChangedCallback

Parameter Type And Name

Usage Information

const EOS_RTC_ParticipantStatusChangedCallbackInfo* Data

This struct is passed in with a call to EOS_RTC_AddNotifyParticipantStatusChanged registered event.

Related API Members

This function is part of the [RTC Interface](Interfaces/RTC).

Remarks

Register to receive notifications when a participant's status changes (e.g: join or leave the room). If the returned NotificationId is valid, you must call EOS_RTC_RemoveNotifyParticipantStatusChanged when you no longer wish to have your CompletionDelegate called. If you register to this notification before joining a room, you will receive a notification for every member already in the room when you join said room. This allows you to know who is already in the room when you join. To be used effectively with a Lobby-managed RTC room, this should be registered during the EOS_Lobby_CreateLobby or EOS_Lobby_JoinLobby completion callbacks when the ResultCode is EOS_Success. If this notification is registered after that point, it is possible to miss notifications for already-existing room participants.

This notification is also raised when the local user joins the room, but NOT when the local user leaves the room.

Return Value

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

See Also

EOS_INVALID_NOTIFICATIONID, EOS_RTC_RemoveNotifyParticipantStatusChanged

Parameters

RTC.RTCInterface.AddNotifyParticipantStatusChanged

Parameter Type And Name

Usage Information

AddNotifyParticipantStatusChangedOptions options

object clientData

Arbitrary data that is passed back in the CompletionDelegate

OnParticipantStatusChangedCallback completionDelegate

The callback to be fired when a presence change occurs

This function enables your callback (the CompletionDelegate parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.

Callback Function Information

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

Callback Parameters

RTC.OnParticipantStatusChangedCallback

Parameter Type And Name

Usage Information

ParticipantStatusChangedCallbackInfo data

This struct is passed in with a call to EOS_RTC_AddNotifyParticipantStatusChanged registered event.

Related API Members