Meeting waiting room controller interface. More...

#include <meeting_participants_ctrl_interface.h>

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

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

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

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

virtual IUserInfo *	GetBotAuthorizedUserInfoByUserID (unsigned int userid)=0
	Gets the information about the bot's authorized user.

virtual IList< unsigned int > *	GetAuthorizedBotListByUserID (unsigned int userid)=0
	Gets the authorizer's bot list.

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
	Sets the specified user as the host.

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

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

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

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

virtual bool	IsSelfOriginalHost ()=0
	Checks whether myself is original host.

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

virtual SDKError	CanReclaimHost (bool &bCanReclaimHost)=0
	Determines 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
	Checks 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
	Checks 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
	Checks 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
	Checks 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
	Determines if the current user can hide participant profile pictures.

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

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

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

virtual bool	IsFocusModeOn ()=0
	Determines 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
	Gets 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
	Sets the focus mode type indicating who can see the shared content which is controlled by host or co-host.

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

virtual bool	IsParticipantRequestCloudRecordingAllowed ()=0
	Checks 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).

virtual bool	IsSupportVirtualNameTag ()=0
	Determines if support virtual name tag feature.

virtual SDKError	EnableVirtualNameTag (bool bEnabled)=0
	Enables the virtual name tag feature for the account.

virtual SDKError	CreateVirtualNameTagRosterInfoBegin ()=0
	Prepare to Update virtual name tag roster infomation.

virtual bool	AddVirtualNameTagRosterInfoToList (ZoomSDKVirtualNameTag userRoster)=0
	Add the userRoster to a prepared list.

virtual SDKError	CreateVirtualNameTagRosterInfoCommit ()=0
	Batch create virtual name tag roster infoTo according to the prepare list.

virtual bool	CanBeCoOwner (unsigned int userid)=0
	Query if the user can be assigned as co-owner in meeting. Co-owner can be grant with privilege to manage some assets after the meeting.

virtual SDKError	AssignCoHostWithAssetsPrivilege (unsigned int userid, IList< GrantCoOwnerAssetsInfo > *list)=0
	Assigns a user as co-host and grants privileges to manage assets after the meeting.

virtual SDKError	MakeHostWithAssetsPrivilege (unsigned int userid, IList< GrantCoOwnerAssetsInfo > *list)=0
	Assigns a user as host and grants privileges to manage assets after the meeting.

Detailed Description

Meeting waiting room controller interface.

Definition at line 489 of file meeting_participants_ctrl_interface.h.

Member Function Documentation

◆ AddVirtualNameTagRosterInfoToList()

virtual bool IMeetingParticipantsController::AddVirtualNameTagRosterInfoToList ( ZoomSDKVirtualNameTag userRoster )

pure virtual

Add the userRoster to a prepared list.

Parameters

userRoster,The virtual name tag roster info list for specify user.

Returns: true if the userRoster is added to the prepared list successfully.

Note: The maximum size of userRoster should less 20. User should sepcify the tagName and tagID of echo ZoomSDKVirtualNameTag object. The range of tagID is 0-1024.

◆ 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, this function returns an error.

Note: 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, this function returns an error.

◆ 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, this function returns an error.

◆ 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, this function returns an error.

◆ 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, this function returns an error.

◆ 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

Sets 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, this function returns an error.

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

◆ AssignCoHostWithAssetsPrivilege()

virtual SDKError IMeetingParticipantsController::AssignCoHostWithAssetsPrivilege	(	unsigned int	userid,
		IList< GrantCoOwnerAssetsInfo > *	list )

pure virtual

Assigns a user as co-host and grants privileges to manage assets after the meeting.

Parameters

userid	The ID of user to be assigned as co-host.
list	A List of GrantCoOwnerAssetsInfo struct representing the assets and privileges to grant.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: The co-host cannot be assigned as co-host by himself. And the user should have the power to assign the role.

◆ 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, this function returns an error.

◆ CanbeCohost()

virtual SDKError IMeetingParticipantsController::CanbeCohost ( unsigned int userid )

pure virtual

Determines 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, this function returns an error.

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

◆ CanBeCoOwner()

