Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCWaitingRoomService.h
Go to the documentation of this file.
1
5
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
120
126
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
172- (MobileRTCSDKError)putInWaitingRoom:(NSUInteger)userId;
173
179
185
192- (MobileRTCSDKError)presetAudioInWaitingRoom:(BOOL)muteAudio;
193
200
207- (MobileRTCSDKError)presetVideoInWaitingRoom:(BOOL)muteVideo;
208
215
221
227
234- (MobileRTCSDKError)renameUser:(NSInteger)userID newUserName:(nonnull NSString * )userName;
235
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.
BOOL isVideoEnabledInWaitingRoom()
Determines if the attendee is enabled to turn on video when joining the meeting.
nullable NSArray< NSNumber * > * waitingRoomList()
Gets the waiting room user ID list.
MobileRTCSDKError requestCustomWaitingRoomData()
Gets the WaitingRoom CustomizeData information in the waiting room.
BOOL isSupportWaitingRoom()
Determines if this meeting supports Waiting Room feature.
BOOL canExpelUser()
Determines if host or co-host is enabled to expel user in the waiting room.
BOOL isPresetAudioUnmuteInWaitingRoom()
Gets the audio pre-set mute or unmute status in the waiting room.
BOOL isPresetVideoUnmuteInWaitingRoom()
Gets the video pre-set mute or unmute status in the waiting room.
id< MobileRTCWaitingRoomServiceDelegate > _Nullable delegate
Waiting Room service delegate.
BOOL isWaitingRoomOnEntryLocked()
Queries if enableWaitingRoomOnEntry feature is locked.
BOOL isWaitingRoomOnEntryFlagOn()
Determines if this meeting has Waiting Room feature enabled.
BOOL isAudioEnabledInWaitingRoom()
Determines if the attendee is enabled to turn on audio when joining the meeting.
MobileRTCSDKError admitAllToMeeting()
Permits all of the users currently in the waiting room to join the meeting.
BOOL canRenameUser()
Determines if host or co-host is enabled to rename user in the waiting room.