Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
<MobileRTCBOAdminDelegate> Protocol Reference

#import <MobileRTCMeetingDelegate.h>

Inherits <MobileRTCMeetingServiceDelegate>.

Instance Methods

(void) - onHelpRequestReceived:
 Admin receives help request from userID.
 
(void) - onStartBOError:
 Admin receives an error when breakout room start fails.
 
(void) - onBOEndTimerUpdated:isTimesUpNotice:
 In a timed breakout, after starting a breakout room, you receive the event.
 
- Instance Methods inherited from <MobileRTCMeetingServiceDelegate>
(void) - onMeetingError:message:
 An error has occurred.
 
(void) - onMeetingStateChange:
 Notify the user that the meeting state has changed.
 
(void) - onMeetingParameterNotification:
 The meeting parameters have been updated.
 
(void) - onJoinMeetingConfirmed
 The meeting has been joined successfully.
 
(void) - onMeetingReady
 The meeting is ready.
 
(void) - onJBHWaitingWithCmd:
 Join a meeting without a host. You can show or hide the custom JBH waiting UI.
 
(void) - onCheckCMRPrivilege:
 Determine if the current user has cloud recording privileges.
 
(void) - onRecordingStatus:
 The cloud recording status has changed.
 
(void) - onLocalRecordingStatus:status:
 The local recording status has changed.
 
(void) - onMeetingEndedReason:
 The meeting has ended.
 
(void) - onNoHostMeetingWillTerminate:
 The meeting does not have a host and ends.
 
(void) - onMicrophoneStatusError:
 The user's microphone has encountered an error.
 
(void) - onJoinMeetingInfo:completion:
 The user must provide additional information before joining the meeting.
 
(void) - onProxyAuth:port:completion:
 The user must provide proxy information.
 
(void) - onAskToEndOtherMeeting:
 The user needs to end another ongoing meeting.
 
(void) - onMicrophoneNoPrivilege
 Microphone access permission was denied.
 
(void) - onCameraNoPrivilege
 Camera access permission was denied.
 
(void) - onUpgradeFreeMeetingResult:
 The result of a free meeting upgrade attempt has been received.
 
(void) - onFreeMeetingNeedToUpgrade:giftUpgradeURL:
 The free meeting needs an upgrade.
 
(void) - onFreeMeetingUpgradeToGiftFreeTrialStart
 The free meeting was upgraded to a free trial and has started.
 
(void) - onFreeMeetingUpgradeToGiftFreeTrialStop
 The free meeting which was upgraded to a free trial has stopped.
 
(void) - onFreeMeetingUpgradedToProMeeting
 The meeting has been upgraded to a pro (licensed) meeting.
 
(BOOL) - onClickedInviteButton:addInviteActionItem:
 The invite button in the UI has been clicked.
 
(BOOL) - onClickedAudioButton:
 The audio button in the UI has been clicked.
 
(BOOL) - onClickedParticipantsButton:
 The participants button has been clicked.
 
(BOOL) - onClickedShareButton:addShareActionItem:
 The share button has been clicked.
 
(BOOL) - onClickedEndButton:endButton:
 The meeting end button has been clicked.
 
(BOOL) - onCheckIfMeetingVoIPCallRunning
 Check if the meeting VoIP call is running. It affects the picture-in-picture function in ZoomUI if videoCallPictureInPictureEnabled returns YES of MobileRTCMeetingSettings.
 
(void) - onOngoingShareStopped
 All active shares have stopped.
 
(void) - onClickedDialOut:isCallMe:
 The dial out button has been clicked.
 
(void) - onDialOutStatusChanged:
 The status of an outgoing call has changed.
 
(void) - onSendPairingCodeStateChanged:MeetingNumber:
 The H.323 pairing code status has been updated and may require the end user to input their code.
 
(void) - onCallRoomDeviceStateChanged:
 The room device state changed.
 
(void) - onInMeetingChat:
 An in-meeting chat message has been received.
 
