Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
meeting_waiting_room_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_WaitingRoom_INTERFACE_H_
7#define _MEETING_WaitingRoom_INTERFACE_H_
8#include "zoom_sdk_def.h"
9
11
22
34
41
51
58
87
93{
94public:
96
101 virtual bool Retry() = 0;
102
106 virtual void Ignore() = 0;
107};
108
114{
115public:
117
122 virtual void onWaitingRoomUserJoin(unsigned int userID) = 0;
123
128 virtual void onWaitingRoomUserLeft(unsigned int userID) = 0;
129
134 virtual void onWaitingRoomPresetAudioStatusChanged(bool bAudioCanTurnOn) = 0;
135
140 virtual void onWaitingRoomPresetVideoStatusChanged( bool bVideoCanTurnOn) = 0;
141
147
153 virtual void onWaitingRoomUserNameChanged(unsigned int userID, const zchar_t* userName) = 0;
154
159 virtual void onWaitingRoomEntranceEnabled(bool bIsEnabled) = 0;
160};
161
167{
168public:
175
180 virtual bool IsSupportWaitingRoom() = 0;
181
186 virtual bool IsWaitingRoomOnEntryFlagOn() = 0;
187
193 virtual SDKError EnableWaitingRoomOnEntry(bool bEnable) = 0;
194
200
206 virtual IUserInfo* GetWaitingRoomUserInfoByID(unsigned int userid) = 0;
207
213 virtual SDKError AdmitToMeeting(unsigned int userid) = 0;
214
220
226 virtual SDKError PutInWaitingRoom(unsigned int userid) = 0;
227
232 virtual bool IsAudioEnabledInWaitingRoom() = 0;
233
238 virtual bool IsVideoEnabledInWaitingRoom() = 0;
239
245 virtual SDKError PresetAudioInWaitingRoom(bool bMute) = 0;
246
252
258 virtual SDKError PresetVideoInWaitingRoom(bool bMute) = 0;
259
265
271
277 virtual SDKError CanRenameUser(bool& bIsCan) = 0;
278
285 virtual SDKError RenameUser(unsigned userid, const zchar_t* newName) = 0;
286
292 virtual SDKError CanExpelUser(bool& bIsCan) = 0;
293
299 virtual SDKError ExpelUser(unsigned int userid) = 0;
300
305 virtual bool IsWaitingRoomOnEntryLocked() = 0;
306};
308#endif
Meeting waiting room controller interface.
virtual bool IsPresetAudioUnmuteInWaitingRoom()=0
Get the audio pre-set mute or unmute status in waiting room.
virtual bool IsWaitingRoomOnEntryFlagOn()=0
Determine if the attendee is enabled to enter the waiting room when joining the meeting.
virtual IList< unsigned int > * GetWaitingRoomLst()=0
Get the list of attendees who are in the waiting room.
virtual bool IsPresetVideoUnmuteInWaitingRoom()=0
Get the video pre-set mute or unmute status in waiting room.
virtual IUserInfo * GetWaitingRoomUserInfoByID(unsigned int userid)=0
Get the attendee information in the waiting room via user ID.
virtual SDKError CanRenameUser(bool &bIsCan)=0
Determine if the host or cohost can rename users in the waiting room.
virtual SDKError AdmitAllToMeeting()=0
Permit all of the users currently in the waiting room to join the meeting.
virtual SDKError SetEvent(IMeetingWaitingRoomEvent *pEvent)=0
Set meeting waiting room callback event handler.
virtual bool IsWaitingRoomOnEntryLocked()=0
Determine if the enable waiting room on entry feature is locked, see EnableWaitingRoomOnEntry.
virtual SDKError PutInWaitingRoom(unsigned int userid)=0
Enable the specified user to enter the waiting room.
virtual SDKError EnableWaitingRoomOnEntry(bool bEnable)=0
Set to enable the attendee to enter the waiting room when joining the meeting.
virtual bool IsVideoEnabledInWaitingRoom()=0
Determine if the attendee is enabled to turn on video when joining the meeting.
virtual SDKError PresetAudioInWaitingRoom(bool bMute)=0
Pre-set audio mute or unmute status in waiting room.
virtual bool IsAudioEnabledInWaitingRoom()=0
Determine if the attendee is enabled to turn on audio when joining the meeting.
virtual bool IsSupportWaitingRoom()=0
Determine whether the current meeting supports the waiting room or not.
virtual SDKError CanExpelUser(bool &bIsCan)=0
Determine if a host or cohost can expel user(s) in the waiting room.
virtual SDKError RequestCustomWaitingRoomData()=0
Get the WaitingRoom CustomizeData information in the waiting room.
virtual SDKError RenameUser(unsigned userid, const zchar_t *newName)=0
Change a user's screen name in the waiting room.
virtual SDKError AdmitToMeeting(unsigned int userid)=0
Permit the specified user to join the meeting.
virtual SDKError ExpelUser(unsigned int userid)=0
Remove a specified user from the waiting room.
virtual SDKError PresetVideoInWaitingRoom(bool bMute)=0
Pre-set video mute or unmute status in waiting room.
Meeting Waiting Room Callback Event.
virtual void onWaitingRoomEntranceEnabled(bool bIsEnabled)=0
This callback event will be triggered when host or cohost enables or disables waiting room entrance.
virtual void onWaitingRoomUserNameChanged(unsigned int userID, const zchar_t *userName)=0
Callback indicating that the name of a user in the waiting room has changed.
virtual void onWaitingRoomPresetVideoStatusChanged(bool bVideoCanTurnOn)=0
During the waiting room, this callback event will be triggered when host change video status.
virtual void onWaitingRoomUserJoin(unsigned int userID)=0
Callback event of notification that user joins the waiting room.
virtual void onCustomWaitingRoomDataUpdated(CustomWaitingRoomData &bData, IWaitingRoomDataDownloadHandler *bHandler)=0
During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData call...
virtual void onWaitingRoomUserLeft(unsigned int userID)=0
Callback event of notification that user leaves the waiting room.
virtual void onWaitingRoomPresetAudioStatusChanged(bool bAudioCanTurnOn)=0
During the waiting room, this callback event will be triggered when host change audio status.
User information interface.
handler for download waitingRoom Customize Data if download fail.
virtual bool Retry()=0
Retry to Download the WaitingRoom CustomizeData information in the waiting room.
virtual void Ignore()=0
Ignore to GDownloadet the WaitingRoom CustomizeData information in the waiting room.
CustomWaitingRoomDataStatus
Download Status of CustomWaitingRoomData. Here are more detailed structural descriptions.
@ CustomWaitingRoomDataStatus_Download_OK
@ CustomWaitingRoomDataStatus_Download_Failed
@ CustomWaitingRoomDataStatus_Downloading
@ CustomWaitingRoomDataStatus_Init
WaitingRoomLayoutType
WaitingRoom LayoutType. Here are more detailed structural descriptions.
struct CustomWaitingRoomData_s CustomWaitingRoomData
The WaitingRoom Customize Data Info. Here are more detailed structural descriptions....
The WaitingRoom Customize Data Info. Here are more detailed structural descriptions....
WaitingRoomBrandingPageColor page_color
WaitingRoomBrandingButtonColor button_color
WaitingRoomBrandingTextColor text_color
CustomWaitingRoomDataStatus status
Zoom SDK color. The standard RGB color model has a value range of 0-255.
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.