Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKWaitingRoomController.h
Go to the documentation of this file.
1
5
6
7NS_ASSUME_NONNULL_BEGIN
8@class ZoomSDKUserInfo;
9
18@property(retain, nonatomic, readonly,nullable)NSColor* backgroundColor;
19@end
20
21
30@property(retain, nonatomic, readonly, nullable)NSColor* primaryColor;
34@property(retain, nonatomic, readonly,nullable)NSColor* secondaryColor;
38@property(retain, nonatomic, readonly,nullable)NSColor* paragraphColor;
42@property(retain, nonatomic, readonly,nullable)NSColor* hyperlinkColor;
43@end
44
45
54@property(retain, nonatomic, readonly,nullable)NSColor* primaryButtonColor;
55@end
56
57
62@interface ZoomSDKCustomWaitingRoomData : NSObject
66@property (copy, nonatomic, readonly, nullable) NSString* title;
70@property (copy, nonatomic, readonly, nullable) NSString* dataDescription;
74@property (copy, nonatomic, readonly, nullable) NSString* logoPath;
78@property (copy, nonatomic, readonly, nullable) NSString* videoPath;
82@property (copy, nonatomic, readonly, nullable) NSString* imagePath;
86@property (assign, nonatomic, readonly) ZoomSDKWaitingRoomLayoutType type;
90@property (assign, nonatomic, readonly) ZoomSDKCustomWaitingRoomDataStatus status;
94@property (retain, nonatomic, readonly) ZoomSDKWaitingRoomBrandingPageColor* pageColor;
98@property (retain, nonatomic, readonly) ZoomSDKWaitingRoomBrandingTextColor* textColor;
102@property (retain, nonatomic, readonly) ZoomSDKWaitingRoomBrandingButtonColor* buttonColor;
103@end
104
105
114- (void)retry;
118- (void)ignore;
119@end
120
121
126@protocol ZoomSDKWaitingRoomDelegate <NSObject>
131- (void)onUserJoinWaitingRoom:(unsigned int)userid;
136- (void)onUserLeftWaitingRoom:(unsigned int)userid;
137
142- (void)onWaitingRoomPresetAudioStatusChanged:(BOOL)audioCanTurnOn;
143
148- (void)onWaitingRoomPresetVideoStatusChanged:(BOOL)videoCanTurnOn;
149
155- (void)onCustomWaitingRoomDataUpdated:(ZoomSDKCustomWaitingRoomData*_Nullable)bData handle:(ZoomSDKWaitingRoomDataDownloadHandler*_Nullable)handle;
156
162- (void)onWaitingRoomUserNameChanged:(unsigned int)userID userName:(NSString *)userName;
163
168- (void)onWaitingRoomEntranceEnabled:(BOOL)enabled;
169@end
170
171
176@interface ZoomSDKWaitingRoomController : NSObject
177{
178 id<ZoomSDKWaitingRoomDelegate> _delegate;
179}
183@property (assign, nonatomic, nullable) id<ZoomSDKWaitingRoomDelegate> delegate;
189
195
206- (ZoomSDKError)enableWaitingRoomOnEntry:(BOOL)enable;
211- (NSArray*_Nullable)getWaitRoomUserList;
217- (ZoomSDKUserInfo*_Nullable)getWaitingRoomUserInfo:(unsigned int)userid;
223- (ZoomSDKError)admitToMeeting:(unsigned int)userid;
224
230
236- (ZoomSDKError)putIntoWaitingRoom:(unsigned int)userid;
237
243
250- (ZoomSDKError)presetAudioInWaitingRoom:(BOOL)muteAudio;
251
258
264
271- (ZoomSDKError)presetVideoInWaitingRoom:(BOOL)muteVideo;
272
279
285
291
298- (ZoomSDKError)renameUser:(unsigned int)userID newUserName:(NSString *)userName;
299
305
311- (ZoomSDKError)expelUser:(unsigned int)userID;
312@end
313NS_ASSUME_NONNULL_END
ZoomSDKCustomWaitingRoomDataStatus
Enumeration of the status of custom waiting room data.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKWaitingRoomLayoutType
Enumeration of waiting room layout type. For more information, please visit https://support....
Custom data configuration for the waiting room.
NSString * dataDescription
The description.
ZoomSDKWaitingRoomLayoutType type
The type.
ZoomSDKCustomWaitingRoomDataStatus status
The status.
NSString * logoPath
The path of logo image.
NSString * imagePath
The path of image file.
ZoomSDKWaitingRoomBrandingButtonColor * buttonColor
The object of waiting room branding button color.
ZoomSDKWaitingRoomBrandingTextColor * textColor
The object of waiting room branding text color.
ZoomSDKWaitingRoomBrandingPageColor * pageColor
The object of waiting room branding page color.
NSString * videoPath
The path of video file.
Provides detailed information about a user in a meeting.
Branding button color configuration for the waiting room.
NSColor * primaryButtonColor
The primary Button color.
Branding background color configuration for the waiting room.
NSColor * backgroundColor
The background color.
Branding text color configuration for the waiting room.
NSColor * hyperlinkColor
The hyper link color.
Interface for managing the waiting room during a meeting.
BOOL isVideoEnabledInWaitingRoom()
Determines if the attendee is enabled to turn on video when joining the meeting.
BOOL isWaitingRoomOnEntryLocked()
Query if ZoomSDKWaitingRoomController::enableWaitingRoomOnEntry: feature locked.
BOOL canExpelUser()
Determines if a host or cohost can expel users in the waiting room.
BOOL isEnableWaitingRoomOnEntry()
Query if waiting room is enabled in current meeting.
id< ZoomSDKWaitingRoomDelegate > _delegate
NSArray *_Nullable getWaitRoomUserList()
Gets the list of users in the waiting room.
ZoomSDKError requestCustomWaitingRoomData()
Gets the WaitingRoom CustomizeData information in the waiting room.
BOOL isSupportWaitingRoom()
Query if the meeting supports waiting room.
BOOL isAudioEnabledInWaitingRoom()
Determines if the attendee is enabled to turn on audio when joining the meeting.
BOOL canRenameUser()
Determines if the host or cohost can rename users in the waiting room.
id< ZoomSDKWaitingRoomDelegate > delegate
Sets the delegate to receive waiting room events.
ZoomSDKError admitAllToMeeting()
Permit all of the users currently in the waiting room to join the meeting.
BOOL isPresetVideoUnmuteInWaitingRoom()
Gets the video pre-set mute or unmute status in waiting room.
BOOL isPresetAudioUnmuteInWaitingRoom()
Gets the audio pre-set mute or unmute status in waiting room.
Handler for retrying or ignoring waiting room custom data download failures.
void retry()
Retry to download the waiting room customize data information in the waiting room.
void ignore()
Ignore to downloade the waiting room customize data information in the waiting room.