iOS SDK API Reference
Loading...
Searching...
No Matches
MobileRTCWaitingRoomService.h
Go to the documentation of this file.
1//
2// MobileRTCWaitingRoomService.h
3// MobileRTC
4//
5// Created by Zoom Video Communications on 2019/3/6.
6// Copyright © 2019 Zoom Video Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10
15typedef NS_ENUM(NSUInteger, MobileRTCWaitingRoomLayoutType) {
19};
20
25typedef NS_ENUM(NSUInteger, MobileRTCCustomWaitingRoomDataStatus) {
30};
31
36@interface MobileRTCCustomWaitingRoomData : NSObject
37
38@property (nonatomic, retain) NSString * _Nullable title;
39
40@property (nonatomic, retain) NSString * _Nullable descriptionString;
41
42@property (nonatomic, retain) NSString * _Nullable logoPath;
43
44@property (nonatomic, retain) NSString * _Nullable videoPath;
45
46@property (nonatomic, assign) MobileRTCWaitingRoomLayoutType type;
47
48@property (nonatomic, assign) MobileRTCCustomWaitingRoomDataStatus status;
49
50@end
51
57@optional
58
65- (void)onWaitingRoomUserJoin:(NSUInteger)userId;
66- (void)onWaitingRoomUserLeft:(NSUInteger)userId;
67
72- (void)onWaitingRoomPresetAudioStatusChanged:(BOOL)audioCanTurnOn;
73
78- (void)onWaitingRoomPresetVideoStatusChanged:(BOOL)videoCanTurnOn;
79
84- (void)onCustomWaitingRoomDataUpdated:(MobileRTCCustomWaitingRoomData *_Nullable)data;
85@end
86
87@interface MobileRTCWaitingRoomService : NSObject
88
92@property (nullable, assign, nonatomic) id<MobileRTCWaitingRoomServiceDelegate> delegate;
93
98-(BOOL)isSupportWaitingRoom;
99
104-(BOOL)isWaitingRoomOnEntryFlagOn;
105
110- (MobileRTCMeetError)enableWaitingRoomOnEntry:(BOOL)bEnable;
111
116- (nullable NSArray <NSNumber *> *)waitingRoomList;
117
122- (nullable MobileRTCMeetingUserInfo*)waitingRoomUserInfoByID:(NSUInteger)userId;
123
129- (MobileRTCSDKError)admitToMeeting:(NSUInteger)userId;
130
136- (MobileRTCSDKError)admitAllToMeeting;
142- (MobileRTCSDKError)putInWaitingRoom:(NSUInteger)userId;
143
148- (BOOL)isAudioEnabledInWaitingRoom;
149
154- (BOOL)isVideoEnabledInWaitingRoom;
155
160- (MobileRTCSDKError)requestCustomWaitingRoomData;
161
162@end
MobileRTCMeetError
MobileRTCMeetError An enumeration of Meeting States.
MobileRTCSDKError
An enumeration of SDK error.
MobileRTCCustomWaitingRoomDataStatus
Downloading Status of MobileRTCCustomWaitingRoomData. Here are more detailed structural descriptions.
@ MobileRTCCustomWaitingRoomDataStatus_Init
@ MobileRTCCustomWaitingRoomDataStatus_Download_Fail
@ MobileRTCCustomWaitingRoomDataStatus_Download_OK
@ MobileRTCCustomWaitingRoomDataStatus_Downloading
MobileRTCWaitingRoomLayoutType
WaitingRoom LayoutType. Here are more detailed structural descriptions.
@ MobileRTCWaitingRoomLayoutType_Video
@ MobileRTCWaitingRoomLayoutType_Default
@ MobileRTCWaitingRoomLayoutType_Logo
Meeting host enabled the waiting room feature, then the delegate will receive this notification #only...
The WaitingRoom Customize Data Info. Here are more detailed structural descriptions....
MobileRTCCustomWaitingRoomDataStatus status
MobileRTCWaitingRoomLayoutType type
The information of the current user in the meeting.