Meeting waiting room controller interface. More...

#include <meeting_participants_ctrl_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingParticipantsCtrlEvent *pEvent)=0
	Set the participants controller callback event handler.

virtual IList< unsigned int > *	GetParticipantsList ()=0
	Get the list of all the panelists in the meeting.

virtual IUserInfo *	GetUserByUserID (unsigned int userid)=0
	Get the information of specified user.

virtual IUserInfo *	GetMySelfUser ()=0
	Get the information of current user.

virtual SDKError	LowerAllHands (bool forWebinarAttendees)=0
	Cancel all hands raised.

virtual SDKError	ChangeUserName (const unsigned int userid, const zchar_t *userName, bool bSaveUserName)=0
	Change the screen name of specified user. Only the host or co-host can change the others' name.

virtual SDKError	LowerHand (unsigned int userid)=0
	Cancel the hands raised of specified user.

virtual SDKError	RaiseHand ()=0
	Raise hands in the meeting.

virtual SDKError	MakeHost (unsigned int userid)=0
	Set the specified user as the host.

virtual SDKError	CanbeCohost (unsigned int userid)=0
	Determine if it is able to change the specified user role as the co-host.

virtual SDKError	AssignCoHost (unsigned int userid)=0
	Set the specified user as the co-host.

virtual SDKError	RevokeCoHost (unsigned int userid)=0
	Get back the co-host role from the specified user.

virtual SDKError	ExpelUser (unsigned int userid)=0
	Expel the specified user.

virtual SDKError	ReclaimHost ()=0
	Reclaim the role of the host.

virtual SDKError	CanReclaimHost (bool &bCanReclaimHost)=0
	Determine if the user has the right to reclaim the host role.

virtual SDKError	ReclaimHostByHostKey (const zchar_t *host_key)=0
	Reclaim role of host via host_key.

virtual SDKError	AllowParticipantsToRename (bool bAllow)=0

virtual bool	IsParticipantsRenameAllowed ()=0

virtual SDKError	AllowParticipantsToUnmuteSelf (bool bAllow)=0

virtual bool	IsParticipantsUnmuteSelfAllowed ()=0

virtual SDKError	AskAllToUnmute ()=0

virtual SDKError	AllowParticipantsToStartVideo (bool bAllow)=0
	Allowing the regular attendees to start video, it can only be used in regular meeetings(no bo).

virtual bool	IsParticipantsStartVideoAllowed ()=0
	Check whether the current meeting allows participants to start video, it can only be used in regular meeetings(no bo).

virtual SDKError	AllowParticipantsToShareWhiteBoard (bool bAllow)=0
	Allowing the regular attendees to share whiteboard, it can only be used in regular meeetings(no bo).

virtual bool	IsParticipantsShareWhiteBoardAllowed ()=0
	Check whether the current meeting allows participants to share whiteboard, it can only be used in regular meeetings(no bo).

virtual SDKError	AllowParticipantsToChat (bool bAllow)=0
	Allowing the regular attendees to use chat, it can only be used in regular meeetings(no webinar or bo).

virtual bool	IsParticipantAllowedToChat ()=0
	Check whether the current meeting allows participants to chat, it can only be used in regular meeetings(no webinar or bo)..

virtual bool	IsParticipantRequestLocalRecordingAllowed ()=0
	Check whether the current meeting allows participants to send local recording privilege request, it can only be used in regular meeetings(no webinar or bo).

virtual SDKError	AllowParticipantsToRequestLocalRecording (bool bAllow)=0
	Allowing the regular attendees to send local recording privilege request, it can only be used in regular meeetings(no bo).

virtual bool	IsAutoAllowLocalRecordingRequest ()=0
	Check whether the current meeting auto grant participants local recording privilege request, it can only be used in regular meeetings(no webinar or bo).

virtual SDKError	AutoAllowLocalRecordingRequest (bool bAllow)=0
	Auto grant or deny the regular attendee's local recording privilege request, it can only be used in regular meeetings(no bo).

