Windows SDK API Reference
Loading...
Searching...
No Matches
IMeetingParticipantsCtrlEvent Class Referenceabstract

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=NULL)=0
 Callback event of notification of users who are in the meeting.
 
virtual void onUserLeft (IList< unsigned int > *lstUserID, const zchar_t *strUserList=NULL)=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.
 

Detailed Description

Meeting Participants Controller Callback Event.

Definition at line 180 of file meeting_participants_ctrl_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingParticipantsCtrlEvent()

virtual IMeetingParticipantsCtrlEvent::~IMeetingParticipantsCtrlEvent ( )
inlinevirtual

Definition at line 183 of file meeting_participants_ctrl_interface.h.

183{}

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
bAllowTrue 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
bAllowTrue allow. If false, disallow.

◆ onAllowParticipantsShareWhiteBoardNotification()

virtual void IMeetingParticipantsCtrlEvent::onAllowParticipantsShareWhiteBoardNotification ( bool bAllow)
pure virtual

Callback event that lets participants share a new whiteboard.

Parameters
bAllowTrue 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
bAllowTrue allow. If false, disallow.

◆ onAllowParticipantsUnmuteSelfNotification()

virtual void IMeetingParticipantsCtrlEvent::onAllowParticipantsUnmuteSelfNotification ( bool bAllow)
pure virtual

Callback event that lets participants unmute themself.

Parameters
bAllowTrue allow. If false, participants may not rename themselves.

◆ onCoHostChangeNotification()

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

Callback event of changing the co-host.

Parameters
userIdSpecify the user ID whose status changes.
isCoHostTRUE 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
typeShare type change.

◆ onFocusModeStateChanged()

virtual void IMeetingParticipantsCtrlEvent::onFocusModeStateChanged ( bool bEnabled)
pure virtual

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

Parameters
bEnabledTrue 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
userIdSpecify 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
userIDSpecify 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
userIdSpecify the user ID whose status changes.
statusValue 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
bLowTRUE indicates to put down the hand, FALSE indicates to raise the hand.
useridSpecify the user ID whose status changes.

◆ onParticipantProfilePictureStatusChange()

virtual void IMeetingParticipantsCtrlEvent::onParticipantProfilePictureStatusChange ( bool bHidden)
pure virtual

Callback event that participant profile status change.

Parameters
bHidetrue 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
statusValue 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 = NULL )
pure virtual

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

Parameters
lstUserIDList of user IDs.
strUserListList 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 = NULL )
pure virtual

Callback event of notification of user who leaves the meeting.

Parameters
lstUserIDList of the user ID who leaves the meeting.
strUserListList 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
userIdlist Specify the users ID whose status changes.
Remarks
Valid for both normal user and webinar attendee.