Meeting SDK for iOS 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 Communications on 2019/3/6.
6// Copyright © Zoom Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10
22
36
41@interface MobileRTCCustomWaitingRoomData : NSObject
42@property (nonatomic, retain) NSString * _Nullable title;
43
44@property (nonatomic, retain) NSString * _Nullable descriptionString;
45
46@property (nonatomic, retain) NSString * _Nullable logoPath;
47
48@property (nonatomic, retain) NSString * _Nullable imagePath;
49
50@property (nonatomic, retain) NSString * _Nullable videoPath;
51
52@property (nonatomic, assign) MobileRTCWaitingRoomLayoutType type;
53
54@property (nonatomic, assign) MobileRTCCustomWaitingRoomDataStatus status;
55
56@end
57
62@protocol MobileRTCWaitingRoomServiceDelegate <NSObject>
63
64@optional
65
70- (void)onWaitingRoomUserJoin:(NSUInteger)userId;
71
76- (void)onWaitingRoomUserLeft:(NSUInteger)userId;
77
82- (void)onWaitingRoomPresetAudioStatusChanged:(BOOL)audioCanTurnOn;
83
88- (void)onWaitingRoomPresetVideoStatusChanged:(BOOL)videoCanTurnOn;
89
94- (void)onCustomWaitingRoomDataUpdated:(MobileRTCCustomWaitingRoomData *_Nullable)data;
95
101- (void)onWaitingRoomUserNameChanged:(NSInteger)userID userName:(nonnull NSString *)userName;
102
103@end
104
109@interface MobileRTCWaitingRoomService : NSObject
110
114@property (weak, nonatomic) id<MobileRTCWaitingRoomServiceDelegate> _Nullable delegate;
115
120-(BOOL)isSupportWaitingRoom;
121
126-(BOOL)isWaitingRoomOnEntryFlagOn;
127
132-(BOOL)isWaitingRoomOnEntryLocked;
133
138- (MobileRTCMeetError)enableWaitingRoomOnEntry:(BOOL)bEnable;
139
144- (nullable NSArray <NSNumber *> *)waitingRoomList;
145
150- (nullable MobileRTCMeetingUserInfo*)waitingRoomUserInfoByID:(NSUInteger)userId;
151
157- (MobileRTCSDKError)admitToMeeting:(NSUInteger)userId;
158
163- (MobileRTCSDKError)admitAllToMeeting;
169- (MobileRTCSDKError)putInWaitingRoom:(NSUInteger)userId;
170
175- (BOOL)isAudioEnabledInWaitingRoom;
176
181- (BOOL)isVideoEnabledInWaitingRoom;
182
189- (MobileRTCSDKError)presetAudioInWaitingRoom:(BOOL)muteAudio;
190
196- (BOOL)isPresetAudioUnmuteInWaitingRoom;
197
204- (MobileRTCSDKError)presetVideoInWaitingRoom:(BOOL)muteVideo;
205
211- (BOOL)isPresetVideoUnmuteInWaitingRoom;
212
217- (MobileRTCSDKError)requestCustomWaitingRoomData;
218
223- (BOOL)canRenameUser;
224
231- (MobileRTCSDKError)renameUser:(NSInteger)userID newUserName:(nonnull NSString * )userName;
232
237- (BOOL)canExpelUser;
238
244- (MobileRTCSDKError)expelUser:(NSInteger)userID;
245
246@end
MobileRTCMeetError
Enumeration of errors to start/join meeting.
MobileRTCSDKError
Enumeration of 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
The information of the current user in the meeting.
Interface for managing the waiting room during a meeting.