virtual SDKError	CanHideParticipantProfilePictures ()=0
	Determine if the current user can hide participant profile pictures.

virtual bool	IsParticipantProfilePicturesHidden ()=0
	Check whether the current meeting hides participant pictures.

virtual SDKError	HideParticipantProfilePictures (bool bHide)=0
	Hide/Show participant profile pictures.

virtual bool	IsFocusModeEnabled ()=0
	Determine if the focus mode enabled or not by web portal.

virtual bool	IsFocusModeOn ()=0
	Determine if the focus mode on or off.

virtual SDKError	TurnFocusModeOn (bool turnOn)=0
	Turn focus mode on or off. Focus mode on means Participants will only be able to see hosts' videos and shared content, and videos of spotlighted participants.

virtual FocusModeShareType	GetFocusModeShareType ()=0
	Get focus mode share type indicating who can see the shared content which is controlled by host or co-host.

virtual SDKError	SetFocusModeShareType (FocusModeShareType shareType)=0
	Set the focus mode type indicating who can see the shared content which is controlled by host or co-host.

virtual bool	CanEnableParticipantRequestCloudRecording ()=0
	Determine if the current user can enable participant request clould recording.

virtual bool	IsParticipantRequestCloudRecordingAllowed ()=0
	Check whether the current meeting allows participants to send cloud recording privilege request, This can only be used in regular meeetings and webinar(no breakout rooms).

virtual SDKError	AllowParticipantsToRequestCloudRecording (bool bAllow)=0
	Toggle whether attendees can requests for the host to start a cloud recording. This can only be used in regular meeetings and webinar(no breakout rooms).

Detailed Description

Meeting waiting room controller interface.

Definition at line 270 of file meeting_participants_ctrl_interface.h.

Member Function Documentation

◆ AllowParticipantsToChat()

virtual SDKError IMeetingParticipantsController::AllowParticipantsToChat ( bool bAllow )

pure virtual

Allowing the regular attendees to use chat, it can only be used in regular meeetings(no webinar or bo).

Parameters

bAllow TRUE indicates Allowing the regular attendees to use chat.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ AllowParticipantsToRename()

virtual SDKError IMeetingParticipantsController::AllowParticipantsToRename ( bool bAllow )

pure virtual

◆ AllowParticipantsToRequestCloudRecording()

virtual SDKError IMeetingParticipantsController::AllowParticipantsToRequestCloudRecording ( bool bAllow )

pure virtual

Toggle whether attendees can requests for the host to start a cloud recording. This can only be used in regular meeetings and webinar(no breakout rooms).

Parameters

bAllow TRUE indicates that participants are allowed to send cloud recording privilege requests.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ AllowParticipantsToRequestLocalRecording()

virtual SDKError IMeetingParticipantsController::AllowParticipantsToRequestLocalRecording ( bool bAllow )

pure virtual

Allowing the regular attendees to send local recording privilege request, it can only be used in regular meeetings(no bo).

Parameters

bAllow TRUE indicates Allowing the regular attendees to send local recording privilege request.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ AllowParticipantsToShareWhiteBoard()

virtual SDKError IMeetingParticipantsController::AllowParticipantsToShareWhiteBoard ( bool bAllow )

pure virtual

Allowing the regular attendees to share whiteboard, it can only be used in regular meeetings(no bo).

Parameters

bAllow TRUE indicates Allowing the regular attendees to share whiteboard.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ AllowParticipantsToStartVideo()

virtual SDKError IMeetingParticipantsController::AllowParticipantsToStartVideo ( bool bAllow )

pure virtual

Allowing the regular attendees to start video, it can only be used in regular meeetings(no bo).

Parameters

bAllow TRUE indicates Allowing the regular attendees to start video.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ AllowParticipantsToUnmuteSelf()

