ZOOM Windows SDK  4.4.55968.0904
Public Member Functions | List of all members
IMeetingParticipantsController Class Referenceabstract

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 IUserInfoGetUserByUserID (unsigned int userid)=0
 Get the information of specified user. More...
 
virtual SDKError LowerAllHands ()=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...
 

Detailed Description

Meeting waiting room controller interface.

Member Function Documentation

◆ AssignCoHost()

virtual SDKError IMeetingParticipantsController::AssignCoHost ( unsigned int  userid)
pure virtual

Set the specified user as the co-host.

Parameters
useridSpecify 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
useridSpecify 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]bCanReclaimHostTRUE 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
useridSpecify the user ID whose name needed to be changed.
userNameSpecify a new screen name for the user.
bSaveUserNameSave 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
useridSpecify 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..

◆ 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
useridSpecify the user ID for which you want to get the information. Zero(0) indicates to get the information of the 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..

◆ LowerAllHands()

virtual SDKError IMeetingParticipantsController::LowerAllHands ( )
pure virtual

Cancel all hands raised.

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
useridSpecify 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
useridSpecify 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_keyThe 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
useridSpecify 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
pEventA 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.

The documentation for this class was generated from the following file: