Windows SDK API Reference
Loading...
Searching...
No Matches
meeting_participants_ctrl_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_ParticipantsCtrl_INTERFACE_H_
7#define _MEETING_ParticipantsCtrl_INTERFACE_H_
8#include "zoom_sdk_def.h"
16{
23};
24
30{
33 {
34 allow_talk = false;
35 }
37
41{
42public:
46 virtual const wchar_t* GetUserName() = 0;
47
50 virtual bool IsHost() = 0;
51
55 virtual unsigned int GetUserID() = 0;
56
60 virtual const wchar_t* GetPersistentId() = 0;
61
67 virtual const wchar_t* GetCustomerKey() = 0;
68
71 virtual bool IsVideoOn() = 0;
72
75 virtual bool IsAudioMuted() = 0;
76
80
83 virtual bool IsMySelf() = 0;
84
87 virtual bool IsInWaitingRoom() = 0;
88
91 virtual bool IsRaiseHand() = 0;
92
95 virtual UserRole GetUserRole() = 0;
96
99 virtual bool IsPurePhoneUser() = 0;
100
103 virtual int GetAudioVoiceLevel() = 0;
104
107 virtual bool IsClosedCaptionSender() = 0;
108
111 virtual bool IsTalking() = 0;
112
115 virtual bool IsH323User() = 0;
116
120
123 virtual bool IsInterpreter() = 0;
124
127 virtual bool IsSignLanguageInterpreter() = 0;
128
131 virtual const wchar_t* GetInterpreterActiveLanguage() = 0;
132
136
139 virtual bool IsRawLiveStreaming() = 0;
140
143 virtual bool HasRawLiveStreamPrivilege() = 0;
144
145 virtual ~IUserInfo(){};
146};
147
151{
152public:
154
158 virtual void onUserJoin(IList<unsigned int >* lstUserID, const wchar_t* strUserList = NULL) = 0;
159
163 virtual void onUserLeft(IList<unsigned int >* lstUserID, const wchar_t* strUserList = NULL) = 0;
164
167 virtual void onHostChangeNotification(unsigned int userId) = 0;
168
172 virtual void onLowOrRaiseHandStatusChanged(bool bLow, unsigned int userid) = 0;
173
178 virtual void onUserNameChanged(unsigned int userId, const wchar_t* userName) = 0;
179
182 virtual void onUserNamesChanged(IList<unsigned int>* lstUserID) = 0;
183
187 virtual void onCoHostChangeNotification(unsigned int userId, bool isCoHost) = 0;
188
190 virtual void onInvalidReclaimHostkey() = 0;
191
193 virtual void onAllHandsLowered() = 0;
194
198 virtual void onLocalRecordingStatusChanged(unsigned int user_id, RecordingStatus status) = 0;
199};
200
204{
205public:
211
217
223 virtual IUserInfo* GetUserByUserID(unsigned int userid) = 0;
224
229 virtual IUserInfo* GetMySelfUser() = 0;
230
237 virtual SDKError LowerAllHands(bool forWebinarAttendees) = 0;
238
246 virtual SDKError ChangeUserName(const unsigned int userid, const wchar_t* userName, bool bSaveUserName) = 0;
247
253 virtual SDKError LowerHand(unsigned int userid) = 0;
254
259 virtual SDKError RaiseHand() = 0;
260
266 virtual SDKError MakeHost(unsigned int userid) = 0;
267
273 virtual SDKError CanbeCohost(unsigned int userid) = 0;
274
280 virtual SDKError AssignCoHost(unsigned int userid) = 0;
281
287 virtual SDKError RevokeCoHost(unsigned int userid) = 0;
288
294 virtual SDKError ExpelUser(unsigned int userid) = 0;
295
300 virtual SDKError ReclaimHost() = 0;
301
307 virtual SDKError CanReclaimHost(bool& bCanReclaimHost) = 0;
308
314 virtual SDKError ReclaimHostByHostKey(const wchar_t* host_key) = 0;
315
316 virtual SDKError AllowParticipantsToRename(bool bAllow) = 0;
317
318 virtual bool IsParticipantsRenameAllowed() = 0;
319
320 virtual SDKError AllowParticipantsToUnmuteSelf(bool bAllow) = 0;
321
323
325
331 virtual SDKError AllowParticipantsToChat(bool bAllow) = 0;
332
336 virtual bool IsParticipantAllowedToChat() = 0;
337};
339#endif
Meeting waiting room controller interface.
virtual SDKError SetEvent(IMeetingParticipantsCtrlEvent *pEvent)=0
Set the participants controller callback event handler.
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.
virtual IUserInfo * GetUserByUserID(unsigned int userid)=0
Get the information of specified user.
virtual bool IsParticipantsUnmuteSelfAllowed()=0
virtual bool IsParticipantAllowedToChat()=0
Check whether the current meeting allows participants to chat, it can only be used in regular meeetin...
virtual SDKError AskAllToUnmute()=0
virtual SDKError LowerAllHands(bool forWebinarAttendees)=0
Cancel all hands raised.
virtual SDKError ReclaimHostByHostKey(const wchar_t *host_key)=0
Reclaim role of host via host_key.
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 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 IsParticipantsRenameAllowed()=0
virtual SDKError MakeHost(unsigned int userid)=0
Set the specified user as the host.
virtual SDKError LowerHand(unsigned int userid)=0
Cancel the hands raised of specified user.
virtual SDKError AllowParticipantsToUnmuteSelf(bool bAllow)=0
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 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 SDKError AllowParticipantsToRename(bool bAllow)=0
virtual SDKError ExpelUser(unsigned int userid)=0
Expel the specified user.
Meeting Participants Controller Callback Event.
virtual void onUserNameChanged(unsigned int userId, const wchar_t *userName)=0
Callback event of changing the screen name. this interface be marked as deprecated,...
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 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 onHostChangeNotification(unsigned int userId)=0
Callback event of notification of the new host.
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.
virtual void onUserJoin(IList< unsigned int > *lstUserID, const wchar_t *strUserList=NULL)=0
Callback event of notification of users who are in the meeting.
virtual void onUserLeft(IList< unsigned int > *lstUserID, const wchar_t *strUserList=NULL)=0
Callback event of notification of user who leaves the meeting.
User information interface.
virtual RecordingStatus GetLocalRecordingStatus()=0
Get the local recording status.
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 const wchar_t * GetCustomerKey()=0
Get the customer_key matched with the current user information. If you assign a customer_key for a us...
virtual bool IsAudioMuted()=0
Determine the audio status of the user specified by the current information.
virtual WebinarAttendeeStatus * GetWebinarAttendeeStauts()=0
Get the webinar 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 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 const wchar_t * GetPersistentId()=0
Get the user persistent id matched with the current user information.
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 IsSignLanguageInterpreter()=0
Determine whether the user specified by the current information is a sign language interpreter or not...
virtual bool IsRawLiveStreaming()=0
Determine whether the user has started a raw live stream.
virtual bool IsInterpreter()=0
Determine whether the user specified by the current information is a interpreter or not.
virtual bool IsPurePhoneUser()=0
Determine whether the user corresponding to the current information joins the meeting by telephone or...
virtual const wchar_t * GetUserName()=0
Get the username 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 const wchar_t * GetInterpreterActiveLanguage()=0
Get the active language, if the user is a interpreter.
AudioType
Define the audio type of the user. Here are more detailed structural descriptions.
UserRole
Role of user. Here are more detailed structural descriptions.
@ USERROLE_COHOST
Role of co-host.
@ USERROLE_BREAKOUTROOM_MODERATOR
Host role in breakout room.
@ USERROLE_ATTENDEE
Role of attendee.
@ USERROLE_HOST
Role of the host.
@ USERROLE_PANELIST
Role of the panelist, valid only in webinar.
@ USERROLE_NONE
For initialization.
struct tagWebinarAttendeeStatus WebinarAttendeeStatus
Recording of Meeting Service Interface Valid for both ZOOM style and user custom interface mode.
RecordingStatus
Recording status. Here are more detailed structural descriptions.
Status of webinar attendee. Here are more detailed structural descriptions.
bool allow_talk
TRUE indicates that it is able to talk.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:21
#define BEGIN_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:20
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:30