Meeting Participant helper interface. More...

#include <IParticipantHelper.h>

Public Member Functions
virtual	~IParticipantHelper ()

virtual ZRCSDKError	RegisterSink (IParticipantHelperSink *pSink)=0
	Register meeting user helper callback sink.

virtual ZRCSDKError	DeregisterSink (IParticipantHelperSink *pSink)=0
	Deregister meeting user helper callback sink.

virtual ZRCSDKError	GetParticipantsInMeeting (std::vector< MeetingParticipant > &participants, ConfSessionType session)=0
	Get participants in meeting.

virtual ZRCSDKError	GetVirtualParticipantsInMeeting (std::vector< MeetingParticipant > &participants, ConfSessionType session)=0
	Get virtual participants in meeting (e.g., multi stream, multi camera, etc.).

virtual ZRCSDKError	GetParticipantsInSilentMode (std::vector< MeetingParticipant > &participants)=0
	Get participants in master session who are in silent mode.

virtual ZRCSDKError	GetParticipantsLeftMeeting (std::vector< MeetingParticipant > &participants)=0
	Get participants in master session who have left meeting.

virtual ZRCSDKError	AssignHost (int32_t userID)=0
	Change host to the assigned user.

virtual ZRCSDKError	AssignCohost (int32_t userID, bool assign)=0
	Make user become co-host.

virtual ZRCSDKError	ClaimHost (const std::string &key)=0
	Claim the role of the host.

virtual ZRCSDKError	EnableAttendeesAnnotateOnShare (bool enable)=0
	Enable attendees annotate on shared content.

virtual ZRCSDKError	RenameUser (int32_t userID, const std::string &name)=0
	Rename user.

virtual ZRCSDKError	AllowAttendeesRenameThemselves (bool allow)=0
	Allow attendees rename themselves.

virtual ZRCSDKError	IsAttendeesRenameThemselvesEnabled (bool &enable)=0
	Query is attendees rename themselves enabled.

virtual ZRCSDKError	IsAttendeesRenameThemselvesLocked (bool &locked)=0
	Query is attendees rename themselves locked.

virtual ZRCSDKError	IsAttendeesRenameThemselvesAllowed (bool &allow)=0
	Query is attendees rename themselves allowed.

virtual ZRCSDKError	AllowWebinarAttendeeRaiseHand (bool allow)=0
	Allow webinar attendees raise hand.

virtual ZRCSDKError	RaiseHand (bool raise)=0
	Raise hands in the meeting.

virtual ZRCSDKError	LowerUserHand (int32_t userID)=0
	Lower user hand.

virtual ZRCSDKError	LowerAllHands ()=0
	Cancel all hands raised.

virtual ZRCSDKError	LowerAllAttendeesHands ()=0
	Lower all attendees' hands.

virtual ZRCSDKError	ExpelUser (int32_t userID)=0
	Expel user.

virtual ZRCSDKError	ExpelUsers (const std::vector< int32_t > &userIDs)=0
	Expel users.

virtual ZRCSDKError	HideProfilePictures (bool hidden)=0
	Hide profile pictures.

virtual ZRCSDKError	IsFullRoomViewAvailableForUser (bool &isAvailable, int32_t userID)=0
	Query if user supports hide full room view.

virtual ZRCSDKError	HideFullRoomView (bool isHide, int32_t userID)=0
	Hide full room view.

virtual ZRCSDKError	DownloadUserAvatar (std::string avatarUrl, std::string localFilePath)=0
	Download user avatar.

virtual ZRCSDKError	AllowAttendeesShareWhiteboards (bool allow)=0
	Allow attendees share whiteboards.

virtual ZRCSDKError	SuspendParticipantsActivities ()=0
	Suspend participants activities.

virtual ZRCSDKError	ReportIssue (const std::vector< int32_t > &userIDs, int32_t type, const std::string &email)=0
	Report meeting participants issues.

virtual ZRCSDKError	SetMySelfAsActiveSpeaker ()=0
	Set myself as active speaker.