virtual SDKError IMeetingParticipantsController::AllowParticipantsToUnmuteSelf ( bool bAllow )

pure virtual

◆ AskAllToUnmute()

virtual SDKError IMeetingParticipantsController::AskAllToUnmute ( )

pure virtual

◆ AssignCoHost()

virtual SDKError IMeetingParticipantsController::AssignCoHost ( unsigned int userid )

pure virtual

Set the specified user as the co-host.

Parameters

userid Specify the user ID who is to be the co-host.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ AutoAllowLocalRecordingRequest()

virtual SDKError IMeetingParticipantsController::AutoAllowLocalRecordingRequest ( bool bAllow )

pure virtual

Auto grant or deny the regular attendee's local recording privilege request, it can only be used in regular meeetings(no bo).

Parameters

bAllow TRUE indicates Auto grant or deny the regular attendee's local recording privilege request.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ CanbeCohost()

virtual SDKError IMeetingParticipantsController::CanbeCohost ( unsigned int userid )

pure virtual

Determine if it is able to change the specified user role as the co-host.

Parameters

userid Specify the user ID.

Returns: If the specified user can be the co-host, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ CanEnableParticipantRequestCloudRecording()

virtual bool IMeetingParticipantsController::CanEnableParticipantRequestCloudRecording ( )

pure virtual

Determine if the current user can enable participant request clould recording.

Returns: true means the current user can enable participant request clould recording.

◆ CanHideParticipantProfilePictures()

virtual SDKError IMeetingParticipantsController::CanHideParticipantProfilePictures ( )

pure virtual

Determine if the current user can hide participant profile pictures.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ CanReclaimHost()

virtual SDKError IMeetingParticipantsController::CanReclaimHost ( bool & bCanReclaimHost )

pure virtual

Determine if the user has the right to reclaim the host role.

Parameters

[out] bCanReclaimHost TRUE indicates to have the right to reclaim the host role.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ ChangeUserName()

virtual SDKError IMeetingParticipantsController::ChangeUserName	(	const unsigned int	userid,
		const zchar_t *	userName,
		bool	bSaveUserName
	)

pure virtual

Change the screen name of specified user. Only the host or co-host can change the others' name.

Parameters

userid	Specify the user ID whose name needed to be changed.
userName	Specify a new screen name for the user.
bSaveUserName	Save the screen name to join the meeting next time.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ ExpelUser()

virtual SDKError IMeetingParticipantsController::ExpelUser ( unsigned int userid )

pure virtual

Expel the specified user.

Parameters

userid Specify the ID of user to be expelled.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ GetFocusModeShareType()

virtual FocusModeShareType IMeetingParticipantsController::GetFocusModeShareType ( )

pure virtual

Get focus mode share type indicating who can see the shared content which is controlled by host or co-host.

Returns: The current focus mode share type.

◆ GetMySelfUser()

virtual IUserInfo * IMeetingParticipantsController::GetMySelfUser ( )

pure virtual

Get the information of current user.

Returns: If the function succeeds, the return value is a pointer to the IUserInfo. For more details, see IUserInfo. Otherwise failed, the return value is NULL.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ GetParticipantsList()

virtual IList< unsigned int > * IMeetingParticipantsController::GetParticipantsList ( )

pure virtual

Get the list of all the panelists in the meeting.

Returns: If the function succeeds, the return value is the list of the panelists in the meeting. Otherwise the function fails, and the return value is NULL.

Remarks: Valid for both ZOOM style and user custom interface mode. Valid for both normal user and webinar attendee.

◆ GetUserByUserID()

virtual IUserInfo * IMeetingParticipantsController::GetUserByUserID ( unsigned int userid )

pure virtual

Get the information of specified user.

Parameters

userid Specify the user ID for which you want to get the information.

Returns: If the function succeeds, the return value is a pointer to the IUserInfo. For more details, see IUserInfo. Otherwise the function fails, and the return value is NULL.