(void) - onChatMessageNotification:
 An in-meeting chat message has been received.
 
(void) - onChatMsgDeleteNotification:deleteBy:
 A chat message has been deleted.
 
(void) - onLiveStreamStatusChange:
 The live stream status has changed.
 
(void) - onRawLiveStreamPrivilegeChanged:
 The current user’s raw live streaming privilege has changed.
 
(void) - onRawLiveStreamPrivilegeRequestTimeout
 The current user's request for raw live streaming privilege has timed out with no response.
 
(void) - onUserRawLiveStreamPrivilegeChanged:hasPrivilege:
 Another user’s raw live streaming privilege has changed.
 
(void) - onRawLiveStreamPrivilegeRequested:
 A user has requested raw live streaming privilege.
 
(void) - onUserRawLiveStreamingStatusChanged:
 A user has starte or stopped raw live streaming.
 
(void) - onZoomIdentityExpired
 The ZAK used to authorize the SDK has expired.
 
(void) - onClickShareScreen:
 The user has clicked the shared screen.
 
(void) - onClosedCaptionReceived:speakerId:msgTime:
 A closed caption message has been received. If the meeting supports multi-language transcription and the host set manual captioning to true, attendees must set translation language id to -1 to receive closed caption messages.
 
(void) - onWaitingRoomStatusChange:
 The waiting room status has changed.
 
(void) - onWaitingRoomEntranceEnabled:
 This callback event will be triggered when host or cohost enables or disables waiting room entrance.
 
(void) - onSinkAttendeeChatPriviledgeChanged:
 The chat privilege of attendees has changed.
 
(void) - onSinkPanelistChatPrivilegeChanged:
 The chat privilege of panelists has changed.
 
(void) - onSubscribeUserFail:size:userId:
 The subscription to a user's video has failed.
 
(void) - onRequestLocalRecordingPrivilegeReceived:
 Callback when host received the local recording request from participant.
 
(void) - onSuspendParticipantsActivities
 
(void) - onAllowParticipantsStartVideoNotification:
 
(void) - onAllowParticipantsRenameNotification:
 
(void) - onAllowParticipantsUnmuteSelfNotification:
 
(void) - onAllowParticipantsShareWhiteBoardNotification:
 
(void) - onAllowParticipantsShareStatusNotification:
 
(void) - onMeetingLockStatus:
 
(void) - onRequestLocalRecordingPrivilegeChanged:
 Callback event that the request local recording privilege changes.
 
(void) - onParticipantProfilePictureStatusChange:
 Sink the event that participant profile status change.
 
(void) - onSmartSummaryStatusChange:
 Callback event when smart summary status changes.
 
(void) - onSmartSummaryPrivilegeRequested:handler:
 Callback event when a user requests the host to start smart summary.
 
(void) - onSmartSummaryStartReqResponse:decline:
 Callback event when the host handle the smart summary request.
 
(void) - onAICompanionActiveChangeNotice:
 Sink the event that AI Companion active status changed.
 

Detailed Description

Definition at line 1480 of file MobileRTCMeetingDelegate.h.

Method Documentation

◆ onBOEndTimerUpdated:isTimesUpNotice:

- (void) onBOEndTimerUpdated: (NSUInteger)  remaining
isTimesUpNotice: (BOOL)  isTimesUpNotice 
optional

In a timed breakout, after starting a breakout room, you receive the event.

Parameters
remainingRemaining time.
isTimesUpNoticetrue: when time is up, auto stop breakout room. false: don't auto stop breakout room.

◆ onHelpRequestReceived:

- (void) onHelpRequestReceived: (NSString *_Nullable)  strUserID
optional

Admin receives help request from userID.

Parameters
strUserIDThe identifier of the breakout room meeting user.

◆ onStartBOError:

- (void) onStartBOError: (MobileRTCBOControllerError errType
optional

Admin receives an error when breakout room start fails.

Parameters
errTypeThe error type defail of the failure.