IMeetingParticipantsCtrlEvent Class Reference

Meeting Participants Controller Callback Event. More...

#include <meeting_participants_ctrl_interface.h>

Public Member Functions
virtual	~IMeetingParticipantsCtrlEvent ()
virtual void	onUserJoin (IList< unsigned int > *lstUserID, const zchar_t *strUserList=nullptr)=0
	Callback event of notification of users who are in the meeting.
virtual void	onUserLeft (IList< unsigned int > *lstUserID, const zchar_t *strUserList=nullptr)=0
	Callback event of notification of user who leaves the meeting.
virtual void	onHostChangeNotification (unsigned int userId)=0
	Callback event of notification of the new host.
virtual void	onLowOrRaiseHandStatusChanged (bool bLow, unsigned int userid)=0
	Callback event of changing the state of the hand.
virtual void	onUserNamesChanged (IList< unsigned int > *lstUserID)=0
	Callback event of changing the screen name.
virtual void	onCoHostChangeNotification (unsigned int userId, bool isCoHost)=0
	Callback event of changing the co-host.
virtual void	onInvalidReclaimHostkey ()=0
	Callback event of invalid host key.
virtual void	onAllHandsLowered ()=0
	Callback event of the host calls the lower all hands interface, the host/cohost/panelist will receive this callback.
virtual void	onLocalRecordingStatusChanged (unsigned int user_id, RecordingStatus status)=0
	Callback event that the status of local recording changes.
virtual void	onAllowParticipantsRenameNotification (bool bAllow)=0
	Callback event that lets participants rename themself.
virtual void	onAllowParticipantsUnmuteSelfNotification (bool bAllow)=0
	Callback event that lets participants unmute themself.
virtual void	onAllowParticipantsStartVideoNotification (bool bAllow)=0
	Callback event that lets participants start a video.
virtual void	onAllowParticipantsShareWhiteBoardNotification (bool bAllow)=0
	Callback event that lets participants share a new whiteboard.
virtual void	onRequestLocalRecordingPrivilegeChanged (LocalRecordingRequestPrivilegeStatus status)=0
	Callback event that the request local recording privilege changes.
virtual void	onAllowParticipantsRequestCloudRecording (bool bAllow)=0
	Callback event that lets participants request that the host starts cloud recording.
virtual void	onInMeetingUserAvatarPathUpdated (unsigned int userID)=0
	Callback event that the user avatar path is updated in the meeting.
virtual void	onParticipantProfilePictureStatusChange (bool bHidden)=0
	Callback event that participant profile status change.
virtual void	onFocusModeStateChanged (bool bEnabled)=0
	Callback event that focus mode changed by host or co-host.
virtual void	onFocusModeShareTypeChanged (FocusModeShareType type)=0
	Callback event that that focus mode share type changed by host or co-host.
virtual void	onBotAuthorizerRelationChanged (unsigned int authorizeUserID)=0
	Callback event that the bot relationship changed in the meeting.
virtual void	onVirtualNameTagStatusChanged (bool bOn, unsigned int userID)=0
	Notification of virtual name tag status change.
virtual void	onVirtualNameTagRosterInfoUpdated (unsigned int userID)=0
	Notification of virtual name tag roster info updated.

Detailed Description

Meeting Participants Controller Callback Event.

Definition at line 228 of file meeting_participants_ctrl_interface.h.

Constructor & Destructor Documentation

~IMeetingParticipantsCtrlEvent()

virtual IMeetingParticipantsCtrlEvent::~IMeetingParticipantsCtrlEvent ( )

inlinevirtual

Definition at line 231 of file meeting_participants_ctrl_interface.h.

{}

Member Function Documentation

onAllHandsLowered()

virtual void IMeetingParticipantsCtrlEvent::onAllHandsLowered ( )

pure virtual

Callback event of the host calls the lower all hands interface, the host/cohost/panelist will receive this callback.

onAllowParticipantsRenameNotification()

virtual void IMeetingParticipantsCtrlEvent::onAllowParticipantsRenameNotification ( bool bAllow )

pure virtual

Callback event that lets participants rename themself.

Parameters

bAllow

True allow. If false, participants may not rename themselves.

onAllowParticipantsRequestCloudRecording()

virtual void IMeetingParticipantsCtrlEvent::onAllowParticipantsRequestCloudRecording ( bool bAllow )

pure virtual

Callback event that lets participants request that the host starts cloud recording.

Parameters

bAllow

True allow. If false, disallow.

onAllowParticipantsShareWhiteBoardNotification()

virtual void IMeetingParticipantsCtrlEvent::onAllowParticipantsShareWhiteBoardNotification ( bool bAllow )

pure virtual

Callback event that lets participants share a new whiteboard.

Parameters

bAllow

True allow. If false, participants may not share new whiteboard.

onAllowParticipantsStartVideoNotification()

virtual void IMeetingParticipantsCtrlEvent::onAllowParticipantsStartVideoNotification ( bool bAllow )

pure virtual

Callback event that lets participants start a video.

Parameters

bAllow

True allow. If false, disallow.

onAllowParticipantsUnmuteSelfNotification()

virtual void IMeetingParticipantsCtrlEvent::onAllowParticipantsUnmuteSelfNotification ( bool bAllow )

pure virtual

