Meeting Participant helper event callback. More...

#include <IParticipantHelper.h>

Public Member Functions
virtual	~IParticipantHelperSink ()

virtual void	OnInitMeetingParticipants (const std::vector< MeetingParticipant > &participants, int32_t totalParticipantsCount, bool needCleanUpUserList, ConfSessionType session)=0
	Meeting participants update notification.

virtual void	OnUserJoin (const std::vector< MeetingParticipant > &participants, ConfSessionType session)=0
	Participants join meeting notification.

virtual void	OnUserLeave (const std::vector< MeetingParticipant > &participants, ConfSessionType session)=0
	Participants leave meeting notification,.

virtual void	OnUserUpdate (const std::vector< MeetingParticipant > &participants, ConfSessionType session)=0
	Participants update notification.

virtual void	OnHostChangedNotification (int32_t hostUserID, bool amIHost, ConfSessionType session)=0
	Host changed notification.

virtual void	OnMeetingParticipantsChanged (ConfSessionType session)=0
	Participants changed notification, using GetParticipantsInMeeting with session to get latest list .

virtual void	OnUpdateHideProfilePictures (bool isHideProfilePictures)=0
	Hide profile picture update notification.

virtual void	OnHideFullRoomViewNotification (const std::vector< int32_t > &userIDs)=0
	Hide full room view notification.

virtual void	OnClaimHostNotification (ClaimHostResult result)=0
	Claim host notification.

virtual void	OnUpdateSharingAnnotationInfo (bool support, bool enable)=0
	Allow user annotate on shared content notification.

virtual void	OnAllowAttendeesRenameThemselvesNotification (bool allow)=0
	Allow attendees rename themselves notification.

virtual void	OnAllowAttendeesShareWhiteboardsNotification (bool isSupported, bool isAllowed)=0
	Allow attendees share whiteboard notification.

virtual void	OnAllowRaiseHandForAttendeeNotification (bool canRaiseHandForAttendee)=0
	Allow raise hande for attendee notification.

virtual void	OnUpdateOnZRWUserChangeNotification (ZRWUserChangeType type, int32_t zrwUserID)=0
	Zoom Room Whiteboard user change notification.

virtual void	OnUpdateHasRemoteControlAdmin (bool isAdminExist)=0
	Remote control admin exist update notification.

virtual void	OnUpdateHasRemoteControlAssistant (bool isAssistantExist)=0
	Remote control assistant exist update notification.

virtual void	OnDownloadingFinished (const std::string &localFilePath, uint32_t result)=0
	Download result.

Detailed Description

Meeting Participant helper event callback.

Definition at line 71 of file IParticipantHelper.h.

Constructor & Destructor Documentation

◆ ~IParticipantHelperSink()

virtual IParticipantHelperSink::~IParticipantHelperSink ( )

inlinevirtual

Definition at line 74 of file IParticipantHelper.h.

74{}

Member Function Documentation

◆ OnAllowAttendeesRenameThemselvesNotification()

virtual void IParticipantHelperSink::OnAllowAttendeesRenameThemselvesNotification ( bool allow )

pure virtual

Allow attendees rename themselves notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

allow TRUE indicate allow attendees rename themselves. Otherwise not.

◆ OnAllowAttendeesShareWhiteboardsNotification()

virtual void IParticipantHelperSink::OnAllowAttendeesShareWhiteboardsNotification	(	bool	isSupported,
		bool	isAllowed
	)

pure virtual

Allow attendees share whiteboard notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isSupported	TRUE indicate control allow attendees share whiteboards is supported. Otherwise not.
isAllowed	TRUE indicate attendees are allowed to share whiteboard. Otherwise not.

◆ OnAllowRaiseHandForAttendeeNotification()

virtual void IParticipantHelperSink::OnAllowRaiseHandForAttendeeNotification ( bool canRaiseHandForAttendee )

pure virtual

Allow raise hande for attendee notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

canRaiseHandForAttendee TRUE indicate allow attendees rename themselves. Otherwise not.

◆ OnClaimHostNotification()

virtual void IParticipantHelperSink::OnClaimHostNotification ( ClaimHostResult result )

pure virtual

Claim host notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result See ClaimHostResult enum.

◆ OnDownloadingFinished()

virtual void IParticipantHelperSink::OnDownloadingFinished	(	const std::string &	localFilePath,
		uint32_t	result
	)

pure virtual

Download result.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

localFilePath	The specified local file path when calling download API.
result	[0] success. Otherwise failed.

◆ OnHideFullRoomViewNotification()

virtual void IParticipantHelperSink::OnHideFullRoomViewNotification ( const std::vector< int32_t > & userIDs )

pure virtual

Hide full room view notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userIDs Full room view hidden user ID list.

◆ OnHostChangedNotification()

