Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingDelegate.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7#import <MobileRTC/MobileRTCVideoRawData.h>
8#import <MobileRTC/MobileRTCAudioRawData.h>
9#import <MobileRTC/MobileRTCBORole.h>
10#import <MobileRTC/MobileRTCReturnToMainSessionHandler.h>
11#import <MobileRTC/MobileRTCPreProcessRawData.h>
12#import <MobileRTC/MobileRTCAudioSender.h>
13#import <MobileRTC/MobileRTCVideoSender.h>
14#import <MobileRTC/MobileRTCShareSender.h>
15#import <MobileRTC/MobileRTCVideoCapabilityItem.h>
16#import <MobileRTC/MobileRTCLiveTranscriptionLanguage.h>
17#import <MobileRTC/MobileRTCRawLiveStreamInfo.h>
18#import <MobileRTC/MobileRTCRequestRawLiveStreamPrivilegeHandler.h>
19#import <MobileRTC/MobileRTCShareAudioSender.h>
20#import <MobileRTC/MobileRTCMeetingChat.h>
21#import <MobileRTC/MobileRTCWebinarInputScreenNameHandler.h>
22#import <MobileRTC/MobileRTCArchiveConfrimHandle.h>
23#import <MobileRTC/MobileRTCMeetingChat.h>
24#import <MobileRTC/MobileRTCAppSignalPanelHandler.h>
25#import <MobileRTC/MobileRTCJoinMeetingInfoHandler.h>
26
27
37@class MobileRTCWebinarBODisclaimerHandler;
47
48#pragma mark - MobileRTCMeetingServiceDelegate -
53@protocol MobileRTCMeetingServiceDelegate <NSObject>
54@optional
55
61- (void)onMeetingError:(MobileRTCMeetError)error message:(NSString * _Nullable)message;
62
67- (void)onMeetingStateChange:(MobileRTCMeetingState)state;
68
73- (void)onMeetingParameterNotification:(MobileRTCMeetingParameter *_Nullable)meetingParam;
74
79- (void)onJoinMeetingNeedUserInfo:(MobileRTCInputUserInfoHandler *_Nullable)handler;
80
85
90
95- (void)onJBHWaitingWithCmd:(JBHCmd)cmd;
96
101- (void)onMeetingEndedReason:(MobileRTCMeetingEndReason)reason;
102
108-(void)onMeetingFullToWatchLiveStream:(NSString * _Nonnull)liveStreamUrl;
109
114- (void)onNoHostMeetingWillTerminate:(NSUInteger)minutes;
115
120- (void)onMicrophoneStatusError:(MobileRTCMicrophoneError)error;
121
126- (void)onJoinMeetingInfoRequired:(MobileRTCJoinMeetingInfoHandler *_Nonnull)handler;
127
134- (void)onJoinMeetingInfo:(MobileRTCJoinMeetingInfo)info
135 completion:(void (^_Nonnull)(NSString * _Nonnull displayName, NSString * _Nonnull password, BOOL cancel))completion DEPRECATED_MSG_ATTRIBUTE("Use -onJoinMeetingInfoRequired: instead");
136
141- (void)onMeetingTopicChanged:(NSString *_Nullable)meetingTopic;
142
149- (void)onProxyAuth:(NSString*_Nonnull)host
150 port:(NSUInteger)port
151 completion:(void (^_Nonnull)(NSString * _Nonnull host, NSUInteger port, NSString *_Nonnull username, NSString * _Nonnull password, BOOL cancel))completion;
152
158- (void)onAskToEndOtherMeeting:(void (^_Nonnull)(BOOL cancel))completion;
159
164
169
174- (void)onUpgradeFreeMeetingResult:(NSUInteger)result;
175
181- (void)onFreeMeetingNeedToUpgrade:(FreeMeetingNeedUpgradeType)type giftUpgradeURL:(NSString*_Nullable)giftURL;
182
187
192
197
204- (BOOL)onClickedInviteButton:(UIViewController * _Nonnull)parentVC addInviteActionItem:(NSMutableArray <MobileRTCMeetingInviteActionItem *>* _Nullable)array;
205
211- (BOOL)onClickedAudioButton:(UIViewController * _Nonnull)parentVC;
212
218- (BOOL)onClickedParticipantsButton:(UIViewController * _Nonnull)parentVC;
219
226- (BOOL)onClickedShareButton:(UIViewController * _Nonnull)parentVC addShareActionItem:(NSMutableArray <MobileRTCMeetingShareActionItem *>* _Nonnull)array;
227
234- (BOOL)onClickedEndButton:(UIViewController * _Nonnull)parentVC endButton:(UIButton * _Nonnull)endButton;
235
241
246
252- (void)onClickedDialOut:(UIViewController * _Nonnull)parentVC isCallMe:(BOOL)me;
253
258- (void)onDialOutStatusChanged:(DialOutStatus)status;
259
265- (void)onSendPairingCodeStateChanged:(MobileRTCH323ParingStatus)state MeetingNumber:(unsigned long long)meetingNumber;
266
271- (void)onCallRoomDeviceStateChanged:(H323CallOutStatus)state;
272
277- (void)onChatMessageNotification:(MobileRTCMeetingChat * _Nullable)chatInfo;
278
284- (void)onChatMsgDeleteNotification:(NSString *_Nonnull)msgID deleteBy:(MobileRTCChatMessageDeleteType)deleteBy;
285
290- (void)onChatMessageEditNotification:(MobileRTCMeetingChat *_Nullable)chatInfo;
291
296- (void)onLiveStreamStatusChange:(MobileRTCLiveStreamStatus)liveStreamStatus;
297
302- (void)onRawLiveStreamPrivilegeChanged:(BOOL)hasPrivilege;
303
308
314- (void)onUserRawLiveStreamPrivilegeChanged:(NSUInteger)userId hasPrivilege:(bool)hasPrivilege;
315
320- (void)onRawLiveStreamPrivilegeRequested:(MobileRTCRequestRawLiveStreamPrivilegeHandler*_Nullable)handler;
321
326- (void)onUserRawLiveStreamingStatusChanged:(NSArray<MobileRTCRawLiveStreamInfo *>*_Nullable)liveStreamList;
327
332- (void)onLiveStreamReminderStatusChanged:(BOOL)enable;
333
338
344- (void)onUserThresholdReachedForLiveStream:(NSUInteger)percent;
345
350
356- (void)onClickShareScreen:(UIViewController * _Nonnull)parentVC;
357
364- (void)onClosedCaptionReceived:(NSString * _Nonnull)message speakerId:(NSUInteger)speakerID msgTime:(NSDate *_Nullable)msgTime;
365
369- (void)onWaitingRoomStatusChange:(BOOL)needWaiting;
370
375- (void)onWaitingRoomEntranceEnabled:(BOOL)enabled;
376
382- (void)onSinkAttendeeChatPriviledgeChanged:(MobileRTCMeetingChatPriviledgeType)currentPrivilege;
383
389- (void)onSinkPanelistChatPrivilegeChanged:(MobileRTCPanelistChatPrivilegeType)privilege;
390
398- (void)onSubscribeUserFail:(MobileRTCSubscribeFailReason)errorCode size:(NSInteger)size userId:(NSUInteger)userId;
399
404- (void)onRequestLocalRecordingPrivilegeReceived:(MobileRTCRequestLocalRecordingPrivilegeHandler * _Nullable)handler;
405
410
415- (void)onAllowParticipantsStartVideoNotification:(BOOL)allow;
416
421- (void)onAllowParticipantsRenameNotification:(BOOL)allow;
422
427- (void)onAllowParticipantsUnmuteSelfNotification:(BOOL)allow;
428
433- (void)onAllowParticipantsShareWhiteBoardNotification:(BOOL)allow;
434
439- (void)onAllowParticipantsShareStatusNotification:(BOOL)allow;
444- (void)onMeetingLockStatus:(BOOL)isLock;
445
450- (void)onRequestLocalRecordingPrivilegeChanged:(MobileRTCLocalRecordingRequestPrivilegeStatus)status;
451
456- (void)onParticipantProfilePictureStatusChange:(BOOL)hidden;
457
462- (void)onIndicatorItemReceived:(MobileRTCIndicatorHandler* _Nullable)inMeetingIndicatorHandler;
463
468- (void)onIndicatorItemRemoved:(MobileRTCIndicatorHandler* _Nullable)inMeetingIndicatorHandler;
469
475- (void)onAppSignalPanelUpdated:(MobileRTCAppSignalPanelHandler* _Nullable)handler;
476
477#pragma mark - MobileRTC Recording Delegate -
478
484- (void)onCheckCMRPrivilege:(MobileRTCCMRError)result DEPRECATED_MSG_ATTRIBUTE("Not maintain anymore");
485
490- (void)onRecordingStatus:(MobileRTCRecordingStatus)status;
491
497- (void)onLocalRecordingStatus:(NSInteger)userId status:(MobileRTCRecordingStatus)status;
498
504- (void)onCloudRecordingStorageFull:(long)gracePeriodDate;
505
510- (void)onRequestCloudRecordingResponse:(MobileRTCRequestStartCloudRecordingStatus)status;
511
516- (void)onStartCloudRecordingRequested:(MobileRTCRequestStartCloudRecordingPrivilegeHandler*_Nullable) handler;
517
522- (void)onAllowParticipantsRequestCloudRecording:(BOOL)allow;
523
524#pragma mark - smart summary DEPRECATED -
525
531- (void)onSmartSummaryStatusChange:(BOOL)isStarted
532DEPRECATED_MSG_ATTRIBUTE("Use MobileRTCAICompanionSmartSummaryHelperDelegate instead");
533
540- (void)onSmartSummaryPrivilegeRequested:(NSInteger)userId handler:(MobileRTCSmartSummaryPrivilegeHandler *_Nullable)handler
541DEPRECATED_MSG_ATTRIBUTE("Use MobileRTCAICompanionSmartSummaryHelperDelegate instead");
542
549- (void)onSmartSummaryStartReqResponse:(BOOL)timeout decline:(BOOL)isDecline
550DEPRECATED_MSG_ATTRIBUTE("Use MobileRTCAICompanionSmartSummaryHelperDelegate instead");
551
556- (void)onAICompanionActiveChangeNotice:(BOOL)isActive;
557
558#pragma mark - MobileRTCPollingServiceDelegate -
559
565- (void)onPollingStatusChanged:(NSString*_Nullable)pollingID status:(MobileRTCPollingStatus)status;
566
571- (void)onPollingResultUpdated:(NSString*_Nullable)pollingID;
572
577
586- (void)onPollingActionResult:(MobileRTCPollingActionType)actionType pollingID:(NSString*_Nullable)pollingID bSuccess:(BOOL)bSuccess errorMsg:(NSString*_Nullable)errorMsg;
587
594- (void)onPollingQuestionImageDownloaded:(NSString*_Nullable)questionID path:(NSString*_Nullable)path;
595
602- (void)onPollingElapsedTime:(NSString*_Nullable)pollingID uElapsedtime:(int)uElapsedtime;
603
608- (void)onGetRightAnswerListPrivilege:(BOOL)bCan;
609
618- (void)onVideoAlphaChannelStatusChanged:(BOOL)alphaChannelOn;
619
620#pragma mark - MobileRTCAudioServiceDelegate -
625- (void)onSinkMeetingAudioStatusChange:(NSUInteger)userID;
626
631
636- (void)onSinkMeetingAudioTypeChange:(NSUInteger)userID;
637
642 - (void)onSinkJoin3rdPartyTelephonyAudio:(NSString * _Nullable)audioInfo;
643
648- (void)onMuteOnEntryStatusChange:(BOOL)bEnabled;
649
655- (void)onSinkMeetingAudioStatusChange:(NSUInteger)userID audioStatus:(MobileRTC_AudioStatus)audioStatus;
656
661
666
671
672#pragma mark - MobileRTCVideoServiceDelegate -
677- (void)onSinkMeetingActiveVideo:(NSUInteger)userID;
678
679
684- (void)onSinkMeetingVideoStatusChange:(NSUInteger)userID;
685
690
696- (void)onSinkMeetingVideoStatusChange:(NSUInteger)userID videoStatus:(MobileRTC_VideoStatus)videoStatus;
697
702- (void)onSpotlightVideoChange:(BOOL)on;
703
708- (void)onSpotlightVideoUserChange:(NSArray <NSNumber *>* _Nullable)spotlightedUserList;
709
715
721- (void)onSinkMeetingActiveVideoForDeck:(NSUInteger)userID
722DEPRECATED_MSG_ATTRIBUTE("Use onActiveSpeakerVideoUserChanged: instead");
723
728- (void)onActiveSpeakerVideoUserChanged:(NSUInteger)userID;
729
736- (void)onSinkMeetingVideoQualityChanged:(MobileRTCVideoQuality)qality userID:(NSUInteger)userID
737DEPRECATED_MSG_ATTRIBUTE("Use onUserNetworkStatusChanged:level:userID:uplink: instead");
738
742- (void)onSinkMeetingVideoRequestUnmuteByHost:(MobileRTCSDKError (^_Nonnull)(BOOL Accept))completion;
743
749- (void)onSinkMeetingShowMinimizeMeetingOrBackZoomUI:(MobileRTCMinimizeMeetingState)state;
750
756- (void)onHostVideoOrderUpdated:(NSArray <NSNumber *>* _Nullable)orderArr;
757
762- (void)onLocalVideoOrderUpdated:(NSArray <NSNumber *>* _Nullable)localOrderArr;
763
768- (void)onFollowHostVideoOrderChanged:(BOOL)follow;
769
775- (void)onWhiteboardStatusChanged:(MobileRTCWhiteboardStatus)status;
776
783- (void)onWhiteboardSettingsChanged:(MobileRTCWhiteboardShareOption)shareOption createOption:(MobileRTCWhiteboardCreateOption)createOption enable:(BOOL)enable;
784
785#pragma mark - MobileRTCUserServiceDelegate -
786
791- (void)onMyHandStateChange DEPRECATED_MSG_ATTRIBUTE("Not maintain anymore,Use onSinkMeetingUserRaiseHand or onSinkMeetingUserLowerHand instead");
792
797- (void)onInMeetingUserUpdated DEPRECATED_MSG_ATTRIBUTE("Will delete later, if you need this API, please contact us");
798
802- (void)onInMeetingUserAvatarPathUpdated:(NSInteger)userID;
803
808- (void)onSinkMeetingUserJoin:(NSUInteger)userID;
809
814- (void)onSinkMeetingUserLeft:(NSUInteger)userID;
815
820- (void)onSinkMeetingUserRaiseHand:(NSUInteger)userID;
821
826- (void)onSinkMeetingUserLowerHand:(NSUInteger)userID;
827
832
838- (void)onSinkUserNameChanged:(NSArray <NSNumber *>* _Nullable)userNameChangedArr;
839
844- (void)onMeetingHostChange:(NSUInteger)hostId;
845
851- (void)onMeetingCoHostChange:(NSUInteger)userID isCoHost:(BOOL)isCoHost;
852
856- (void)onClaimHostResult:(MobileRTCClaimHostError)error;
857
858#pragma mark - MobileRTCShareServiceDelegate -
859
864
869
874
875- (void)onSinkSharingStatus:(MobileRTCSSharingSourceInfo*_Nonnull)shareInfo;
876
881- (void)onShareContentChanged:(MobileRTCSSharingSourceInfo*_Nonnull)shareInfo;
882
887- (void)onOptimizingShareForVideoClipStatusChanged:(MobileRTCSSharingSourceInfo* _Nonnull)shareInfo;
888
895- (void)onShareFromMainSession:(NSUInteger)sharingID shareStatus:(MobileRTCSharingStatus)status shareAction:(MobileRTCShareAction *_Nullable)shareAction;
896
901- (void)onSinkShareSettingTypeChanged:(MobileRTCShareSettingType)shareSettingType;
902
903
908- (void)onSinkShareSizeChange:(NSUInteger)userID;
909
910#pragma mark - MobileRTCInterpretationServiceDelegate
911
916
921
926
932- (void)onInterpreterRoleChanged:(NSUInteger)userID isInterpreter:(BOOL)isInterpreter;
933
939- (void)onInterpreterActiveLanguageChanged:(NSInteger)userID activeLanguageId:(NSInteger)activeLanID;
940
946- (void)onInterpreterLanguageChanged:(NSInteger)lanID1 andLanguage2:(NSInteger)lanID2;
947
952- (void)onAvailableLanguageListUpdated:(NSArray <MobileRTCInterpretationLanguage *> *_Nullable)availableLanguageList;
953
958- (void)onInterpreterLanguagesUpdated:(NSArray <MobileRTCInterpretationLanguage *> *_Nullable)availableLanguages;
959
964- (void)onSignInterpretationStatusChange:(MobileRTCSignInterpretationStatus)status;
965
970
975
980
985- (void)onAvailableSignLanguageListUpdated:(NSArray<MobileRTCSignInterpreterLanguage *> *_Nullable)availableSignLanguageList;
986
991
996- (void)onTalkPrivilegeChanged:(BOOL)hasPrivilege;
997
1002- (void)onMeetingQAStatusChanged:(BOOL)isMeetingQAFeatureOn;
1003
1008-(void)onAllowAskQuestionStatus:(BOOL)bEnabled;
1009
1010
1011#pragma mark - MobileRTCWebinarServiceDelegate
1016
1021- (void)onSinkQAConnected:(BOOL)connected;
1022
1027- (void)onSinkQAOpenQuestionChanged:(NSInteger)count;
1028
1034- (void)onSinkQAAddQuestion:(NSString *_Nonnull)questionID success:(BOOL)success;
1035
1041- (void)onSinkQAAddAnswer:(NSString *_Nonnull)answerID success:(BOOL)success;
1042
1047- (void)onSinkQuestionMarkedAsDismissed:(NSString *_Nonnull)questionID;
1048
1053- (void)onSinkReopenQuestion:(NSString *_Nonnull)questionID;
1054
1059- (void)onSinkReceiveQuestion:(NSString *_Nonnull)questionID;
1060
1065- (void)onSinkReceiveAnswer:(NSString *_Nonnull)answerID;
1066
1071- (void)onSinkUserLivingReply:(NSString *_Nonnull)questionID;
1072
1077- (void)onSinkUserEndLiving:(NSString *_Nonnull)questionID;
1078
1084- (void)onSinkVoteupQuestion:(NSString *_Nonnull)questionID orderChanged:(BOOL)orderChanged;
1085
1091- (void)onSinkRevokeVoteupQuestion:(NSString *_Nonnull)questionID orderChanged:(BOOL)orderChanged;
1092
1097- (void)onSinkDeleteQuestion:(NSArray <NSString *>*_Nonnull)questionIDArray;
1098
1103- (void)onSinkDeleteAnswer:(NSArray <NSString *>*_Nonnull)answerIDArray;
1104
1109- (void)onSinkQAAllowAskQuestionAnonymouslyNotification:(BOOL)beAllowed;
1110
1115- (void)onSinkQAAllowAttendeeViewAllQuestionNotification:(BOOL)beAllowed;
1116
1121- (void)onSinkQAAllowAttendeeUpVoteQuestionNotification:(BOOL)beAllowed;
1122
1127- (void)onSinkQAAllowAttendeeAnswerQuestionNotification:(BOOL)beAllowed;
1128
1133- (void)onSinkWebinarNeedRegister:(NSString * _Nonnull)registerURL;
1134
1140- (void)onSinkJoinWebinarNeedUserNameAndEmailWithCompletion:(BOOL (^_Nonnull)(NSString * _Nonnull username, NSString * _Nonnull email, BOOL cancel))completion;
1141
1146
1152- (void)onSinkPromptAttendee2PanelistResult:(MobileRTCWebinarPromoteorDepromoteError)errorCode;
1153
1159- (void)onSinkDePromptPanelist2AttendeeResult:(MobileRTCWebinarPromoteorDepromoteError)errorCode;
1160
1166- (void)onSinkAllowAttendeeChatNotification:(MobileRTCChatAllowAttendeeChat)currentPrivilege;
1167
1173- (void)onSinkAttendeePromoteConfirmResult:(BOOL)agree userId:(NSUInteger)userId;
1174
1179
1184
1189- (void)onAllowWebinarReactionStatusChanged:(BOOL)canReaction;
1190
1195- (void)onAllowAttendeeRaiseHandStatusChanged:(BOOL)canRaiseHand;
1196
1201- (void)onAllowAttendeeViewTheParticipantCountStatusChanged:(BOOL)canViewParticipantCount;
1202
1207- (void)onWebinarNeedInputScreenName:(MobileRTCWebinarInputScreenNameHandler*_Nullable)handler;
1208#pragma mark - MobileRTCLiveTranscriptionServiceDelegate
1213- (void)onStartCaptionsRequestReceived:(MobileRTCCaptionsControlHandler *_Nullable)handler;
1214
1219
1224- (void)onCaptionStatusChanged:(BOOL)enable;
1225
1230- (void)onManualCaptionStatusChanged:(BOOL)bEnabled;
1231
1237- (void)onSinkLiveTranscriptionStatus:(MobileRTCLiveTranscriptionStatus)status;
1238
1243- (void)onLiveTranscriptionMsgInfoReceived:(MobileRTCLiveTranscriptionMessageInfo*_Nullable)messageInfo;
1244
1249- (void)onOriginalLanguageMsgReceived:(MobileRTCLiveTranscriptionMessageInfo*_Nullable)messageInfo;
1250
1256- (void)onLiveTranscriptionMsgError:(MobileRTCLiveTranscriptionLanguage * _Nullable)speakLanguage
1257 transcriptLanguage:(MobileRTCLiveTranscriptionLanguage * _Nullable)transcriptLanguage;
1258
1263- (void)onSpokenLanguageChanged:(MobileRTCLiveTranscriptionLanguage *_Nullable)spokenLanguage;
1264
1270- (void)onSinkRequestForLiveTranscriptReceived:(NSUInteger)requesterUserId bAnonymous:(BOOL)bAnonymous;
1271
1272#pragma mark - MobileRTC3DAvatarDelegate
1277
1282- (void)on3DAvatarItemDataDownloading:(int)index;
1283
1289- (void)on3DAvatarItemDataDownloaded:(bool)success andIndex:(int)index;
1290
1291#pragma mark - MobileRTCBOServiceDelegate
1296- (void)onHasCreatorRightsNotification:(MobileRTCBOCreator *_Nonnull)creator;
1297
1302- (void)onHasAdminRightsNotification:(MobileRTCBOAdmin * _Nonnull)admin;
1303
1308- (void)onHasAssistantRightsNotification:(MobileRTCBOAssistant * _Nonnull)assistant;
1309
1314- (void)onHasAttendeeRightsNotification:(MobileRTCBOAttendee * _Nonnull)attendee;
1315
1320- (void)onHasDataHelperRightsNotification:(MobileRTCBOData * _Nonnull)dataHelper;
1321
1326- (void)onBroadcastBOVoiceStatus:(BOOL)bStart;
1327
1332
1337
1342
1347
1352
1359- (void)onNewBroadcastMessageReceived:(NSString *_Nullable)broadcastMsg senderID:(NSUInteger)senderID senderName:(NSString *_Nullable)senderName;
1360
1366- (void)onBOStopCountDown:(NSUInteger)seconds;
1367
1373- (void)onHostInviteReturnToMainSession:(NSString *_Nullable)hostName replyHandler:(MobileRTCReturnToMainSessionHandler *_Nullable)replyHandler;
1374
1379- (void)onBOStatusChanged:(MobileRTCBOStatus)status;
1380
1386- (void)onBOSwitchRequestReceived:(NSString *_Nullable)newBOName newBOID:(NSString *_Nullable)newBOID;
1387
1388#pragma mark - MobileRTCBODataDelegate
1393- (void)onBOInfoUpdated:(NSString *_Nullable)boId;
1394
1399
1404
1405#pragma mark - MobileRTCBOAdminDelegate
1410- (void)onHelpRequestReceived:(NSString *_Nullable)strUserID;
1411
1416- (void)onStartBOError:(MobileRTCBOControllerError)errType;
1417
1423- (void)onBOEndTimerUpdated:(NSUInteger)remaining isTimesUpNotice:(BOOL)isTimesUpNotice;
1424
1429- (void)onStartBOResponse:(BOOL)success;
1430
1435- (void)onStopBOResponse:(BOOL)success;
1436
1437#pragma mark - MobileRTCBOAttendeeDelegate
1442- (void)onHelpRequestHandleResultReceived:(MobileRTCBOHelpReply)eResult;
1443
1448
1453
1454#pragma mark - MobileRTCBOCreatorDelegate
1460- (void)onBOCreateSuccess:(NSString *_Nullable)BOID DEPRECATED_MSG_ATTRIBUTE("Use onCreateBOResponse:BOID: instead");
1461
1467- (void)onCreateBOResponse:(BOOL)success BOID:(NSString *_Nullable)BOID;
1468
1474- (void)onRemoveBOResponse:(BOOL)success BOID:(NSString *_Nullable)BOID;
1475
1481- (void)onUpdateBONameResponse:(BOOL)success BOID:(NSString *_Nullable)BOID;
1482
1487- (void)onWebPreAssignBODataDownloadStatusChanged:(MobileRTCBOPreAssignBODataStatus)status;
1488
1493- (void)onBOOptionChanged:(MobileRTCBOOption *_Nonnull)newOption;
1494
1495#pragma mark - MobileRTCReactionServiceDelegate -
1502- (void)onEmojiReactionReceived:(NSUInteger)userId reactionType:(MobileRTCEmojiReactionType)type reactionSkinTone:(MobileRTCEmojiReactionSkinTone)skinTone;
1503
1508- (void)onEmojiReactionReceivedInWebinar:(MobileRTCEmojiReactionType)type;
1509
1515- (void)onEmojiFeedbackReceived:(NSUInteger)userId feedbackType:(MobileRTCEmojiFeedbackType)type;
1516
1521- (void)onEmojiFeedbackCanceled:(NSUInteger)userId;
1522
1523#pragma mark - Encryption Delegate -
1528
1529#pragma mark - Focus mode delegate -
1534- (void)onFocusModeStateChanged:(BOOL)on;
1535
1540- (void)onFocusModeShareTypeChanged:(MobileRTCFocusModeShareType)shareType;
1541
1542
1543
1544#pragma mark - ArchiveConfrim -
1545
1550- (void)onUserConfirmToStartArchive:(MobileRTCArchiveConfrimHandle * _Nullable)handler;
1551
1552#pragma mark - Recover meeting -
1557- (void)onUserConfirmRecoverMeeting:(MobileRTCRecoverMeetingHandle * _Nullable)handler;
1558
1559#pragma mark - AICompanion -
1564- (void)onAICompanionFeatureTurnOffByParticipant:(MobileRTCAICompanionTurnOnAgainHandler * _Nullable)handler;
1565
1570- (void)onAICompanionFeatureSwitchRequested:(MobileRTCAICompanionSwitchHandler *_Nullable)handler;
1577- (void)onAICompanionFeatureSwitchRequestResponse:(BOOL)timeout agree:(BOOL)agree turn:(BOOL)turnOn;
1582- (void)onAICompanionFeatureCanNotBeTurnedOff:(NSArray <NSNumber*> *_Nullable)featuresArr;
1588
1589#pragma mark - File Transfer -
1594- (void)onFileSendStart:(MobileRTCFileSender * _Nullable)sender;
1599- (void)onFileReceived:(MobileRTCFileReceiver * _Nullable)receiver;
1604- (void)onFileTransferProgress:(MobileRTCFileTransferInfo * _Nullable)info;
1605
1611- (void)onPSUserStatusChanged:(NSUInteger)userId isStart:(BOOL)isStart;
1612
1613#pragma mark - external camera change -
1619- (void)onUVCCameraStatusChange:(MobileRTCUVCCameraStatus)status;
1620
1621#pragma mark - Name Tag -
1627- (void)onVirtualNameTagStatusChanged:(BOOL)bOn userID:(NSUInteger)userID;
1628
1633- (void)onVirtualNameTagRosterInfoUpdated:(NSUInteger)userID;
1634
1639- (void)onBotAuthorizerRelationChanged:(NSUInteger)userID;
1640
1646- (void)onGrantCoOwnerPrivilegeChanged:(BOOL)canGrantOther;
1647
1648#pragma mark - MobileRTCDoc
1649
1654- (void)onDocsStatusChanged:(MobileRTCDocSharingSourceInfo * _Nullable)sourceInfo;
1660- (void)onDocsPermissionChangedCreateOption:(MobileRTCDocsCreateOption)createOption shareOption:(MobileRTCDocsShareOption)shareOption;
1661
1662#pragma mark - Companion mode -
1668- (void)onCompanionRelationChangedParentUserID:(NSUInteger)parentUserID childUserID:(NSUInteger)childUserID;
1669
1674- (void)onRemoveCompanionRelation:(NSUInteger)childUserID;
1675
1676#pragma mark - meeting Network -
1684- (void)onUserNetworkStatusChanged:(MobileRTCComponentType)type level:(MobileRTCNetworkQuality)level userID:(NSUInteger)userID uplink:(BOOL)uplink;
1685
1686 @end
1687
1688#pragma mark - MobileRTCCustomizedUIMeetingDelegate
1694@protocol MobileRTCCustomizedUIMeetingDelegate <NSObject>
1695@required
1700
1705
1706@end
1707
1708#pragma mark - MobileRTCVideoRawDataDelegate
1709@class MobileRTCRenderer;
1715@protocol MobileRTCVideoRawDataDelegate <NSObject>
1716@optional
1717
1723- (void)onMobileRTCRender:(MobileRTCRenderer *_Nonnull)renderer
1724 framePixelBuffer:(CVPixelBufferRef _Nullable )pixelBuffer
1725 rotation:(MobileRTCVideoRawDataRotation)rotation;
1726
1732- (void)onMobileRTCRender:(MobileRTCRenderer *_Nonnull)renderer
1733 frameRawData:(MobileRTCVideoRawData *_Nonnull)rawData;
1734
1740- (void)onMobileRTCRender:(MobileRTCRenderer *_Nonnull)renderer
1741 rawDataSending:(BOOL)on;
1742
1743@end
1744
1745#pragma mark - MobileRTCAudioRawDataDelegate
1751@protocol MobileRTCAudioRawDataDelegate <NSObject>
1752@optional
1753
1758- (void)onMobileRTCMixedAudioRawData:(MobileRTCAudioRawData *_Nonnull)rawData;
1759
1764- (void)onMobileRTCOneWayAudioAudioRawData:(MobileRTCAudioRawData *_Nonnull)rawData userId:(NSUInteger)userId;
1765
1771- (void)onShareAudioRawDataReceived:(MobileRTCAudioRawData *_Nonnull)rawData userId:(NSUInteger)userId;
1772@end
1773
1774#pragma mark - MobileRTCAudioSourceDelegate
1780@protocol MobileRTCAudioSourceDelegate <NSObject>
1781@optional
1782
1787- (void)onDeviceInitialize:(MobileRTCAudioSender *_Nonnull)rawdataSender;
1800
1801@end
1802
1803#pragma mark - MobileRTCPreProcessorDelegate
1809@protocol MobileRTCPreProcessorDelegate <NSObject>
1810@optional
1811
1816- (void)onPreProcessRawData:(MobileRTCPreProcessRawData *_Nonnull)rawData;
1817
1818@end
1819
1820#pragma mark - MobileRTCVideoSourceDelegate
1826@protocol MobileRTCVideoSourceDelegate <NSObject>
1827@optional
1828
1835- (void)onInitialize:(MobileRTCVideoSender *_Nonnull)rawDataSender supportCapabilityArray:(NSArray <MobileRTCVideoCapabilityItem *>*_Nonnull)supportCapabilityArray suggestCapabilityItem:(MobileRTCVideoCapabilityItem *_Nonnull)suggestCapabilityItem;
1836
1842- (void)onPropertyChange:(NSArray <MobileRTCVideoCapabilityItem *>*_Nonnull)supportCapabilityArray suggestCapabilityItem:(MobileRTCVideoCapabilityItem *_Nonnull)suggestCapabilityItem;
1843
1848
1853
1858
1859@end
1860
1861#pragma mark - MobileRTCShareSourceDelegate
1866@protocol MobileRTCShareSourceDelegate <NSObject>
1867@optional
1868
1873- (void)onStartSend:(MobileRTCShareSender *_Nonnull)sender;
1874
1879
1880@end
1881
1886@protocol MobileRTCShareAudioSourceDelegate <NSObject>
1887@optional
1892- (void)onStartSendAudio:(MobileRTCShareAudioSender *_Nonnull)sender;
1893
1898
1899@end
1900
1901#pragma mark - MobileRTCSMSServiceDelegate
1902
1906
1911@protocol MobileRTCSMSServiceDelegate <NSObject>
1912@optional
1913
1920- (void)onNeedRealNameAuth:(NSArray<MobileRTCRealNameCountryInfo *> * _Nonnull)supportCountryList privacyURL:(NSString * _Nonnull)privacyUrl retrieveHandle:(MobileRTCRetrieveSMSHandler * _Nonnull)handle;
1921
1926- (void)onRetrieveSMSVerificationCodeResultNotification:(MobileRTCSMSRetrieveResult)result verifyHandle:(MobileRTCVerifySMSHandler * _Nonnull)handler;
1927
1932- (void)onVerifySMSVerificationCodeResultNotification:(MobileRTCSMSVerifyResult)result;
1933
1934@end
1935
1936#pragma mark - MobileRTCMeetingSettingsDelegate
1941@protocol MobileRTCMeetingSettingsDelegate <NSObject>
1942@optional
1943
1949- (void)onCustom3DAvatarImageModelDataDownloaded:(BOOL)success imageInfo:(MobileRTC3DAvatarImageInfo * _Nullable)imageInfo;
1950
1955- (void)onCustom3DAvatarDefaultImageModelDataDownloaded:(BOOL)success;
1956
1957@end
1958
MobileRTCMeetError
Enumeration of errors to start/join meeting.
MobileRTCWebinarPromoteorDepromoteError
Enumeration of promoting/demoting attendee and panelist errors in webinar.
MobileRTCMeetingState
Enumeration of the meeting status.
MobileRTCVideoQuality
Enumeration of the video quality.
MobileRTCBOControllerError
Enumeration of the errors related to the Breakout Room (BO) controller operations.
MobileRTCMinimizeMeetingState
Enumeration of the Minimize Meeting states in Zoom UI.
MobileRTCChatMessageDeleteType
Enumeration of the chat message delete type.
MobileRTCDocsCreateOption
Enumeration of the document creation permission options.
MobileRTCChatAllowAttendeeChat
Enumeration of the attendee chat permission in webinar.
MobileRTCMicrophoneError
Enumeration of the audio errors.
MobileRTCPollingStatus
Enumeration of polling statuses.
MobileRTCRecordingStatus
Enumeration of the recording status.
MobileRTCLiveStreamStatus
Enumeration of the live stream status.
MobileRTCMeetingChatPriviledgeType
Enumeration of the meeting chat types in meeting.
MobileRTCVideoRawDataRotation
Enumeration of the directions of video.
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCShareSettingType
Enumeration of the LockShare Status changed.
MobileRTCLocalRecordingRequestPrivilegeStatus
Enumeration of the local recording request privilege settings.
MobileRTCPollingActionType
Enumeration of the polling action types.
MobileRTCCMRError
Enumeration of CMR-related result error states.
MobileRTCBOPreAssignBODataStatus
Enumeration of the pre-assign breakout room data download status.
MobileRTCSMSVerifyResult
Enumeration of the SMS verify result.
FreeMeetingNeedUpgradeType
Enumeration of reasons why a free meeting needs an upgrade.
MobileRTCUVCCameraStatus
Enumeration of the UVC camera types.
DialOutStatus
Enumeration of the phone call status.
MobileRTCSharingStatus
Enumeration of the sharing status.
MobileRTCSignInterpretationStatus
Enumeration of the status of the sign language interpretation.
MobileRTCBOStatus
Enumeration of the Breakout Room (BO) status.
MobileRTCNetworkQuality
Enumeration of the connection quality.
MobileRTCDocsShareOption
Enumeration of the document sharing permission options.
MobileRTCEmojiFeedbackType
Enumeration of emoji feedback types.
MobileRTC_AudioStatus
Enumeration of the audio status.
MobileRTCComponentType
Enumeration of meeting components.
MobileRTCEmojiReactionType
Enumeration of the available emoji reaction types. For more information, please visit https://support...
JBHCmd
Enumeration of the waiting UI when JBH is disabled.
MobileRTCWhiteboardStatus
Enumeration of the whiteboard status.
MobileRTCLiveTranscriptionStatus
Enumeration of the live transcription status.
MobileRTC_VideoStatus
Enumeration of the status of a user's video.
H323CallOutStatus
Enumeration of the H.323/SIP outgoing call status.
MobileRTCWhiteboardShareOption
Enumeration of the whiteboard share options.
MobileRTCRequestStartCloudRecordingStatus
Enumeration of the status of the local recording permission request.
MobileRTCMeetingEndReason
Enumeration of the meeting end reasons.
MobileRTCH323ParingStatus
Enumeration of the H.323/SIP pairing status.
MobileRTCWhiteboardCreateOption
Enumeration of the whiteboard create options.
MobileRTCFocusModeShareType
Enumeration of the focus mode share type. For more information, please visit https://support....
MobileRTCSMSRetrieveResult
Enumeration of the SMS retrieve result.
MobileRTCJoinMeetingInfo
Enumeration of the information needed to Join Meeting.
MobileRTCPanelistChatPrivilegeType
Enumeration of webinar panelist types.
MobileRTCSubscribeFailReason
Enumeration of the type for video subscribe failed reason.
MobileRTCClaimHostError
Enumeration of the CLAIM HOST results in meeting.
MobileRTCEmojiReactionSkinTone
Enumeration of the emoji reactions skin tone.
MobileRTCBOHelpReply
Enumeration of the attendee request for help results.
The handler to handle a user request to turn the AI Companion features on or off.
Handler for app signal panel in meeting.
An interface for users to handle confirmation whether to start archive after joining the meeting.
Represents audio raw data received from the SDK.
Sends external raw audio data to the Zoom meeting.
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 contains breakout room options.
The helper to handle the requested of start captions.
Share source info of Zoom docs.
A class for file receiver.
A class for file sender.
A class that provides information about the status and progress of a file transfer during a Zoom meet...
A handle that represents a meeting indicator item and allows control of its visibility.
Interface for handling user input when joining a meeting.
The information of interpretation language.
Interface for handling user input when joining a meeting requires additional information.
Represents live transcription language information.
Interface representing a live transcription message.
A class that retrieves meeting chat data.
A class for adding custom invitation action items to the meeting.
Provides settings for meetings.
A class for adding custom sharing action items to the meeting.
A class that contains YUV video frame data.
A class that contains raw live stream information, such as the broadcast name and URL.
For real name auth usage.
An interface for host users to handle whether to recover the meeting when starting a deleted or expir...
A class for rendering video raw data.
Process after the host receives the requirement from the user to give the local recording privilege.
A handler that processes after the host receives the requirement from the user to give the raw live s...
Object to handle a user's request to start cloud recording.
A handler for returning to main session from breakout meeting.
Representing a share action, including subscription and rendering controls.
Sends share audio raw data.
Sends share raw data in a meeting.
Represent interpretation language information.
Interface to handle start smart summary request.
A class that contains video capability information.
Represents raw data received from subscribed video stream.
A class that sends video raw data.
A handler for entering screen name when joining a webinar.
void onStartSendData()
The virtual audio source can send raw data with 'rawdataSender'.
void onStopSendData()
The virtual audio source should stop sending raw data.
void onDeviceUninitialize()
Virtual audio source is uninitialized.
void onInitMeetingView()
Notify user to create a custom in-meeting UI.
void onDestroyMeetingView()
Notify user to destroy the custom in-meeting UI.
void onRequestSignInterpreterToTalk()
Callback event of the requirement to unmute sign interpreter's audio from the host.
void onLiveStreamReminderStatusChangedFailed()
Callback event when the live stream reminder enable status change failed.
void onFailedToStartShare()
Notification of failure to start sharing.
void onFreeMeetingUpgradeToGiftFreeTrialStart()
The free meeting was upgraded to a free trial and has started.
void onLostAssistantRightsNotification()
A lost assistant role notification.
void onFreeMeetingUpgradeToGiftFreeTrialStop()
The free meeting which was upgraded to a free trial has stopped.
void onSinkMeetingMyAudioTypeChange()
The audio type of the current user has changed.
void onHostJoinedThisBOMeeting()
The host joins the current breakout meeting.
void onAudioOutputChange()
The current user's audio output selection has changed.
void onLostCreatorRightsNotification()
A lost creator role notification.
void onSinkSelfAllowTalkNotification()
Invoke this function when the attendee is allowed to talk.
void onSinkPanelistCapacityExceed()
Invoke this function once the number of panelists exceeds the upper limit.
void onLostAttendeeRightsNotification()
A lost attendee role notification.
void onMicrophoneNoPrivilege()
Microphone access permission was denied.
void onZoomIdentityExpired()
The ZAK used to authorize the SDK has expired.
void onSinkSelfDisallowTalkNotification()
Invoke this function when the attendee is not allowed to talk.
void onPollingListUpdated()
Polling list updated callback. This is triggered when a host adds, edits, duplicates,...
void onRawLiveStreamPrivilegeRequestTimeout()
The current user's request for raw live streaming privilege has timed out with no response.
void onSignInterpreterListChanged()
Sign interpreter list changed callback. Informs the host that some interpreter left meeting or a pres...
void onStartCaptionsRequestApproved()
Sink the event to start captions was approved.
void onSinkLowerAllHands()
A host or cohost lowers all hands.
void onOngoingShareStopped()
All active shares have stopped.
void onSinkQAConnectStarted()
Indicates when Question and Answer (Q&A) connection starts.
void onInterpreterListChanged()
The meeting's interpreter list changes. When one or more interpreters leave or a preset interpreter j...
void onMyVideoStateChange()
The current user's video status has changed.
void onMeetingReady()
The meeting is ready.
void onHostLeaveThisBOMeeting()
The host leaves the current breakout meeting.
void onSuspendParticipantsActivities()
Callback event when a meeting is suspended.
void onInterpretationStop()
Interpretation stops. Informs the user that interpretation has been stopped. All users in the meeting...
void onSinkMeetingAudioRequestUnmuteByHost()
The host has requested the current user to unmute their microphone.
void on3DAvatarItemThumbnailsDownloaded()
Callback event to notify that all 3D avatar items' thumbnails have been download.
void onSinkMeetingPreviewStopped()
The SDK has stopped the current user's video preview.
void onHostUnsupportedStopNotesRequest()
Sink the event when the host's client does not support handling the stop Notes request.
void onBOListInfoUpdated()
The BO list info updated.
void onInterpretationStart()
Interpretation starts. Informs the user that interpretation has been started. All users in the meetin...
void onMyAudioStateChange()
The current user's audio state has changed.
void onSignInterpreterLanguageChanged()
Indicate when a sign interpreter's languages changed. Only the sign interpreter can get the event.
void onFreeMeetingUpgradedToProMeeting()
The meeting has been upgraded to a pro (licensed) meeting.
void onLostDataHelperRightsNotification()
A lost data helper role notification.
void onInMeetingUserUpdated()
The user state is updated in the meeting.
void onJoinMeetingConfirmed()
The meeting has been joined successfully.
void onE2EEMeetingSecurityCodeChanged()
This callback will be called when the security code changes.
void onSignInterpreterRoleChanged()
Indicate when a user's role changed (participant <-> interpreter). Only that specific user gets the e...
void onLostAdminRightsNotification()
A lost admin role notification.
void onAppShareSplash()
A meeting starts by sharing.
void onCameraNoPrivilege()
Camera access permission was denied.
void onUnAssignedUserUpdated()
The unassigned user update.
BOOL onCheckIfMeetingVoIPCallRunning()
Determines if the meeting VoIP call is running. It affects the picture-in-picture function in ZoomUI ...
void onMyHandStateChange()
The current user's hand state changes.
void onPollingInactive()
Polling inactive callback. When the user starts a meeting in another device by same account,...
void onStopSendAudio()
Callback for audio source to stop sending raw data.
void onStopSend()
Notify to stop send share source.
void onStopSend()
Stop send data.
void onStartSend()
Start send data.
void onUninitialized()
Uninitialize send data.