Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCWaitingRoomService.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7
19
33
38@interface MobileRTCCustomWaitingRoomData : NSObject
39@property (nonatomic, retain) NSString * _Nullable title;
40
41@property (nonatomic, retain) NSString * _Nullable descriptionString;
42
43@property (nonatomic, retain) NSString * _Nullable logoPath;
44
45@property (nonatomic, retain) NSString * _Nullable imagePath;
46
47@property (nonatomic, retain) NSString * _Nullable videoPath;
48
49@property (nonatomic, assign) MobileRTCWaitingRoomLayoutType type;
50
51@property (nonatomic, assign) MobileRTCCustomWaitingRoomDataStatus status;
52
53@end
54
59@protocol MobileRTCWaitingRoomServiceDelegate <NSObject>
60
61@optional
62
68- (void)onWaitingRoomUserJoin:(NSUInteger)userId;
69
75- (void)onWaitingRoomUserLeft:(NSUInteger)userId;
76
81- (void)onWaitingRoomPresetAudioStatusChanged:(BOOL)audioCanTurnOn;
82
87- (void)onWaitingRoomPresetVideoStatusChanged:(BOOL)videoCanTurnOn;
88
93- (void)onCustomWaitingRoomDataUpdated:(MobileRTCCustomWaitingRoomData *_Nullable)data;
94
100- (void)onWaitingRoomUserNameChanged:(NSInteger)userID userName:(nonnull NSString *)userName;
101
102@end
103
108@interface MobileRTCWaitingRoomService : NSObject
109
113@property (weak, nonatomic) id<MobileRTCWaitingRoomServiceDelegate> _Nullable delegate;
114
119-(BOOL)isSupportWaitingRoom;
120
125-(BOOL)isWaitingRoomOnEntryFlagOn;
126
131-(BOOL)isWaitingRoomOnEntryLocked;
132
138- (MobileRTCMeetError)enableWaitingRoomOnEntry:(BOOL)bEnable;
139
144- (nullable NSArray <NSNumber *> *)waitingRoomList;
145
151- (nullable MobileRTCMeetingUserInfo*)waitingRoomUserInfoByID:(NSUInteger)userId;
152
159- (MobileRTCSDKError)admitToMeeting:(NSUInteger)userId;
160
165- (MobileRTCSDKError)admitAllToMeeting;
172- (MobileRTCSDKError)putInWaitingRoom:(NSUInteger)userId;
173
178- (BOOL)isAudioEnabledInWaitingRoom;
179
184- (BOOL)isVideoEnabledInWaitingRoom;
185
192- (MobileRTCSDKError)presetAudioInWaitingRoom:(BOOL)muteAudio;
193
199- (BOOL)isPresetAudioUnmuteInWaitingRoom;
200
207- (MobileRTCSDKError)presetVideoInWaitingRoom:(BOOL)muteVideo;
208
214- (BOOL)isPresetVideoUnmuteInWaitingRoom;
215
220- (MobileRTCSDKError)requestCustomWaitingRoomData;
221
226- (BOOL)canRenameUser;
227
234- (MobileRTCSDKError)renameUser:(NSInteger)userID newUserName:(nonnull NSString * )userName;
235
240- (BOOL)canExpelUser;
241
247- (MobileRTCSDKError)expelUser:(NSInteger)userID;
248
249@end
MobileRTCMeetError
Enumeration of errors to start/join meeting.
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCCustomWaitingRoomDataStatus
Enumeration for the status of custom waiting room data.
@ MobileRTCCustomWaitingRoomDataStatus_Init
@ MobileRTCCustomWaitingRoomDataStatus_Download_Fail
@ MobileRTCCustomWaitingRoomDataStatus_Download_OK
@ MobileRTCCustomWaitingRoomDataStatus_Downloading
MobileRTCWaitingRoomLayoutType
Enumeration of waiting room layout type. For more information, please visit https://support....
@ MobileRTCWaitingRoomLayoutType_Video
@ MobileRTCWaitingRoomLayoutType_Default
@ MobileRTCWaitingRoomLayoutType_Logo
The WaitingRoom Customize Data Info.
MobileRTCCustomWaitingRoomDataStatus status
MobileRTCWaitingRoomLayoutType type
A class that contains information of the current user in the meeting.
Interface for managing the waiting room during a meeting.