virtual void IParticipantHelperSink::OnHostChangedNotification	(	int32_t	hostUserID,
		bool	amIHost,
		ConfSessionType	session
	)

pure virtual

Host changed notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

hostUserID	Current host user ID.
amIHost	TRUE indicates self is host. Otherwise not.
session	session that changed.

Changelog

6.5.0: Added a parameter ConfSessionType to get specific type of participant list.

◆ OnInitMeetingParticipants()

virtual void IParticipantHelperSink::OnInitMeetingParticipants	(	const std::vector< MeetingParticipant > &	participants,
		int32_t	totalParticipantsCount,
		bool	needCleanUpUserList,
		ConfSessionType	session
	)

pure virtual

Meeting participants update notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.0.0

Parameters

participants	All the meeting participants.
totalParticipantsCount	Total count of participants.
needCleanUpUserList	TRUE indicates this is a initial notification, you should clean up former user list before processing here participants.
session	session that need init.

If there are many participants in meeting, the initial meeting participants will be updated in bulks.

◆ OnMeetingParticipantsChanged()

virtual void IParticipantHelperSink::OnMeetingParticipantsChanged ( ConfSessionType session )

pure virtual

Participants changed notification, using GetParticipantsInMeeting with session to get latest list .

Since: 6.3.0

Zoom Rooms minimum version: 6.0.0

Parameters

session The session that changed.

◆ OnUpdateHasRemoteControlAdmin()

virtual void IParticipantHelperSink::OnUpdateHasRemoteControlAdmin ( bool isAdminExist )

pure virtual

Remote control admin exist update notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isAdminExist TRUE indicate remote control admin exist.

◆ OnUpdateHasRemoteControlAssistant()

virtual void IParticipantHelperSink::OnUpdateHasRemoteControlAssistant ( bool isAssistantExist )

pure virtual

Remote control assistant exist update notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isAssistantExist TRUE indicate remote control assistant exist.

◆ OnUpdateHideProfilePictures()

virtual void IParticipantHelperSink::OnUpdateHideProfilePictures ( bool isHideProfilePictures )

pure virtual

Hide profile picture update notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isHideProfilePictures TRUE indicates hide. Otherwise not.

◆ OnUpdateOnZRWUserChangeNotification()

virtual void IParticipantHelperSink::OnUpdateOnZRWUserChangeNotification	(	ZRWUserChangeType	type,
		int32_t	zrwUserID
	)

pure virtual

Zoom Room Whiteboard user change notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

type	Change type, see ZRWUserChangeType enum.
zrwUserID	The zrw user ID if ZRW_JOIN.

◆ OnUpdateSharingAnnotationInfo()

virtual void IParticipantHelperSink::OnUpdateSharingAnnotationInfo	(	bool	support,
		bool	enable
	)

pure virtual

Allow user annotate on shared content notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

support	TRUE indicates support control sharing annotation enable or not.
enable	TRUE indicates allow user to annotate on shared content.

◆ OnUserJoin()

virtual void IParticipantHelperSink::OnUserJoin	(	const std::vector< MeetingParticipant > &	participants,
		ConfSessionType	session
	)

pure virtual

Participants join meeting notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.0.0

Parameters

participants	List of join participants.
session	session that changed.

◆ OnUserLeave()

virtual void IParticipantHelperSink::OnUserLeave	(	const std::vector< MeetingParticipant > &	participants,
		ConfSessionType	session
	)

pure virtual

Participants leave meeting notification,.

Since: 6.5.0

Zoom Rooms minimum version: 6.0.0

Parameters

participants	List of left participants.
session	session that changed.

◆ OnUserUpdate()

virtual void IParticipantHelperSink::OnUserUpdate	(	const std::vector< MeetingParticipant > &	participants,
		ConfSessionType	session
	)

pure virtual

Participants update notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.0.0

Parameters

participants	List of info updated participants.
session	session that changed.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IParticipantHelperSink()

Member Function Documentation

◆ OnAllowAttendeesRenameThemselvesNotification()

◆ OnAllowAttendeesShareWhiteboardsNotification()

◆ OnAllowRaiseHandForAttendeeNotification()

◆ OnClaimHostNotification()

◆ OnDownloadingFinished()

◆ OnHideFullRoomViewNotification()

◆ OnHostChangedNotification()

◆ OnInitMeetingParticipants()

◆ OnMeetingParticipantsChanged()

◆ OnUpdateHasRemoteControlAdmin()

◆ OnUpdateHasRemoteControlAssistant()

◆ OnUpdateHideProfilePictures()

◆ OnUpdateOnZRWUserChangeNotification()

◆ OnUpdateSharingAnnotationInfo()

◆ OnUserJoin()

◆ OnUserLeave()

◆ OnUserUpdate()