Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCBORole.h
Go to the documentation of this file.
6#import <Foundation/Foundation.h>
7
21
26@interface MobileRTCBOUser : NSObject
27
32- (NSString * _Nullable)getUserId;
33
38- (NSString * _Nullable)getUserName;
39
40@end
41
46@interface MobileRTCBOMeeting : NSObject
47
52- (NSString * _Nullable)getBOMeetingId;
53
58- (NSString * _Nullable)getBOMeetingName;
59
64- (NSArray <NSString *>* _Nullable)getBOMeetingUserList;
65
71-(MobileRTCBOUserStatus)getBOUserStatusWithUserID:(NSString *_Nonnull)userID;
72@end
73
91
96@interface MobileRTCBOOption : NSObject
97
101@property (nonatomic, assign) MobileRTCBOStopCountDown countdownSeconds;
102
106@property (nonatomic, assign) BOOL isParticipantCanChooseBO;
107
111@property (nonatomic, assign) BOOL isParticipantCanReturnToMainSessionAtAnyTime;
112
116@property (nonatomic, assign) BOOL isAutoMoveAllAssignedParticipantsEnabled;
117
121@property (nonatomic, assign) BOOL isBOTimerEnabled;
122
126@property (nonatomic, assign) BOOL isTimerAutoStopBOEnabled;
127
132@property (nonatomic, assign) NSInteger timerDurationMinutes;
133
134// WebinarBo
138@property(nonatomic,assign) BOOL isAttendeeContained;
139
143@property(nonatomic,assign) BOOL isPanelistCanChooseBO;
144
148@property(nonatomic,assign) BOOL isAttendeeCanChooseBO;
149
153@property(nonatomic,assign) BOOL isUserConfigMaxRoomUserLimitsEnabled;
154
158@property(nonatomic,assign)unsigned int nUserConfigMaxRoomUserLimits;
159
160@end
161
217@interface MobileRTCBOCreator : NSObject
218
225- (NSString * _Nullable)createBO:(NSString * _Nonnull)boName DEPRECATED_MSG_ATTRIBUTE("Use createBreakoutRoom: instead");
226
235- (BOOL)createBreakoutRoom:(NSString * _Nonnull)boName;
236
242- (BOOL)createGroupBO:(NSArray<NSString*> * _Nonnull)boNameList;
243
250- (BOOL)createWebinarBO:(NSArray<NSString*> * _Nonnull)boNameList DEPRECATED_MSG_ATTRIBUTE("Use createBreakoutRoom: instead");
251
258- (BOOL)updateBO:(NSString * _Nonnull)boId name:(NSString * _Nonnull)boName;
259
265- (BOOL)removeBO:(NSString * _Nonnull)boId;
266
273- (BOOL)assignUser:(NSString * _Nonnull)boUserId toBO:(NSString * _Nonnull)boId;
274
281- (BOOL)removeUser:(NSString * _Nonnull)boUserId fromBO:(NSString * _Nonnull)boId;
282
288- (BOOL)setBOOption:(MobileRTCBOOption *_Nonnull)option;
289
294- (MobileRTCBOOption * _Nullable)getBOOption;
295
300- (BOOL)isWebPreAssignBOEnabled;
301
306- (MobileRTCSDKError)requestAndUseWebPreAssignBOList;
307
312- (MobileRTCBOPreAssignBODataStatus)getWebPreAssignBODataStatus;
313
314@end
315
320@interface MobileRTCBOAdmin : NSObject
321
326- (BOOL)startBO;
327
332- (BOOL)stopBO;
333
340- (BOOL)assignNewUser:(NSString * _Nonnull)boUserId toRunningBO:(NSString * _Nonnull)boId;
341
348- (BOOL)switchUser:(NSString * _Nonnull)boUserId toRunningBO:(NSString * _Nonnull)boId;
349
354- (BOOL)canStartBO;
355
361- (BOOL)joinBOByUserRequest:(NSString * _Nonnull)boUserId;
362
368- (BOOL)ignoreUserHelpRequest:(NSString * _Nonnull)boUserId;
369
375- (BOOL)broadcastMessage:(NSString * _Nonnull)strMsg;
376
382- (BOOL)inviteBOUserReturnToMainSession:(NSString * _Nonnull)boUserId;
383
388- (BOOL)isBroadcastVoiceToBOSupport;
389
394- (BOOL)canBroadcastVoiceToBO;
395
401- (BOOL)broadcastVoiceToBO:(BOOL)bStart;
402@end
403
408@interface MobileRTCBOAssistant : NSObject
409
415- (BOOL)joinBO:(NSString * _Nonnull)boId;
416
421- (BOOL)leaveBO;
422
423@end
424
429@interface MobileRTCBOAttendee : NSObject
430
435- (BOOL)joinBO;
436
441- (BOOL)leaveBO;
442
447- (NSString * _Nullable)getBOName;
448
453- (BOOL)requestForHelp;
454
459- (BOOL)isHostInThisBO;
460
465- (BOOL)isCanReturnMainSession;
466
467@end
468
473@interface MobileRTCBOData : NSObject
474
479- (NSArray * _Nullable)getUnassignedUserList;
480
485- (NSArray * _Nullable)getBOMeetingIDList;
486
492- (MobileRTCBOUser * _Nullable)getBOUserByUserID:(NSString * _Nonnull)userId;
493
499- (MobileRTCBOMeeting * _Nullable)getBOMeetingByID:(NSString * _Nonnull)boId;
500
505- (NSString * _Nullable)getCurrentBOName;
506
512- (BOOL)isBOUserMyself:(NSString *_Nonnull)boUserId;
513
514@end
515
MobileRTCBOStopCountDown
Enumeration of Breakout Room (BO) stop countdown durations.
@ MobileRTCBOStopCountDown_Not_CountDown
@ MobileRTCBOStopCountDown_Seconds_15
@ MobileRTCBOStopCountDown_Seconds_120
@ MobileRTCBOStopCountDown_Seconds_30
@ MobileRTCBOStopCountDown_Seconds_10
@ MobileRTCBOStopCountDown_Seconds_60
MobileRTCBOUserStatus
Enumeration of breakout meeting user status.
@ BOUserStatusNotJoin
@ BOUserStatusUnknown
@ BOUserStatusInBO
@ BOUserStatusUnassigned
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCBOPreAssignBODataStatus
Enumeration of the pre-assign breakout room data download status.
A class for managing breakout rooms.
A class that manages operations for joining and leaving breakout meetings as an assistant.
A class that manages operations for attendees in breakout meetings.
A class for creating and managing breakout rooms.
A class that provides data helper functions for breakout meetings.
A class that provides functions for breakout meetings.
NSString *_Nullable getBOMeetingName()
Gets the breakout meeting name.
NSString *_Nullable getBOMeetingId()
Gets the breakout meeting ID.
NSArray< NSString * > *_Nullable getBOMeetingUserList()
Gets the breakout meeting user array.
A class that contains breakout room options.
BOOL isParticipantCanReturnToMainSessionAtAnyTime
Enables or disables that participant can return to main session at any time.
BOOL isAttendeeCanChooseBO
Enables or disables that attendee can choose breakout room. Invalid when attendee is not contained.
BOOL isAttendeeContained
Enables or disables webinar attendee join webinar breakout room. When it changes, the breakout room d...
unsigned int nUserConfigMaxRoomUserLimits
The number of max room user limits in breakout room. The default is 20.
BOOL isTimerAutoStopBOEnabled
Indicates whether to auto stop breakout room when time is up. YES if auto stop is enabled,...
MobileRTCBOStopCountDown countdownSeconds
The breakout room countdown seconds.
BOOL isParticipantCanChooseBO
Enables or disables that participant can choose breakout room.
BOOL isUserConfigMaxRoomUserLimitsEnabled
Enables or disables that max room user limits in breakout room.
BOOL isBOTimerEnabled
Indicates whether it's a timer breakout room. YES if it's a timer breakout room, NO otherwise.
NSInteger timerDurationMinutes
The minutes of breakout room timer duration.
BOOL isPanelistCanChooseBO
Enables or disables that panelist can choose breakout room.
BOOL isAutoMoveAllAssignedParticipantsEnabled
Enables or disables that auto move all assigned participants to breakout room.
A class that represents a user in a breakout room.
NSString *_Nullable getUserName()
Gets the breakout meeting user name.
NSString *_Nullable getUserId()
Gets the breakout meeting user ID.