Remarks: Valid for both ZOOM style and user custom interface mode. Valid for both normal user and webinar attendee.

◆ HideParticipantProfilePictures()

virtual SDKError IMeetingParticipantsController::HideParticipantProfilePictures ( bool bHide )

pure virtual

Hide/Show participant profile pictures.

Parameters

bHide TRUE indicates Hide participant profile pictures.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ IsAutoAllowLocalRecordingRequest()

virtual bool IMeetingParticipantsController::IsAutoAllowLocalRecordingRequest ( )

pure virtual

Check whether the current meeting auto grant participants local recording privilege request, it can only be used in regular meeetings(no webinar or bo).

Returns: If auto grant participants local recording privilege request, the return value is true.

◆ IsFocusModeEnabled()

virtual bool IMeetingParticipantsController::IsFocusModeEnabled ( )

pure virtual

Determine if the focus mode enabled or not by web portal.

Returns: True means focus mode enabled. Otherwise not.

◆ IsFocusModeOn()

virtual bool IMeetingParticipantsController::IsFocusModeOn ( )

pure virtual

Determine if the focus mode on or off.

Returns: True means focus mode on. Otherwise off.

◆ IsParticipantAllowedToChat()

virtual bool IMeetingParticipantsController::IsParticipantAllowedToChat ( )

pure virtual

Check whether the current meeting allows participants to chat, it can only be used in regular meeetings(no webinar or bo)..

Returns: If allows participants to chat, the return value is true.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ IsParticipantProfilePicturesHidden()

virtual bool IMeetingParticipantsController::IsParticipantProfilePicturesHidden ( )

pure virtual

Check whether the current meeting hides participant pictures.

Returns: If participants profile pictures be hidden, the return value is true.

◆ IsParticipantRequestCloudRecordingAllowed()

virtual bool IMeetingParticipantsController::IsParticipantRequestCloudRecordingAllowed ( )

pure virtual

Check whether the current meeting allows participants to send cloud recording privilege request, This can only be used in regular meeetings and webinar(no breakout rooms).

Returns: If allows participants to send request, the return value is true.

◆ IsParticipantRequestLocalRecordingAllowed()

virtual bool IMeetingParticipantsController::IsParticipantRequestLocalRecordingAllowed ( )

pure virtual

Check whether the current meeting allows participants to send local recording privilege request, it can only be used in regular meeetings(no webinar or bo).

Returns: If allows participants to send request, the return value is true.

◆ IsParticipantsRenameAllowed()

virtual bool IMeetingParticipantsController::IsParticipantsRenameAllowed ( )

pure virtual

◆ IsParticipantsShareWhiteBoardAllowed()

virtual bool IMeetingParticipantsController::IsParticipantsShareWhiteBoardAllowed ( )

pure virtual

Check whether the current meeting allows participants to share whiteboard, it can only be used in regular meeetings(no bo).

Returns: If allows participants to share whiteboard, the return value is true.

◆ IsParticipantsStartVideoAllowed()

virtual bool IMeetingParticipantsController::IsParticipantsStartVideoAllowed ( )

pure virtual

Check whether the current meeting allows participants to start video, it can only be used in regular meeetings(no bo).

Returns: If allows participants to start video, the return value is true.

◆ IsParticipantsUnmuteSelfAllowed()

virtual bool IMeetingParticipantsController::IsParticipantsUnmuteSelfAllowed ( )

pure virtual

◆ LowerAllHands()

virtual SDKError IMeetingParticipantsController::LowerAllHands ( bool forWebinarAttendees )

pure virtual

Cancel all hands raised.

Parameters

forWebinarAttendees is true, the SDK sends the lower all hands command only to webinar attendees. \forWebinarAttendees is false, the SDK sends the lower all hands command to anyone who is not a webinar attendee, such as the webinar host/cohost/panelist or everyone in a regular meeting..

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ LowerHand()

virtual SDKError IMeetingParticipantsController::LowerHand ( unsigned int userid )