virtual ZRCSDKError	SetMyChildAsActiveSpeaker (int32_t userID)=0
	Set my child (who's parentUserID equal to my userID) as active speaker.

Detailed Description

Meeting Participant helper interface.

Definition at line 266 of file IParticipantHelper.h.

Constructor & Destructor Documentation

◆ ~IParticipantHelper()

virtual IParticipantHelper::~IParticipantHelper ( )

inlinevirtual

Definition at line 269 of file IParticipantHelper.h.

269{}

Member Function Documentation

◆ AllowAttendeesRenameThemselves()

virtual ZRCSDKError IParticipantHelper::AllowAttendeesRenameThemselves ( bool allow )

pure virtual

Allow attendees rename themselves.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

allow TRUE indicate allow attendees rename themselves. Otherwise not.

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

◆ AllowAttendeesShareWhiteboards()

virtual ZRCSDKError IParticipantHelper::AllowAttendeesShareWhiteboards ( bool allow )

pure virtual

Allow attendees share whiteboards.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

allow TRUE indicate allow attendees share whiteboards. Otherwise not.

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

◆ AllowWebinarAttendeeRaiseHand()

virtual ZRCSDKError IParticipantHelper::AllowWebinarAttendeeRaiseHand ( bool allow )

pure virtual

Allow webinar attendees raise hand.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

allow TRUE indicate allow webinar attendees raise hand. Otherwise not.

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

◆ AssignCohost()

virtual ZRCSDKError IParticipantHelper::AssignCohost	(	int32_t	userID,
		bool	assign
	)

pure virtual

Make user become co-host.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to make co-host.
assign	TRUE indicates make user become co-host. Otherwise not.

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

◆ AssignHost()

virtual ZRCSDKError IParticipantHelper::AssignHost ( int32_t userID )

pure virtual

Change host to the assigned user.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to change host to.

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

◆ ClaimHost()

virtual ZRCSDKError IParticipantHelper::ClaimHost ( const std::string & key )

pure virtual

Claim the role of the host.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

key	The key to get the role of host.

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

◆ DeregisterSink()

virtual ZRCSDKError IParticipantHelper::DeregisterSink ( IParticipantHelperSink * pSink )

pure virtual

Deregister meeting user helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IParticipantHelperSink that receives the meeting user helper callback.

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

◆ DownloadUserAvatar()

virtual ZRCSDKError IParticipantHelper::DownloadUserAvatar	(	std::string	avatarUrl,
		std::string	localFilePath
	)

pure virtual

Download user avatar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

avatarUrl	The avatar url.
localFilePath	Specify the local file path of this avatar. For example, ..../MyAvatarFolder/this_avatar.jpg

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

◆ EnableAttendeesAnnotateOnShare()

virtual ZRCSDKError IParticipantHelper::EnableAttendeesAnnotateOnShare ( bool enable )

pure virtual

Enable attendees annotate on shared content.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable attendees annotate on shared content.

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

◆ ExpelUser()

virtual ZRCSDKError IParticipantHelper::ExpelUser ( int32_t userID )

pure virtual

Expel user.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to expel user.

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

◆ ExpelUsers()

virtual ZRCSDKError IParticipantHelper::ExpelUsers ( const std::vector< int32_t > & userIDs )

pure virtual

Expel users.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userIDs Specify the user ID list to expel users.

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

◆ GetParticipantsInMeeting()

virtual ZRCSDKError IParticipantHelper::GetParticipantsInMeeting	(	std::vector< MeetingParticipant > &	participants,
		ConfSessionType	session
	)

pure virtual

Get participants in meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out]	participants	In meeting participant list.
[in]	session	The session that needed.

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

Changelog

6.3.0: Added a parameter ConfSessionType to get specific type of participant list.

◆ GetParticipantsInSilentMode()

virtual ZRCSDKError IParticipantHelper::GetParticipantsInSilentMode ( std::vector< MeetingParticipant > & participants )

pure virtual

Get participants in master session who are in silent mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] participants In silent mode participant list.

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

Changelog

6.3.0: Only works for getting participants in silent mode of master session.

◆ GetParticipantsLeftMeeting()

virtual ZRCSDKError IParticipantHelper::GetParticipantsLeftMeeting ( std::vector< MeetingParticipant > & participants )

pure virtual

Get participants in master session who have left meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] participants Left meeting participant list.

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

◆ GetVirtualParticipantsInMeeting()

virtual ZRCSDKError IParticipantHelper::GetVirtualParticipantsInMeeting	(	std::vector< MeetingParticipant > &	participants,
		ConfSessionType	session
	)

pure virtual

Get virtual participants in meeting (e.g., multi stream, multi camera, etc.).

Since: 6.3.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out]	participants	In meeting virtual participant list.
[in]	session	The session that needed.

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

◆ HideFullRoomView()

virtual ZRCSDKError IParticipantHelper::HideFullRoomView	(	bool	isHide,
		int32_t	userID
	)

pure virtual

Hide full room view.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isHide	TRUE indicates to hide full room view. Otherwise not.
userID	The Room's userID

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

◆ HideProfilePictures()

virtual ZRCSDKError IParticipantHelper::HideProfilePictures ( bool hidden )

pure virtual

Hide profile pictures.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

hidden TRUE indicates to hide. Otherwise not.

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

◆ IsAttendeesRenameThemselvesAllowed()