virtual bool IMeetingParticipantsController::CanBeCoOwner ( unsigned int userid )

pure virtual

Query if the user can be assigned as co-owner in meeting. Co-owner can be grant with privilege to manage some assets after the meeting.

Parameters

userid The ID of user who will be assigned as co-owner in meeting.

Returns: true if the user can be assigned as co-owner. Otherwise, false.

◆ CanEnableParticipantRequestCloudRecording()

virtual bool IMeetingParticipantsController::CanEnableParticipantRequestCloudRecording ( )

pure virtual

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

Returns: true if the current user can enable participant request cloud recording. Otherwise, false.

◆ CanHideParticipantProfilePictures()

virtual SDKError IMeetingParticipantsController::CanHideParticipantProfilePictures ( )

pure virtual

Determines if the current user can hide participant profile pictures.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ CanReclaimHost()

virtual SDKError IMeetingParticipantsController::CanReclaimHost ( bool & bCanReclaimHost )

pure virtual

Determines 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, this function returns an error.

Note: 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, this function returns an error.

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

◆ CreateVirtualNameTagRosterInfoBegin()

virtual SDKError IMeetingParticipantsController::CreateVirtualNameTagRosterInfoBegin ( )

pure virtual

Prepare to Update virtual name tag roster infomation.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: If the function succeeds, all the created virtual name tag roster will be removed.

◆ CreateVirtualNameTagRosterInfoCommit()

virtual SDKError IMeetingParticipantsController::CreateVirtualNameTagRosterInfoCommit ( )

pure virtual

Batch create virtual name tag roster infoTo according to the prepare list.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: CreateVirtualNameTagRosterInfoBegin() must be called before this function is called. Otherwise SDKErr_WRONG_USAGE will be returned.

◆ EnableVirtualNameTag()

virtual SDKError IMeetingParticipantsController::EnableVirtualNameTag ( bool bEnabled )

pure virtual

Enables the virtual name tag feature for the account.

Parameters

bEnabled true indicates enabled, Otherwise not.

Returns: If the function succeeds, it return SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ 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, this function returns an error.

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

◆ GetAuthorizedBotListByUserID()

virtual IList< unsigned int > * IMeetingParticipantsController::GetAuthorizedBotListByUserID ( unsigned int userid )

pure virtual

Gets the authorizer's bot list.

Parameters

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

Returns: If the function succeeds, the return value is the authorizer's bot list in the meeting. Otherwise, the return value is nullptr.

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

◆ GetBotAuthorizedUserInfoByUserID()

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

pure virtual

Gets the information about the bot's authorized user.

Parameters

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

Returns: If the function succeeds, the return value is a pointer to the IUserInfo. Otherwise, the return value is nullptr.

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

◆ GetFocusModeShareType()

virtual FocusModeShareType IMeetingParticipantsController::GetFocusModeShareType ( )

pure virtual

Gets 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

Gets the information of current user.

Returns: If the function succeeds, the return value is a pointer to the IUserInfo. Otherwise, the return value is nullptr.

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

◆ GetParticipantsList()

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

pure virtual

Gets 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 return value is nullptr.

Note: 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

Gets 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. Otherwise, the return value is nullptr.

Note: 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, this function returns an error.

◆ IsAutoAllowLocalRecordingRequest()

virtual bool IMeetingParticipantsController::IsAutoAllowLocalRecordingRequest ( )

pure virtual

Checks 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

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

Returns: true indicates focus mode enabled. Otherwise not.

◆ IsFocusModeOn()

virtual bool IMeetingParticipantsController::IsFocusModeOn ( )

pure virtual

Determines if the focus mode on or off.

Returns: true indicates 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.

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

◆ IsParticipantProfilePicturesHidden()

virtual bool IMeetingParticipantsController::IsParticipantProfilePicturesHidden ( )

pure virtual

Checks 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

Checks 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

Checks 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

Checks 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

Checks 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

◆ IsSelfOriginalHost()

virtual bool IMeetingParticipantsController::IsSelfOriginalHost ( )

pure virtual

Checks whether myself is original host.

Returns: true if the current user is the original host. Otherwise, false.

◆ IsSupportVirtualNameTag()