pure virtual

Cancel the hands raised of specified user.

Parameters

userid Specify the user ID to put down the hands.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ MakeHost()

virtual SDKError IMeetingParticipantsController::MakeHost ( unsigned int userid )

pure virtual

Set the specified user as the host.

Parameters

userid Specify the user ID to be the host.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ RaiseHand()

virtual SDKError IMeetingParticipantsController::RaiseHand ( )

pure virtual

Raise hands in the meeting.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ ReclaimHost()

virtual SDKError IMeetingParticipantsController::ReclaimHost ( )

pure virtual

Reclaim the role of the host.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for Zoom style user interface mode.

◆ ReclaimHostByHostKey()

virtual SDKError IMeetingParticipantsController::ReclaimHostByHostKey ( const zchar_t * host_key )

pure virtual

Reclaim role of host via host_key.

Parameters

host_key The key to get the role of host.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ RevokeCoHost()

virtual SDKError IMeetingParticipantsController::RevokeCoHost ( unsigned int userid )

pure virtual

Get back the co-host role from the specified user.

Parameters

userid Specify the user ID to get back the co-host.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode..

◆ SetEvent()

virtual SDKError IMeetingParticipantsController::SetEvent ( IMeetingParticipantsCtrlEvent * pEvent )

pure virtual

Set the participants controller callback event handler.

Parameters

pEvent A pointer to the IParticipantsControllerEvent that receives the participants event.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetFocusModeShareType()

virtual SDKError IMeetingParticipantsController::SetFocusModeShareType ( FocusModeShareType shareType )

pure virtual

Set the focus mode type indicating who can see the shared content which is controlled by host or co-host.

Parameters

shareType The type of focus mode share type.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ TurnFocusModeOn()

virtual SDKError IMeetingParticipantsController::TurnFocusModeOn ( bool turnOn )

pure virtual

Turn focus mode on or off. Focus mode on means Participants will only be able to see hosts' videos and shared content, and videos of spotlighted participants.

Parameters

turnOn True means to turen on, false means to turn off.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Public Member Functions

Detailed Description

Member Function Documentation

◆ AllowParticipantsToChat()

◆ AllowParticipantsToRename()

◆ AllowParticipantsToRequestCloudRecording()

◆ AllowParticipantsToRequestLocalRecording()

◆ AllowParticipantsToShareWhiteBoard()

◆ AllowParticipantsToStartVideo()

◆ AllowParticipantsToUnmuteSelf()

◆ AskAllToUnmute()

◆ AssignCoHost()

◆ AutoAllowLocalRecordingRequest()

◆ CanbeCohost()

◆ CanEnableParticipantRequestCloudRecording()

◆ CanHideParticipantProfilePictures()

◆ CanReclaimHost()

◆ ChangeUserName()

◆ ExpelUser()

◆ GetFocusModeShareType()

◆ GetMySelfUser()

◆ GetParticipantsList()

◆ GetUserByUserID()

◆ HideParticipantProfilePictures()

◆ IsAutoAllowLocalRecordingRequest()

◆ IsFocusModeEnabled()

◆ IsFocusModeOn()

◆ IsParticipantAllowedToChat()

◆ IsParticipantProfilePicturesHidden()

◆ IsParticipantRequestCloudRecordingAllowed()

◆ IsParticipantRequestLocalRecordingAllowed()

◆ IsParticipantsRenameAllowed()

◆ IsParticipantsShareWhiteBoardAllowed()

◆ IsParticipantsStartVideoAllowed()

◆ IsParticipantsUnmuteSelfAllowed()

◆ LowerAllHands()

◆ LowerHand()

◆ MakeHost()

◆ RaiseHand()

◆ ReclaimHost()

◆ ReclaimHostByHostKey()

◆ RevokeCoHost()

◆ SetEvent()

◆ SetFocusModeShareType()

◆ TurnFocusModeOn()