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. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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	AllowParticipantsToChat (bool bAllow)=0
	Allowing the regular attendees to use chat, it can only be used in regular meeetings(no webinar or bo). More...

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).. More...

Detailed Description

Meeting waiting room controller interface.

Definition at line 203 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

◆ 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..

◆ 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..

◆ 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 wchar_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..

◆ 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 failed, the return value is NULL.

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

◆ 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 failed, the return value is NULL.

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

◆ 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..

◆ IsParticipantsRenameAllowed()

virtual bool IMeetingParticipantsController::IsParticipantsRenameAllowed ( )

pure virtual

◆ 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 wchar_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.

Public Member Functions

Detailed Description

Member Function Documentation

◆ AllowParticipantsToChat()

◆ AllowParticipantsToRename()

◆ AllowParticipantsToUnmuteSelf()

◆ AskAllToUnmute()

◆ AssignCoHost()

◆ CanbeCohost()

◆ CanReclaimHost()

◆ ChangeUserName()

◆ ExpelUser()

◆ GetMySelfUser()

◆ GetParticipantsList()

◆ GetUserByUserID()

◆ IsParticipantAllowedToChat()

◆ IsParticipantsRenameAllowed()

◆ IsParticipantsUnmuteSelfAllowed()

◆ LowerAllHands()

◆ LowerHand()

◆ MakeHost()

◆ RaiseHand()

◆ ReclaimHost()

◆ ReclaimHostByHostKey()

◆ RevokeCoHost()

◆ SetEvent()