Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
meeting_participants_ctrl_interface.h
Go to the documentation of this file.
1
5#ifndef _MEETING_ParticipantsCtrl_INTERFACE_H_
6#define _MEETING_ParticipantsCtrl_INTERFACE_H_
7#include "zoom_sdk_def.h"
9#if defined(WIN32)
10#include "meeting_service_components/meeting_emoji_reaction_interface.h"
11#endif
32
46
57
63{
65 int tagID;
68
70 {
71 tagID = 0;
72 tagName = nullptr;
73 }
75
81{
82public:
88 virtual const zchar_t* GetUserName() = 0;
89
94 virtual bool IsHost() = 0;
95
101 virtual unsigned int GetUserID() = 0;
102
107 virtual const zchar_t* GetAvatarPath() = 0;
108
113 virtual const zchar_t* GetPersistentId() = 0;
114
120 virtual const zchar_t* GetCustomerKey() = 0;
121
127 virtual bool IsVideoOn() = 0;
128
133 virtual bool IsAudioMuted() = 0;
134
140
145 virtual bool IsMySelf() = 0;
146
151 virtual bool IsInWaitingRoom() = 0;
152
157 virtual bool IsRaiseHand() = 0;
158
163 virtual UserRole GetUserRole() = 0;
164
169 virtual bool IsPurePhoneUser() = 0;
170
175 virtual int GetAudioVoiceLevel() = 0;
176
181 virtual bool IsClosedCaptionSender() = 0;
182
187 virtual bool IsTalking() = 0;
188
193 virtual bool IsH323User() = 0;
194
200
201#if defined(WIN32)
206 virtual bool IsInterpreter() = 0;
207
212 virtual bool IsSignLanguageInterpreter() = 0;
213
218 virtual const zchar_t* GetInterpreterActiveLanguage() = 0;
219
224 virtual SDKEmojiFeedbackType GetEmojiFeedbackType() = 0;
225
230 virtual bool IsCompanionModeUser() = 0;
231#endif
232
238
243 virtual bool IsRawLiveStreaming() = 0;
244
249 virtual bool HasRawLiveStreamPrivilege() = 0;
250
255 virtual bool HasCamera() = 0;
256
261 virtual bool IsProductionStudioUser() = 0;
262
267 virtual bool IsInWebinarBackstage() = 0;
268
273 virtual unsigned int GetProductionStudioParent() = 0;
274
279 virtual bool IsBotUser() = 0;
280
286 virtual const zchar_t* GetBotAppName() = 0;
287
292 virtual bool IsVirtualNameTagEnabled() = 0;
293
299
306
307 virtual ~IUserInfo(){};
308};
309
315{
316public:
324 virtual void onUserJoin(IList<unsigned int >* lstUserID, const zchar_t* strUserList = nullptr) = 0;
325
332 virtual void onUserLeft(IList<unsigned int >* lstUserID, const zchar_t* strUserList = nullptr) = 0;
333
338 virtual void onHostChangeNotification(unsigned int userId) = 0;
339
345 virtual void onLowOrRaiseHandStatusChanged(bool bLow, unsigned int userid) = 0;
346
352 virtual void onUserNamesChanged(IList<unsigned int>* lstUserID) = 0;
353
359 virtual void onCoHostChangeNotification(unsigned int userId, bool isCoHost) = 0;
360
364 virtual void onInvalidReclaimHostkey() = 0;
365
369 virtual void onAllHandsLowered() = 0;
370
376 virtual void onLocalRecordingStatusChanged(unsigned int user_id, RecordingStatus status) = 0;
377
382 virtual void onAllowParticipantsRenameNotification(bool bAllow) = 0;
383
388 virtual void onAllowParticipantsUnmuteSelfNotification(bool bAllow) = 0;
389
394 virtual void onAllowParticipantsStartVideoNotification(bool bAllow) = 0;
395
401
407
412 virtual void onAllowParticipantsRequestCloudRecording(bool bAllow) = 0;
413
418 virtual void onInMeetingUserAvatarPathUpdated(unsigned int userID) = 0;
419
424 virtual void onParticipantProfilePictureStatusChange(bool bHidden) = 0;
425
430 virtual void onFocusModeStateChanged(bool bEnabled) = 0;
431
437
442 virtual void onBotAuthorizerRelationChanged(unsigned int authorizeUserID) = 0;
443
449 virtual void onVirtualNameTagStatusChanged(bool bOn, unsigned int userID) = 0;
450
455 virtual void onVirtualNameTagRosterInfoUpdated(unsigned int userID) = 0;
456
457#if defined(WIN32)
463 virtual void onCreateCompanionRelation(unsigned int parentUserID, unsigned int childUserID) = 0;
464
469 virtual void onRemoveCompanionRelation(unsigned int childUserID) = 0;
470#endif
471
476 virtual void onGrantCoOwnerPrivilegeChanged(bool canGrantOther) = 0;
477};
478
484{
485public:
492
499
506 virtual IUserInfo* GetUserByUserID(unsigned int userid) = 0;
507
513 virtual IUserInfo* GetMySelfUser() = 0;
514
521 virtual IUserInfo* GetBotAuthorizedUserInfoByUserID(unsigned int userid) = 0;
522
529 virtual IList<unsigned int >* GetAuthorizedBotListByUserID(unsigned int userid) = 0;
530
531
532#if defined(WIN32)
539 virtual IUserInfo* GetCompanionParentUser(unsigned int userid) = 0;
540
547 virtual IList<unsigned int >* GetCompanionChildList(unsigned int userid) = 0;
548#endif
549
557 virtual SDKError LowerAllHands(bool forWebinarAttendees) = 0;
558
567 virtual SDKError ChangeUserName(const unsigned int userid, const zchar_t* userName, bool bSaveUserName) = 0;
568
575 virtual SDKError LowerHand(unsigned int userid) = 0;
576
582 virtual SDKError RaiseHand() = 0;
583
590 virtual SDKError MakeHost(unsigned int userid) = 0;
591
598 virtual SDKError CanbeCohost(unsigned int userid) = 0;
599
606 virtual SDKError AssignCoHost(unsigned int userid) = 0;
607
614 virtual SDKError RevokeCoHost(unsigned int userid) = 0;
615
622 virtual SDKError ExpelUser(unsigned int userid) = 0;
623
628 virtual bool IsSelfOriginalHost() = 0;
629
635 virtual SDKError ReclaimHost() = 0;
636
643 virtual SDKError CanReclaimHost(bool& bCanReclaimHost) = 0;
644
651 virtual SDKError ReclaimHostByHostKey(const zchar_t* host_key) = 0;
652
653 virtual SDKError AllowParticipantsToRename(bool bAllow) = 0;
654
655 virtual bool IsParticipantsRenameAllowed() = 0;
656
657 virtual SDKError AllowParticipantsToUnmuteSelf(bool bAllow) = 0;
658
660
662
668 virtual SDKError AllowParticipantsToStartVideo(bool bAllow) = 0;
669
675
682
688
695 virtual SDKError AllowParticipantsToChat(bool bAllow) = 0;
696
702 virtual bool IsParticipantAllowedToChat() = 0;
703
709
716
722
728 virtual SDKError AutoAllowLocalRecordingRequest(bool bAllow) = 0;
729
735
741
748
753 virtual bool IsFocusModeEnabled() = 0;
754
759 virtual bool IsFocusModeOn() = 0;
760
766 virtual SDKError TurnFocusModeOn(bool turnOn) = 0;
767
773
781
787
793
800
805 virtual bool IsSupportVirtualNameTag() = 0;
806
812 virtual SDKError EnableVirtualNameTag(bool bEnabled) = 0;
813
820
828
835
841 virtual bool CanBeCoOwner(unsigned int userid) = 0;
842
851
860
861};
863#endif
Meeting waiting room controller interface.
virtual SDKError SetEvent(IMeetingParticipantsCtrlEvent *pEvent)=0
Set the participants controller callback event handler.
virtual IUserInfo * GetUserByUserID(unsigned int userid)=0
Get the information of specified user.
virtual SDKError HideParticipantProfilePictures(bool bHide)=0
Hide/Show participant profile pictures.
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 CreateVirtualNameTagRosterInfoCommit()=0
Batch create virtual name tag roster infoTo according to the prepare list.
virtual bool IsParticipantsStartVideoAllowed()=0
Check whether the current meeting allows participants to start video, it can only be used in regular ...
virtual SDKError CreateVirtualNameTagRosterInfoBegin()=0
Prepare to Update virtual name tag roster infomation.
virtual bool IsParticipantsUnmuteSelfAllowed()=0
virtual SDKError AllowParticipantsToRequestCloudRecording(bool bAllow)=0
Toggle whether attendees can requests for the host to start a cloud recording. This can only be used ...
virtual bool AddVirtualNameTagRosterInfoToList(ZoomSDKVirtualNameTag userRoster)=0
Add the userRoster to a prepared list.
virtual bool IsParticipantAllowedToChat()=0
Check whether the current meeting allows participants to chat, it can only be used in regular meeetin...
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 man...
virtual SDKError AllowParticipantsToStartVideo(bool bAllow)=0
Allowing the regular attendees to start video, it can only be used in regular meeetings(no bo).
virtual SDKError AskAllToUnmute()=0
virtual bool IsSelfOriginalHost()=0
Check whether myself is original host.
virtual SDKError LowerAllHands(bool forWebinarAttendees)=0
Cancel all hands raised.
virtual IUserInfo * GetBotAuthorizedUserInfoByUserID(unsigned int userid)=0
Get the information about the bot's authorized user.
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 FocusModeShareType GetFocusModeShareType()=0
Get focus mode share type indicating who can see the shared content which is controlled by host or co...
virtual bool IsParticipantsShareWhiteBoardAllowed()=0
Check whether the current meeting allows participants to share whiteboard, it can only be used in reg...
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 CanEnableParticipantRequestCloudRecording()=0
Determine if the current user can enable participant request clould recording.
virtual SDKError ReclaimHost()=0
Reclaim the role of the host.
virtual IList< unsigned int > * GetParticipantsList()=0
Get the list of all the panelists in the meeting.
virtual SDKError RaiseHand()=0
Raise hands in 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.
virtual SDKError AllowParticipantsToRequestLocalRecording(bool bAllow)=0
Allowing the regular attendees to send local recording privilege request, it can only be used in regu...
virtual SDKError CanReclaimHost(bool &bCanReclaimHost)=0
Determine if the user has the right to reclaim the host role.
virtual SDKError AssignCoHost(unsigned int userid)=0
Set the specified user as the co-host.
virtual bool IsParticipantRequestCloudRecordingAllowed()=0
Check whether the current meeting allows participants to send cloud recording privilege request,...
virtual bool IsParticipantsRenameAllowed()=0
virtual SDKError MakeHost(unsigned int userid)=0
Set the specified user as the host.
virtual bool IsAutoAllowLocalRecordingRequest()=0
Check whether the current meeting auto grant participants local recording privilege request,...
virtual SDKError EnableVirtualNameTag(bool bEnabled)=0
Enable the virtual name tag feature for the account.
virtual bool IsSupportVirtualNameTag()=0
Determine if support virtual name tag feature.
virtual SDKError LowerHand(unsigned int userid)=0
Cancel the hands raised of specified user.
virtual SDKError AllowParticipantsToUnmuteSelf(bool bAllow)=0
virtual SDKError CanHideParticipantProfilePictures()=0
Determine if the current user can hide participant profile pictures.
virtual SDKError CanbeCohost(unsigned int userid)=0
Determine if it is able to change the specified user role as the co-host.
virtual IUserInfo * GetMySelfUser()=0
Get the information of current user.
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 an...
virtual SDKError ReclaimHostByHostKey(const zchar_t *host_key)=0
Reclaim role of host via host_key.
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 SDKError RevokeCoHost(unsigned int userid)=0
Get back the co-host role from the specified user.
virtual bool IsParticipantRequestLocalRecordingAllowed()=0
Check whether the current meeting allows participants to send local recording privilege request,...
virtual SDKError AllowParticipantsToRename(bool bAllow)=0
virtual bool IsFocusModeOn()=0
Determine if the focus mode on or off.
virtual bool IsParticipantProfilePicturesHidden()=0
Check whether the current meeting hides participant pictures.
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-h...
virtual SDKError AutoAllowLocalRecordingRequest(bool bAllow)=0
Auto grant or deny the regular attendee's local recording privilege request, it can only be used in r...
virtual IList< unsigned int > * GetAuthorizedBotListByUserID(unsigned int userid)=0
Get the authorizer's bot list.
virtual SDKError ExpelUser(unsigned int userid)=0
Expel the specified user.
virtual bool IsFocusModeEnabled()=0
Determine if the focus mode enabled or not by web portal.
Meeting Participants Controller Callback Event.
virtual void onVirtualNameTagStatusChanged(bool bOn, unsigned int userID)=0
Notification of virtual name tag status change.
virtual void onFocusModeShareTypeChanged(FocusModeShareType type)=0
Callback event that that focus mode share type changed by host or co-host.
virtual void onUserNamesChanged(IList< unsigned int > *lstUserID)=0
Callback event of changing the screen name.
virtual void onAllHandsLowered()=0
Callback event of the host calls the lower all hands interface, the host/cohost/panelist will receive...
virtual void onInMeetingUserAvatarPathUpdated(unsigned int userID)=0
Callback event that the user avatar path is updated in the meeting.
virtual void onAllowParticipantsStartVideoNotification(bool bAllow)=0
Callback event that lets participants start a video.
virtual void onVirtualNameTagRosterInfoUpdated(unsigned int userID)=0
Notification of virtual name tag roster info updated.
virtual void onLocalRecordingStatusChanged(unsigned int user_id, RecordingStatus status)=0
Callback event that the status of local recording changes.
virtual void onInvalidReclaimHostkey()=0
Callback event of invalid host key.
virtual void onBotAuthorizerRelationChanged(unsigned int authorizeUserID)=0
Callback event that the bot relationship changed in the meeting.
virtual void onHostChangeNotification(unsigned int userId)=0
Callback event of notification of the new host.
virtual void onAllowParticipantsShareWhiteBoardNotification(bool bAllow)=0
Callback event that lets participants share a new whiteboard.
virtual void onParticipantProfilePictureStatusChange(bool bHidden)=0
Callback event that participant profile status change.
virtual void onAllowParticipantsRenameNotification(bool bAllow)=0
Callback event that lets participants rename themself.
virtual void onFocusModeStateChanged(bool bEnabled)=0
Callback event that focus mode changed by host or co-host.
virtual void onAllowParticipantsUnmuteSelfNotification(bool bAllow)=0
Callback event that lets participants unmute themself.
virtual void onRequestLocalRecordingPrivilegeChanged(LocalRecordingRequestPrivilegeStatus status)=0
Callback event that the request local recording privilege changes.
virtual void onUserLeft(IList< unsigned int > *lstUserID, const zchar_t *strUserList=nullptr)=0
Callback event of notification of user who leaves the meeting.
virtual void onUserJoin(IList< unsigned int > *lstUserID, const zchar_t *strUserList=nullptr)=0
Callback event of notification of users who are in the meeting.
virtual void onAllowParticipantsRequestCloudRecording(bool bAllow)=0
Callback event that lets participants request that the host starts cloud recording.
virtual void onGrantCoOwnerPrivilegeChanged(bool canGrantOther)=0
Callback event when the user's grant co-owner permission changed.
virtual void onCoHostChangeNotification(unsigned int userId, bool isCoHost)=0
Callback event of changing the co-host.
virtual void onLowOrRaiseHandStatusChanged(bool bLow, unsigned int userid)=0
Callback event of changing the state of the hand.
User information interface.
virtual bool IsProductionStudioUser()=0
Determine whether the user is production studio user.
virtual RecordingStatus GetLocalRecordingStatus()=0
Get the local recording status.
virtual unsigned int GetProductionStudioParent()=0
Get the parent user ID of the production studio user.
virtual AudioType GetAudioJoinType()=0
Get the audio type of the user specified by the current information when joins the meeting.
virtual bool IsVideoOn()=0
Determine the video status of the user specified by the current information.
virtual IList< GrantCoOwnerAssetsInfo > * GetGrantCoOwnerAssetsInfo()=0
Query the granted assets info when assign a co-owner.
virtual const zchar_t * GetUserName()=0
Get the username matched with the current user information.
virtual bool IsAudioMuted()=0
Determine the audio status of the user specified by the current information.
virtual bool IsMySelf()=0
Determine whether the current information corresponds to the user himself or not.
virtual bool IsRaiseHand()=0
Determine whether the user specified by the current information raises hand or not.
virtual const zchar_t * GetPersistentId()=0
Get the user persistent id matched with the current user information.
virtual const zchar_t * GetAvatarPath()=0
Get the avatar file path matched with the current user information.
virtual bool IsH323User()=0
Determine whether the user specified by the current information is H323 user or not.
virtual bool IsHost()=0
Determine whether the member corresponding with the current information is the host or not.
virtual unsigned int GetUserID()=0
Get the user ID matched with the current user information.
virtual bool IsClosedCaptionSender()=0
Determine whether the user corresponding to the current information is the sender of Closed Caption o...
virtual bool IsVirtualNameTagEnabled()=0
Query if the participant enabled virtual name tag.
virtual bool IsTalking()=0
Determine whether the user specified by the current information is talking or not.
virtual UserRole GetUserRole()=0
Get the type of role of the user specified by the current information.
virtual bool IsInWaitingRoom()=0
Determine whether the user specified by the current information is in the waiting room or not.
virtual bool IsRawLiveStreaming()=0
Determine whether the user has started a raw live stream.
virtual const zchar_t * GetBotAppName()=0
Get the bot app name.
virtual bool HasCamera()=0
Query if the participant has a camera.
virtual bool IsPurePhoneUser()=0
Determine whether the user corresponding to the current information joins the meeting by telephone or...
virtual const zchar_t * GetCustomerKey()=0
Get the customer_key matched with the current user information.
virtual int GetAudioVoiceLevel()=0
Get the Mic level of the user corresponding to the current information.
virtual bool HasRawLiveStreamPrivilege()=0
Determine whether the user has raw live stream privilege.
virtual bool IsBotUser()=0
Determine whether the user specified by the current information is bot user or not.
virtual bool IsInWebinarBackstage()=0
Determine whether the user specified by the current information is in the webinar backstage or not.
virtual WebinarAttendeeStatus * GetWebinarAttendeeStatus()=0
Get the webinar status of the user specified by the current information.
virtual IList< ZoomSDKVirtualNameTag > * GetVirtualNameTagList()=0
Query the virtual name tag roster infomation.
AudioType
Define the audio type of the user. Here are more detailed structural descriptions.
UserRole
Role of user. Here are more detailed structural descriptions.
struct tagZoomSDKVirtualNameTag ZoomSDKVirtualNameTag
Info of virtual name tag. Here are more detailed structural descriptions.
FocusModeShareType
Type of focus mode. Here are more detailed structural descriptions.
struct tagWebinarAttendeeStatus WebinarAttendeeStatus
Status of webinar attendee. Here are more detailed structural descriptions.
Recording of Meeting Service Interface.
RecordingStatus
Recording status. Here are more detailed structural descriptions.
LocalRecordingRequestPrivilegeStatus
Status of webinar attendee. Here are more detailed structural descriptions.
Info of virtual name tag. Here are more detailed structural descriptions.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.