virtual bool IMeetingParticipantsController::IsSupportVirtualNameTag ( )

pure virtual

Determines if support virtual name tag feature.

Returns: true if supports the virtual name tag feature. Otherwise, false.

◆ 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, this function returns an error.

Note: 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, this function returns an error.

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

◆ MakeHost()

virtual SDKError IMeetingParticipantsController::MakeHost ( unsigned int userid )

pure virtual

Sets 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, this function returns an error.

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

◆ MakeHostWithAssetsPrivilege()

virtual SDKError IMeetingParticipantsController::MakeHostWithAssetsPrivilege	(	unsigned int	userid,
		IList< GrantCoOwnerAssetsInfo > *	list )

pure virtual

Assigns a user as host and grants privileges to manage assets after the meeting.

Parameters

userid	The ID of user to be assigned as host.
list	A List of GrantCoOwnerAssetsInfo struct representing the assets and privileges to grant.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: The host cannot be assigned as host by himself. And the user should have the power to assign the role.

◆ RaiseHand()

virtual SDKError IMeetingParticipantsController::RaiseHand ( )

pure virtual

Raise hands in the meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: 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, this function returns an error.

Note: 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, this function returns an error.

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

◆ RevokeCoHost()

virtual SDKError IMeetingParticipantsController::RevokeCoHost ( unsigned int userid )

pure virtual

Gets 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, this function returns an error.

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

◆ SetEvent()

virtual SDKError IMeetingParticipantsController::SetEvent ( IMeetingParticipantsCtrlEvent * pEvent )

pure virtual

Sets 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, this function returns an error.

◆ SetFocusModeShareType()

virtual SDKError IMeetingParticipantsController::SetFocusModeShareType ( FocusModeShareType shareType )

pure virtual

Sets 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, this function returns an error.

◆ 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 indicates to turen on, false means to turn off.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddVirtualNameTagRosterInfoToList()

◆ AllowParticipantsToChat()

◆ AllowParticipantsToRename()

◆ AllowParticipantsToRequestCloudRecording()

◆ AllowParticipantsToRequestLocalRecording()

◆ AllowParticipantsToShareWhiteBoard()

◆ AllowParticipantsToStartVideo()

◆ AllowParticipantsToUnmuteSelf()

◆ AskAllToUnmute()

◆ AssignCoHost()

◆ AssignCoHostWithAssetsPrivilege()

◆ AutoAllowLocalRecordingRequest()

◆ CanbeCohost()

◆ CanBeCoOwner()

◆ CanEnableParticipantRequestCloudRecording()

◆ CanHideParticipantProfilePictures()

◆ CanReclaimHost()

◆ ChangeUserName()

◆ CreateVirtualNameTagRosterInfoBegin()

◆ CreateVirtualNameTagRosterInfoCommit()

◆ EnableVirtualNameTag()

◆ ExpelUser()

◆ GetAuthorizedBotListByUserID()

◆ GetBotAuthorizedUserInfoByUserID()

◆ GetFocusModeShareType()

◆ GetMySelfUser()

◆ GetParticipantsList()

◆ GetUserByUserID()

◆ HideParticipantProfilePictures()

◆ IsAutoAllowLocalRecordingRequest()

◆ IsFocusModeEnabled()

◆ IsFocusModeOn()

◆ IsParticipantAllowedToChat()

◆ IsParticipantProfilePicturesHidden()

◆ IsParticipantRequestCloudRecordingAllowed()

◆ IsParticipantRequestLocalRecordingAllowed()

◆ IsParticipantsRenameAllowed()

◆ IsParticipantsShareWhiteBoardAllowed()

◆ IsParticipantsStartVideoAllowed()

◆ IsParticipantsUnmuteSelfAllowed()

◆ IsSelfOriginalHost()

◆ IsSupportVirtualNameTag()

◆ LowerAllHands()

◆ LowerHand()

◆ MakeHost()

◆ MakeHostWithAssetsPrivilege()

◆ RaiseHand()

◆ ReclaimHost()

◆ ReclaimHostByHostKey()

◆ RevokeCoHost()

◆ SetEvent()

◆ SetFocusModeShareType()

◆ TurnFocusModeOn()