Callback event that lets participants unmute themself.

Parameters

bAllow

True allow. If false, participants may not rename themselves.

onBotAuthorizerRelationChanged()

virtual void IMeetingParticipantsCtrlEvent::onBotAuthorizerRelationChanged ( unsigned int authorizeUserID )

pure virtual

Callback event that the bot relationship changed in the meeting.

Parameters

authorizeUserID

Specify the authorizer user ID.

onCoHostChangeNotification()

virtual void IMeetingParticipantsCtrlEvent::onCoHostChangeNotification ( unsigned int userId, bool isCoHost )

pure virtual

Callback event of changing the co-host.

Parameters

userId	Specify the user ID whose status changes.
isCoHost	TRUE indicates that the specified user is co-host.

onFocusModeShareTypeChanged()

virtual void IMeetingParticipantsCtrlEvent::onFocusModeShareTypeChanged ( FocusModeShareType type )

pure virtual

Callback event that that focus mode share type changed by host or co-host.

Parameters

type	Share type change.

onFocusModeStateChanged()

virtual void IMeetingParticipantsCtrlEvent::onFocusModeStateChanged ( bool bEnabled )

pure virtual

Callback event that focus mode changed by host or co-host.

Parameters

bEnabled

True means the focus mode change to on. Otherwise off.

onHostChangeNotification()

virtual void IMeetingParticipantsCtrlEvent::onHostChangeNotification ( unsigned int userId )

pure virtual

Callback event of notification of the new host.

Parameters

userId

Specify the ID of the new host.

onInMeetingUserAvatarPathUpdated()

virtual void IMeetingParticipantsCtrlEvent::onInMeetingUserAvatarPathUpdated ( unsigned int userID )

pure virtual

Callback event that the user avatar path is updated in the meeting.

Parameters

userID

Specify the user ID whose avatar updated.

onInvalidReclaimHostkey()

virtual void IMeetingParticipantsCtrlEvent::onInvalidReclaimHostkey ( )

pure virtual

Callback event of invalid host key.

onLocalRecordingStatusChanged()

virtual void IMeetingParticipantsCtrlEvent::onLocalRecordingStatusChanged ( unsigned int user_id, RecordingStatus status )

pure virtual

Callback event that the status of local recording changes.

Parameters

userId	Specify the user ID whose status changes.
status	Value of recording status. For more details, see RecordingStatus enum.

onLowOrRaiseHandStatusChanged()

virtual void IMeetingParticipantsCtrlEvent::onLowOrRaiseHandStatusChanged ( bool bLow, unsigned int userid )

pure virtual

Callback event of changing the state of the hand.

Parameters

bLow	TRUE indicates to put down the hand, FALSE indicates to raise the hand.
userid	Specify the user ID whose status changes.

onParticipantProfilePictureStatusChange()

virtual void IMeetingParticipantsCtrlEvent::onParticipantProfilePictureStatusChange ( bool bHidden )

pure virtual

Callback event that participant profile status change.

Parameters

bHide

true means hide participant profile picture, false means show participant profile picture.

onRequestLocalRecordingPrivilegeChanged()

virtual void IMeetingParticipantsCtrlEvent::onRequestLocalRecordingPrivilegeChanged ( LocalRecordingRequestPrivilegeStatus status )

pure virtual

Callback event that the request local recording privilege changes.

Parameters

status

Value of request local recording privilege status. For more details, see LocalRecordingRequestPrivilegeStatus enum.

onUserJoin()

virtual void IMeetingParticipantsCtrlEvent::onUserJoin ( IList< unsigned int > * lstUserID, const zchar_t * strUserList = nullptr )

pure virtual

Callback event of notification of users who are in the meeting.

Parameters

lstUserID	List of user IDs.
strUserList	List of users in JSON format. This function is currently invalid, hereby only for reservations.

Remarks

Valid for both normal user and webinar attendee.

onUserLeft()

virtual void IMeetingParticipantsCtrlEvent::onUserLeft ( IList< unsigned int > * lstUserID, const zchar_t * strUserList = nullptr )

pure virtual

Callback event of notification of user who leaves the meeting.

Parameters

lstUserID	List of the user ID who leaves the meeting.
strUserList	List of the users in JSON format. This function is currently invalid, hereby only for reservations.

Remarks

Valid for both normal user and webinar attendee.

onUserNamesChanged()

virtual void IMeetingParticipantsCtrlEvent::onUserNamesChanged ( IList< unsigned int > * lstUserID )

pure virtual

Callback event of changing the screen name.

Parameters

userId

list Specify the users ID whose status changes.

Remarks

Valid for both normal user and webinar attendee.

onVirtualNameTagRosterInfoUpdated()

virtual void IMeetingParticipantsCtrlEvent::onVirtualNameTagRosterInfoUpdated ( unsigned int userID )

pure virtual

Notification of virtual name tag roster info updated.

Parameters

userID

The ID of user who virtual name tag status changed.

onVirtualNameTagStatusChanged()

virtual void IMeetingParticipantsCtrlEvent::onVirtualNameTagStatusChanged ( bool bOn, unsigned int userID )

pure virtual

Notification of virtual name tag status change.

Parameters

bOn	TRUE means virtual name tag is turn on, Otherwise not.
userID	The ID of user who virtual name tag status changed.