virtual ZRCSDKError IParticipantHelper::IsAttendeesRenameThemselvesAllowed ( bool & allow )

pure virtual

Query is attendees rename themselves allowed.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] allow TRUE indicates attendees rename themselves is allowed.

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

◆ IsAttendeesRenameThemselvesEnabled()

virtual ZRCSDKError IParticipantHelper::IsAttendeesRenameThemselvesEnabled ( bool & enable )

pure virtual

Query is attendees rename themselves enabled.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] enable TRUE indicates attendees can rename themselves.

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

◆ IsAttendeesRenameThemselvesLocked()

virtual ZRCSDKError IParticipantHelper::IsAttendeesRenameThemselvesLocked ( bool & locked )

pure virtual

Query is attendees rename themselves locked.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] locked TRUE indicates attendees rename themselves is locked.

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

◆ IsFullRoomViewAvailableForUser()

virtual ZRCSDKError IParticipantHelper::IsFullRoomViewAvailableForUser	(	bool &	isAvailable,
		int32_t	userID
	)

pure virtual

Query if user supports hide full room view.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out]	isAvailable	TRUE indicates user support hide/show full room view.
[in]	userID	The userID

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

◆ LowerAllAttendeesHands()

virtual ZRCSDKError IParticipantHelper::LowerAllAttendeesHands ( )

pure virtual

Lower all attendees' hands.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ LowerAllHands()

virtual ZRCSDKError IParticipantHelper::LowerAllHands ( )

pure virtual

Cancel all hands raised.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ LowerUserHand()

virtual ZRCSDKError IParticipantHelper::LowerUserHand ( int32_t userID )

pure virtual

Lower user hand.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to put down the hands.

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

◆ RaiseHand()

virtual ZRCSDKError IParticipantHelper::RaiseHand ( bool raise )

pure virtual

Raise hands in the meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

raise TRUE indicates to raise self hand. FALSE indicates to lower self hand.

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

◆ RegisterSink()

virtual ZRCSDKError IParticipantHelper::RegisterSink ( IParticipantHelperSink * pSink )

pure virtual

Register meeting user helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IParticipantHelperSink that receives the meeting user helper callback.

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

◆ RenameUser()

virtual ZRCSDKError IParticipantHelper::RenameUser	(	int32_t	userID,
		const std::string &	name
	)

pure virtual

Rename user.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to rename.
name	Specify the name rename to.

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

◆ ReportIssue()

virtual ZRCSDKError IParticipantHelper::ReportIssue	(	const std::vector< int32_t > &	userIDs,
		int32_t	type,
		const std::string &	email
	)

pure virtual

Report meeting participants issues.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userIDs	Participants' ID list
type	Choose the report issue type, bitset see ReportIssueType enum.
email	Receive response notification email.

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

◆ SetMyChildAsActiveSpeaker()

virtual ZRCSDKError IParticipantHelper::SetMyChildAsActiveSpeaker ( int32_t userID )

pure virtual

Set my child (who's parentUserID equal to my userID) as active speaker.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

[in] userID The child's userID

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

◆ SetMySelfAsActiveSpeaker()

virtual ZRCSDKError IParticipantHelper::SetMySelfAsActiveSpeaker ( )

pure virtual

Set myself as active speaker.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

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

◆ SuspendParticipantsActivities()

virtual ZRCSDKError IParticipantHelper::SuspendParticipantsActivities ( )

pure virtual

Suspend participants activities.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IParticipantHelper()

Member Function Documentation

◆ AllowAttendeesRenameThemselves()

◆ AllowAttendeesShareWhiteboards()

◆ AllowWebinarAttendeeRaiseHand()

◆ AssignCohost()

◆ AssignHost()

◆ ClaimHost()

◆ DeregisterSink()

◆ DownloadUserAvatar()

◆ EnableAttendeesAnnotateOnShare()

◆ ExpelUser()

◆ ExpelUsers()

◆ GetParticipantsInMeeting()

◆ GetParticipantsInSilentMode()

◆ GetParticipantsLeftMeeting()

◆ GetVirtualParticipantsInMeeting()

◆ HideFullRoomView()

◆ HideProfilePictures()

◆ IsAttendeesRenameThemselvesAllowed()

◆ IsAttendeesRenameThemselvesEnabled()

◆ IsAttendeesRenameThemselvesLocked()

◆ IsFullRoomViewAvailableForUser()

◆ LowerAllAttendeesHands()

◆ LowerAllHands()

◆ LowerUserHand()

◆ RaiseHand()

◆ RegisterSink()

◆ RenameUser()

◆ ReportIssue()

◆ SetMyChildAsActiveSpeaker()

◆ SetMySelfAsActiveSpeaker()

◆ SuspendParticipantsActivities()