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

Delegate containing callbacks related to meeting state updates. More...

#import <MobileRTCMeetingDelegate.h>

Inherits <NSObject>.

Instance Methods

(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) - 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) - 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) - 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) - onCloudRecordingStorageFull:
 An event sink that the cloud recording storage is full.
 
(void) - onRequestCloudRecordingResponse:
 Callback event for when the host responds to a cloud recording permission request.
 
(void) - onStartCloudRecordingRequested:
 Callback event received only by the host when a user requests to start cloud recording.
 
(void) - onAllowParticipantsRequestCloudRecording:
 Callback event that lets participants request hots to start cloud recording.
 
(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.
 
(void) - onPollingStatusChanged:status:
 Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped.
 
(void) - onPollingResultUpdated:
 Polling result updated callback. When a participant submits polling.
 
(void) - onPollingListUpdated
 Polling list updated callback. This is triggered when a host adds, edits, duplicates, or deletes a poll.
 
(void) - onPollingActionResult:pollingID:bSuccess:errorMsg:
 Polling action result callback. This is triggered when a user perform an action for a poll.
 
(void) - onPollingQuestionImageDownloaded:path:
 Polling question item image downloaded callback.
 
(void) - onPollingElapsedTime:uElapsedtime:
 Polling elapsed time callback.
 
(void) - onGetRightAnswerListPrivilege:
 Callback event for the user get right answer list privilege changed. This is triggered when the host calls EnableGetRightAnswerList in a quiz.
 
(void) - onPollingInactive
 polling inactive callback. When the user starts a meeting in another device by same account, this callback is triggered. Then call CanDoPolling return false.
 
(void) - onVideoAlphaChannelStatusChanged:
 Callback event of alpha channel mode changes.
 
(void) - onSinkMeetingAudioStatusChange:
 A user's audio status has changed. To get their updated status, check [MobileRTCMeetingUserInfo.audioStatus] for the associated user.
 
(void) - onSinkMeetingMyAudioTypeChange
 The audio type of the current user has changed.
 
(void) - onSinkMeetingAudioTypeChange:
 A user's audio type has changed. To get their updated type, check MobileRTCMeetingUserInfo.audioStatus for the associated user.
 
(void) - onSinkJoin3rdPartyTelephonyAudio:
 Callback event that requests to join third party telephony audio.
 
(void) - onSinkMeetingAudioStatusChange:audioStatus:
 A user's audio status has changed.
 
(void) - onAudioOutputChange
 The current user's audio output selection has changed.
 
(void) - onMyAudioStateChange
 The current user's audio state has changed.
 
(void) - onSinkMeetingAudioRequestUnmuteByHost
 The host has requested the current user to unmute their microphone.
 
(void) - onSinkMeetingActiveVideo:
 The user being displayed in the active video view has changed.
 
(void) - onSinkMeetingVideoStatusChange:
 A participant's video status has changed. To get their updated status, check MobileRTCMeetingUserInfo.videoStatus for the associated user. Valid for both normal user and webinar attendee.
 
(void) - onMyVideoStateChange
 The current user's video status has changed.
 
(void) - onSinkMeetingVideoStatusChange:videoStatus:
 A participant's video status has changed.
 
(void) - onSpotlightVideoChange:
 The video status of a spotlit user has changed.
 
(void) - onSpotlightVideoUserChange:
 The list of spotlit users has changed.
 
(void) - onSinkMeetingPreviewStopped
 The SDK has stopped the current user's video preview.
 
(void) - onSinkMeetingActiveVideoForDeck:
 The active video user has changed.
 
(void) - onSinkMeetingVideoQualityChanged:userID:
 The video quality of a user has changed.
 
(void) - onSinkMeetingVideoRequestUnmuteByHost:
 The host has requested the current user to unmute their video.
 
(void) - onSinkMeetingShowMinimizeMeetingOrBackZoomUI:
 The meeting UI has been minimized or returned to fullscreen.
 
(void) - onHostVideoOrderUpdated:
 The order of users' videos in gallery view has been changed by the host.
 
(void) - onLocalVideoOrderUpdated:
 The order of users' videos in gallery view has been changed locally.
 
(void) - onFollowHostVideoOrderChanged:
 The host has enabled/disabled the "Follow Host's Video Order" setting.
 
(void) - onWhiteboardStatusChanged:
 Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been started or stopped, and all users in the meeting can get the event.
 
(void) - onWhiteboardSettingsChanged:createOption:enable:
 Callback event of whiteboard setting type changed.
 
(void) - onMyHandStateChange
 The current user's hand state changes.
 
(void) - onInMeetingUserUpdated
 The user state is updated in the meeting.
 
(void) - onInMeetingUserAvatarPathUpdated:
 The user avatar path is updated in the meeting.
 
(void) - onSinkMeetingUserJoin:
 Callback event of notification of users who are in the meeting.
 
(void) - onSinkMeetingUserLeft:
 Callback event of notification of user who leaves the meeting.
 
(void) - onSinkMeetingUserRaiseHand:
 A user raises their hand.
 
(void) - onSinkMeetingUserLowerHand:
 A user lowers their hand.
 
(void) - onSinkLowerAllHands
 A host or cohost lowers all hands.
 
(void) - onSinkUserNameChanged:
 A user changes their screen name.
 
(void) - onMeetingHostChange:
 The meeting host changes.
 
(void) - onMeetingCoHostChange:isCoHost:
 The meeting co-host changes.
 
(void) - onClaimHostResult:
 A user claims the host.
 
(void) - onAppShareSplash
 A meeting starts by sharing.
 
(void) - onSinkSharingStatus:userID:
 The share status changes.
 
(void) - onSinkShareSettingTypeChanged:
 The sharing settings change.
 
(void) - onSinkShareSizeChange:
 The presenter resizes the sharing content.
 
(void) - onInterpretationStart
 Interpretation starts. Informs the user that interpretation has been started. All users in the meeting get the event.
 
(void) - onInterpretationStop
 Interpretation stops. Informs the user that interpretation has been stopped. All users in the meeting get the event.
 
(void) - onInterpreterListChanged
 The meeting's interpreter list changes. When one or more interpreters leave or a preset interpreter joins. Only the host gets the event.
 
(void) - onInterpreterRoleChanged:isInterpreter:
 Interpreter role changes. When a user's role changed (participant <-> interpreter), all users in meeting get the event.
 
(void) - onInterpreterActiveLanguageChanged:activeLanguageId:
 interpreter active language changed callback. When a interpreter's active language changes, all users in meeting get the event.
 
(void) - onInterpreterLanguageChanged:andLanguage2:
 interpreter languages changed callback. When a interpreter's languages changed, only the interpreter can get the event.
 
(void) - onAvailableLanguageListUpdated:
 available languages changed callback. When available languages in meeting are changed, all non-interpreter users in a meeting get the event.
 
(void) - onInterpreterLanguagesUpdated:
 Indicates a change in the list of available languages that interpreters can hear. When the list of available languages that interpreters can hear in a meeting changes, all interpreters in the meeting get this event.
 
(void) - onSignInterpretationStatusChange:
 Sign interpretation staus change callback. Informs the user that sign interpretation has been started or stopped. All users in meeting can get the event.
 
(void) - onSignInterpreterListChanged
 Sign interpreter list changed callback. Informs the host that some interpreter left meeting or a preset interpreter joined meeting, or host add or remove interpreter. Only the host can get the event.
 
(void) - onSignInterpreterRoleChanged
 Indicate when a user's role changed (participant <-> interpreter). Only that specific user gets the event.
 
(void) - onSignInterpreterLanguageChanged
 Indicate when a sign interpreter's languages changed. Only the sign interpreter can get the event.
 
(void) - onAvailableSignLanguageListUpdated:
 Indicate when available sign languages in a meeting change. All users in the meeting can get the event.
 
(void) - onRequestSignInterpreterToTalk
 Callback event of the requirement to unmute sign interpreter's audio from the host.
 
(void) - onTalkPrivilegeChanged:
 Callback event for the user talk privilege changed. When the interpreter role changed, host changed, host allow or disallow interpreter talk, this will be triggered, and only the sign interpreter itself can get the event.
 
(void) - onMeetingQAStatusChanged:
 Callback event of meeting QA feature status changes.
 
(void) - onAllowAskQuestionStatus:
 Notify host/cohost has changed the status of ask question.
 
(void) - onSinkQAConnectStarted
 Indicates when Question and Answer (Q&A) connection starts.
 
(void) - onSinkQAConnected:
 Callback event when Q&A is connected or disconnected.
 
(void) - onSinkQAOpenQuestionChanged:
 Callback event when the open-ended question changes.
 
(void) - onSinkQAAddQuestion:success:
 Callback event when adding a new question.
 
(void) - onSinkQAAddAnswer:success:
 Callback event when adding a new answer.
 
(void) - onSinkQuestionMarkedAsDismissed:
 Callback event when a new question is marked as dismissed.
 
(void) - onSinkReopenQuestion:
 Callback event when a question is opened.
 
(void) - onSinkReceiveQuestion:
 Callback event when a new question is received.
 
(void) - onSinkReceiveAnswer:
 Callback event when a new answer is received.
 
(void) - onSinkUserLivingReply:
 Callback event when the question is replied to live.
 
(void) - onSinkUserEndLiving:
 Callback event when the question live reply ends.
 
(void) - onSinkVoteupQuestion:orderChanged:
 Callback event when the question is upvoted.
 
(void) - onSinkRevokeVoteupQuestion:orderChanged:
 Callback event when the question upvote is revoked.
 
(void) - onSinkDeleteQuestion:
 Callback event when a question is deleted.
 
(void) - onSinkDeleteAnswer:
 Callback event when an answer is deleted.
 
(void) - onSinkQAAllowAskQuestionAnonymouslyNotification:
 Callback event of the permission change to allow users to ask questions anonymously.
 
(void) - onSinkQAAllowAttendeeViewAllQuestionNotification:
 Callback event of the permission change that allows the attendee to view all questions.
 
(void) - onSinkQAAllowAttendeeUpVoteQuestionNotification:
 Callback event of the permission change that allows the attendee to submit questions.
 
(void) - onSinkQAAllowAttendeeAnswerQuestionNotification:
 Callback event of the permission change that allows the user to answer questions.
 
(void) - onSinkWebinarNeedRegister:
 Callback event that a user joins a webinar which requires manual approval.
 
(void) - onSinkJoinWebinarNeedUserNameAndEmailWithCompletion:
 Callback event that a user joins a webinar which requires username and email.
 
(void) - onSinkPanelistCapacityExceed
 Invoke this function once the number of panelists exceeds the upper limit.
 
(void) - onSinkPromptAttendee2PanelistResult:
 Invoke this function once a given number of attendees are promoted successfully from attendee to panelist.
 
(void) - onSinkDePromptPanelist2AttendeeResult:
 Invoke this function when panelist is demoted successfully from panelist to attendee.
 
(void) - onSinkAllowAttendeeChatNotification:
 Invoke this function when the chat privilege of attendees changes.
 
(void) - onSinkAttendeePromoteConfirmResult:userId:
 When attendee agrees or declines the promote invitation, the host receives this callback.
 
(void) - onSinkSelfAllowTalkNotification
 Invoke this function when the attendee is allowed to talk.
 
(void) - onSinkSelfDisallowTalkNotification
 Invoke this function when the attendee is not allowed to talk.
 
(void) - onAllowWebinarReactionStatusChanged:
 Invoke this function when the attendee is allow or not allow to using reaction.
 
(void) - onAllowAttendeeRaiseHandStatusChanged:
 Invoke this function when the attendee is allow or not allow to using raise hand.
 
(void) - onAllowAttendeeViewTheParticipantCountStatusChanged:
 Invoke this function when the attendee is allow to view the participant count.
 
(void) - onWebinarNeedInputScreenName:
 When joining the webinar, this callback is triggered if the user needs to input a username.
 
(void) - onCaptionStatusChanged:
 Sink the event of captions enabled status changed.
 
(void) - onSinkLiveTranscriptionStatus:
 Sink the event of live transcription status.
 
(void) - onSinkLiveTranscriptionMsgReceived:speakerId:type:
 Sink the event of receive the live transcription message.
 
(void) - onLiveTranscriptionMsgInfoReceived:
 
(void) - onOriginalLanguageMsgReceived:
 
(void) - onLiveTranscriptionMsgError:transcriptLanguage:
 Translation message error callback.
 
(void) - onSinkRequestForLiveTranscriptReceived:bAnonymous:
 Sink the event of request for start the live transcription. Only the host can retrieve this callback. You can approve request call start live transcription, or decline as do nothing.
 
(void) - on3DAvatarItemThumbnailsDownloaded
 Callback event to notify that all 3D avatar items' thumbnails have been download.
 
(void) - on3DAvatarItemDataDownloading:
 Callback event to notify that the selected 3D avatar item is downloading.
 
(void) - on3DAvatarItemDataDownloaded:andIndex:
 Callback event to notify whether the selected 3D avatar item has been downloaded successfully.
 
(void) - onHasCreatorRightsNotification:
 Notify that the creator role is given.
 
(void) - onHasAdminRightsNotification:
 Notify that the admin role is given.
 
(void) - onHasAssistantRightsNotification:
 Notify that the assistant role is given.
 
(void) - onHasAttendeeRightsNotification:
 Notify that the attendee role is given.
 
(void) - onHasDataHelperRightsNotification:
 Notify that the data helper role is given.
 
(void) - onBroadcastBOVoiceStatus:
 The status of broadcasting voice to BO has been changed.
 
(void) - onLostCreatorRightsNotification
 A lost creator role notification.
 
(void) - onLostAdminRightsNotification
 A lost admin role notification.
 
(void) - onLostAssistantRightsNotification
 A lost assistant role notification.
 
(void) - onLostAttendeeRightsNotification
 A lost attendee role notification.
 
(void) - onLostDataHelperRightsNotification
 A lost data helper role notification.
 
(void) - onNewBroadcastMessageReceived:senderID:senderName:
 A broadcast message notification.
 
(void) - onBOStopCountDown:
 When BOOption.countdownSeconds != MobileRTCBOStopCountDown_Not_CountDown, host stop the breakout room and all users receive the event.
 
(void) - onHostInviteReturnToMainSession:replyHandler:
 When you are in a breakout room and the host invites you return to main session, you receive the event.
 
(void) - onBOStatusChanged:
 When host change the breakout room status, all users receive the event.
 
(void) - onBOSwitchRequestReceived:newBOID:
 When the host modifies the breakout room, all users receive the event.
 
(void) - onBOInfoUpdated:
 The updated breakout meeting information.
 
(void) - onUnAssignedUserUpdated
 The unassigned user update.
 
(void) - onBOListInfoUpdated
 The BO list info updated.
 
(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.
 
(void) - onHelpRequestHandleResultReceived:
 Receive the result of sending a help request.
 
(void) - onHostJoinedThisBOMeeting
 The host joins the current breakout meeting.
 
(void) - onHostLeaveThisBOMeeting
 The host leaves the current breakout meeting.
 
(void) - onBOCreateSuccess:
 Creator receives breakout identifier when successfully creating the breakout room.
 
(void) - onWebPreAssignBODataDownloadStatusChanged:
 When the pre-assigned data download status changes, you will receive the event.
 
(void) - onBOOptionChanged:
 You will receive the event when the option changes.
 
(void) - onEmojiReactionReceived:reactionType:reactionSkinTone:
 Notify receipt of the emoji reaction.
 
(void) - onEmojiReactionReceivedInWebinar:
 Emoji reaction callback. This callback notifies the user when an emoji is received in the webinar.
 
(void) - onEmojiFeedbackReceived:feedbackType:
 Emoji feedback received callback. This function is used to inform the user once received the emoji feedback sent by others or user himself.
 
(void) - onEmojiFeedbackCanceled:
 Emoji feedback canceled callback. This function is used to inform the user once the received emoji feedback sent by others or user himself was canceled.
 
(void) - onE2EEMeetingSecurityCodeChanged
 This callback will be called when the security code changes.
 
(void) - onFocusModeStateChanged:
 The focus mode state was changed by the host or co-host.
 
(void) - onFocusModeShareTypeChanged:
 The focus mode share type was changed by the host or co-Host.
 

Detailed Description

Delegate containing callbacks related to meeting state updates.

Definition at line 42 of file MobileRTCMeetingDelegate.h.

Method Documentation

◆ on3DAvatarItemDataDownloaded:andIndex:

- (void) on3DAvatarItemDataDownloaded: (bool)  success
andIndex: (int)  index 
optional

Callback event to notify whether the selected 3D avatar item has been downloaded successfully.

Parameters
indexThe index of the selected 3D avatar item.
successYes indicates the selected 3D avatar item has been downloaded successfully.

◆ on3DAvatarItemDataDownloading:

- (void) on3DAvatarItemDataDownloading: (int)  index
optional

Callback event to notify that the selected 3D avatar item is downloading.

Parameters
indexThe index of the selected 3D avatar item.

◆ on3DAvatarItemThumbnailsDownloaded

- (void) on3DAvatarItemThumbnailsDownloaded
optional

Callback event to notify that all 3D avatar items' thumbnails have been download.

◆ onAICompanionActiveChangeNotice:

- (void) onAICompanionActiveChangeNotice: (BOOL)  isActive
optional

Sink the event that AI Companion active status changed.

Parameters
isActiveYES means the AI Companion is active

◆ onAllowAskQuestionStatus:

- (void) onAllowAskQuestionStatus: (BOOL)  bEnabled
optional

Notify host/cohost has changed the status of ask question.

Parameters
bEnabledCan ask question or not.

◆ onAllowAttendeeRaiseHandStatusChanged:

- (void) onAllowAttendeeRaiseHandStatusChanged: (BOOL)  canRaiseHand
optional

Invoke this function when the attendee is allow or not allow to using raise hand.

Parameters
canRaiseHandIf the raise hand is allowed, the result is YES, otherwise NO.

◆ onAllowAttendeeViewTheParticipantCountStatusChanged:

- (void) onAllowAttendeeViewTheParticipantCountStatusChanged: (BOOL)  canViewParticipantCount
optional

Invoke this function when the attendee is allow to view the participant count.

Parameters
canViewParticipantCountIf the view participant is allowed, the result is YES, otherwise NO.

◆ onAllowParticipantsRenameNotification:

- (void) onAllowParticipantsRenameNotification: (BOOL)  allow
optional

Sink the event that lets participants rename them

Parameters
allowYES allow.If NO,participants may not rename themselves

◆ onAllowParticipantsRequestCloudRecording:

- (void) onAllowParticipantsRequestCloudRecording: (BOOL)  allow
optional

Callback event that lets participants request hots to start cloud recording.

Parameters
allowTrue allow. If false, disallow.

◆ onAllowParticipantsShareStatusNotification:

- (void) onAllowParticipantsShareStatusNotification: (BOOL)  allow
optional

Sink the event that lets participants allow to share

Parameters
allowYES allow.if NO.participants may not share

◆ onAllowParticipantsShareWhiteBoardNotification:

- (void) onAllowParticipantsShareWhiteBoardNotification: (BOOL)  allow
optional

Sink the event that lets participants share a new white board

Parameters
allowYES allow.if NO.participants may not share new white boards

◆ onAllowParticipantsStartVideoNotification:

- (void) onAllowParticipantsStartVideoNotification: (BOOL)  allow
optional

Sink the event that lets participants start a video

Parameters
allowYES allow. if NO disallow

◆ onAllowParticipantsUnmuteSelfNotification:

- (void) onAllowParticipantsUnmuteSelfNotification: (BOOL)  allow
optional

Sink the event that lets participants unmute them

Parameters
allowYES allow. If NO, participants may not unmute themselves

◆ onAllowWebinarReactionStatusChanged:

- (void) onAllowWebinarReactionStatusChanged: (BOOL)  canReaction
optional

Invoke this function when the attendee is allow or not allow to using reaction.

Parameters
canReactionIf the Reaction is allowed, the result is YES, otherwise NO.

◆ onAppShareSplash

- (void) onAppShareSplash
optional

A meeting starts by sharing.

◆ onAskToEndOtherMeeting:

- (void) onAskToEndOtherMeeting: (void(^)(BOOL cancel))  completion
optional

The user needs to end another ongoing meeting.

Parameters
completionAsk the user to end another ongoing meeting.

◆ onAudioOutputChange

- (void) onAudioOutputChange
optional

The current user's audio output selection has changed.

◆ onAvailableLanguageListUpdated:

- (void) onAvailableLanguageListUpdated: (NSArray< MobileRTCInterpretationLanguage * > *_Nullable)  availableLanguageList
optional

available languages changed callback. When available languages in meeting are changed, all non-interpreter users in a meeting get the event.

Parameters
availableLanguageListSpecify the available languages list.

◆ onAvailableSignLanguageListUpdated:

- (void) onAvailableSignLanguageListUpdated: (NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable)  availableSignLanguageList
optional

Indicate when available sign languages in a meeting change. All users in the meeting can get the event.

Parameters
availableSignLanguageListSpecify the available sign languages list. For more details, see ZoomSDKSignInterpretationLanguageInfo object.

◆ onBOCreateSuccess:

- (void) onBOCreateSuccess: (NSString *_Nullable)  BOID
optional

Creator receives breakout identifier when successfully creating the breakout room.

Parameters
BOIDThe identifier of the created breakout.

◆ 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.

◆ onBOInfoUpdated:

- (void) onBOInfoUpdated: (NSString *_Nullable)  boId
optional

The updated breakout meeting information.

Parameters
boIdThe identifier for the breakout meeting.

◆ onBOListInfoUpdated

- (void) onBOListInfoUpdated
optional

The BO list info updated.

◆ onBOOptionChanged:

- (void) onBOOptionChanged: (MobileRTCBOOption *_Nonnull)  newOption
optional

You will receive the event when the option changes.

Parameters
newOptionnew BO Option.

◆ onBOStatusChanged:

- (void) onBOStatusChanged: (MobileRTCBOStatus status
optional

When host change the breakout room status, all users receive the event.

Parameters
statusThe current status of the breakout room.

◆ onBOStopCountDown:

- (void) onBOStopCountDown: (NSUInteger)  seconds
optional

When BOOption.countdownSeconds != MobileRTCBOStopCountDown_Not_CountDown, host stop the breakout room and all users receive the event.

Parameters
secondsThe countdown in seconds.
Warning
Please leave the breakout room when the countdown ends.

◆ onBOSwitchRequestReceived:newBOID:

- (void) onBOSwitchRequestReceived: (NSString *_Nullable)  newBOName
newBOID: (NSString *_Nullable)  newBOID 
optional

When the host modifies the breakout room, all users receive the event.

Parameters
newBONameThe new brekaout room name.
newBOIDThe new breakout room ID.

◆ onBroadcastBOVoiceStatus:

- (void) onBroadcastBOVoiceStatus: (BOOL)  bStart
optional

The status of broadcasting voice to BO has been changed.

Parameters
bStartYES for host begin broadcasting voice to BO, NO for host stop broadcasting voice to BO.

◆ onCallRoomDeviceStateChanged:

- (void) onCallRoomDeviceStateChanged: (H323CallOutStatus state
optional

The room device state changed.

Parameters
stateThe new state. See [H323CallOutStatus].

◆ onCameraNoPrivilege

- (void) onCameraNoPrivilege
optional

Camera access permission was denied.

◆ onCaptionStatusChanged:

- (void) onCaptionStatusChanged: (BOOL)  enable
optional

Sink the event of captions enabled status changed.

Parameters
enableTrue means the host enables the captions, otherwise means the host disables the captions.

◆ onChatMessageNotification:

- (void) onChatMessageNotification: (MobileRTCMeetingChat *_Nullable)  chatInfo
optional

An in-meeting chat message has been received.

Parameters
chatInfoThe meeting chat information.

◆ onChatMsgDeleteNotification:deleteBy:

- (void) onChatMsgDeleteNotification: (NSString *_Nonnull)  msgID
deleteBy: (MobileRTCChatMessageDeleteType deleteBy 
optional

A chat message has been deleted.

Parameters
msgIDThe ID of the message that was deleted.
deleteByInformation about who deleted the message. See [MobileRTCChatMessageDeleteType].

◆ onCheckCMRPrivilege:

- (void) onCheckCMRPrivilege: (MobileRTCCMRError result
optional

Determine if the current user has cloud recording privileges.

Parameters
resultThe result of checking CMR privilege.

◆ onCheckIfMeetingVoIPCallRunning

- (BOOL) onCheckIfMeetingVoIPCallRunning
optional

Check if the meeting VoIP call is running. It affects the picture-in-picture function in ZoomUI if videoCallPictureInPictureEnabled returns YES of MobileRTCMeetingSettings.

Returns
YES - Meeting VoIP Call is Running. NO - Meeting VoIP Call is not Running.

◆ onClaimHostResult:

- (void) onClaimHostResult: (MobileRTCClaimHostError error
optional

A user claims the host.

◆ onClickedAudioButton:

- (BOOL) onClickedAudioButton: (UIViewController *_Nonnull)  parentVC
optional

The audio button in the UI has been clicked.

Parameters
parentVCParent viewcontroller used to present custom audio UI.
Returns
YES: The developer takes a custom action and the SDK does nothing. NO: The SDK still takes its default action.

◆ onClickedDialOut:isCallMe:

- (void) onClickedDialOut: (UIViewController *_Nonnull)  parentVC
isCallMe: (BOOL)  me 
optional

The dial out button has been clicked.

Parameters
parentVCParent viewcontroller used to present outgoing call UI.
meIf YES, it is a call out. Otherwise, it is an invite by phone. For more information see https://support.zoom.us/hc/en-us/articles/360060596392-Enabling-or-disabling-call-me-and-invite-by-phone.

◆ onClickedEndButton:endButton:

- (BOOL) onClickedEndButton: (UIViewController *_Nonnull)  parentVC
endButton: (UIButton *_Nonnull)  endButton 
optional

The meeting end button has been clicked.

Parameters
parentVCParent viewcontroller used to present custom Participants UI.
endButtonThe end button.
Returns
YES: The developer takes a custom action and the SDK does nothing. NO: The SDK still takes its default action.

◆ onClickedInviteButton:addInviteActionItem:

- (BOOL) onClickedInviteButton: (UIViewController *_Nonnull)  parentVC
addInviteActionItem: (NSMutableArray< MobileRTCMeetingInviteActionItem * > *_Nullable)  array 
optional

The invite button in the UI has been clicked.

Parameters
parentVCParent viewcontroller used to present custom invite UI.
array<MobileRTCMeetingInviteActionItem *>Custom invitation actions to be added.
Returns
YES: The developer takes a custom action and the SDK does nothing. NO: The SDK still takes its default action.

◆ onClickedParticipantsButton:

- (BOOL) onClickedParticipantsButton: (UIViewController *_Nonnull)  parentVC
optional

The participants button has been clicked.

Parameters
parentVCParent viewcontroller used to present custom participants UI.
Returns
YES: The developer takes a custom action and the SDK does nothing. NO: The SDK still takes its default action.

◆ onClickedShareButton:addShareActionItem:

- (BOOL) onClickedShareButton: (UIViewController *_Nonnull)  parentVC
addShareActionItem: (NSMutableArray< MobileRTCMeetingShareActionItem * > *_Nonnull)  array 
optional

The share button has been clicked.

Parameters
parentVCParent viewController used to present the custom share UI.
Returns
YES: The developer takes a custom action and the SDK does nothing. NO: The SDK still takes its default action. NO if user wants to custom Share Action Item, add items to Share ActionSheet via MobileRTCMeetingShareActionItem. Otherwise YES, the user uses the default UI.

◆ onClickShareScreen:

- (void) onClickShareScreen: (UIViewController *_Nonnull)  parentVC
optional

The user has clicked the shared screen.

Parameters
parentVCParent viewcontroller used to present the view of Share Screen Usage Guide.
Warning
Application presents Share Screen Usage Guide.

◆ onClosedCaptionReceived:speakerId:msgTime:

- (void) onClosedCaptionReceived: (NSString *_Nonnull)  message
speakerId: (NSUInteger)  speakerID
msgTime: (NSDate *_Nullable)  msgTime 
optional

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.

Parameters
messageThe closed caption text.
speakerIDThe ID of the speaker.
msgTimeThe time of the close caption.

◆ onCloudRecordingStorageFull:

- (void) onCloudRecordingStorageFull: (long)  gracePeriodDate
optional

An event sink that the cloud recording storage is full.

Parameters
gracePeriodDateA point in time, in milliseconds in, UTC.
Warning
You can use the cloud recording storage until the gracePeriodDate.

◆ onDialOutStatusChanged:

- (void) onDialOutStatusChanged: (DialOutStatus status
optional

The status of an outgoing call has changed.

Parameters
statusThe new status.

◆ onE2EEMeetingSecurityCodeChanged

- (void) onE2EEMeetingSecurityCodeChanged
optional

This callback will be called when the security code changes.

◆ onEmojiFeedbackCanceled:

- (void) onEmojiFeedbackCanceled: (NSUInteger)  userId
optional

Emoji feedback canceled callback. This function is used to inform the user once the received emoji feedback sent by others or user himself was canceled.

Parameters
userIdSpecify the user ID of the emoji feedback sender.

◆ onEmojiFeedbackReceived:feedbackType:

- (void) onEmojiFeedbackReceived: (NSUInteger)  userId
feedbackType: (MobileRTCEmojiFeedbackType type 
optional

Emoji feedback received callback. This function is used to inform the user once received the emoji feedback sent by others or user himself.

Parameters
userIdSpecify the user ID of the emoji feedback sender.
typeSpecify the type of the received emoji feedback.

◆ onEmojiReactionReceived:reactionType:reactionSkinTone:

- (void) onEmojiReactionReceived: (NSUInteger)  userId
reactionType: (MobileRTCEmojiReactionType type
reactionSkinTone: (MobileRTCEmojiReactionSkinTone skinTone 
optional

Notify receipt of the emoji reaction.

Parameters
userIdThe user ID of the send emoji reaction.
typeThe send emoji reaction type.
skinToneThe send emoji reaction skintone.

◆ onEmojiReactionReceivedInWebinar:

- (void) onEmojiReactionReceivedInWebinar: (MobileRTCEmojiReactionType type
optional

Emoji reaction callback. This callback notifies the user when an emoji is received in the webinar.

Parameters
typeSpecify the received reaction's type.

◆ onFocusModeShareTypeChanged:

- (void) onFocusModeShareTypeChanged: (MobileRTCFocusModeShareType shareType
optional

The focus mode share type was changed by the host or co-Host.

Parameters
shareTypeshare type change.

◆ onFocusModeStateChanged:

- (void) onFocusModeStateChanged: (BOOL)  on
optional

The focus mode state was changed by the host or co-host.

Parameters
onYES means the focus mode on.

◆ onFollowHostVideoOrderChanged:

- (void) onFollowHostVideoOrderChanged: (BOOL)  follow
optional

The host has enabled/disabled the "Follow Host's Video Order" setting.

Parameters
followIf yes, the host has enabled the setting. Otherwise, it was disabled.

◆ onFreeMeetingNeedToUpgrade:giftUpgradeURL:

- (void) onFreeMeetingNeedToUpgrade: (FreeMeetingNeedUpgradeType type
giftUpgradeURL: (NSString *_Nullable)  giftURL 
optional

The free meeting needs an upgrade.

Parameters
typeSee [FreeMeetingNeedUpgradeType], if the type is [FreeMeetingNeedUpgradeType_BY_GIFTURL], the user can upgrade through the url. If the type is [FreeMeetingNeedUpgradeType_BY_ADMIN], only the user's admin can upgrade the meeting.
giftURLThe URL through which the meeting can be upgraded.

◆ onFreeMeetingUpgradedToProMeeting

- (void) onFreeMeetingUpgradedToProMeeting
optional

The meeting has been upgraded to a pro (licensed) meeting.

◆ onFreeMeetingUpgradeToGiftFreeTrialStart

- (void) onFreeMeetingUpgradeToGiftFreeTrialStart
optional

The free meeting was upgraded to a free trial and has started.

◆ onFreeMeetingUpgradeToGiftFreeTrialStop

- (void) onFreeMeetingUpgradeToGiftFreeTrialStop
optional

The free meeting which was upgraded to a free trial has stopped.

◆ onGetRightAnswerListPrivilege:

- (void) onGetRightAnswerListPrivilege: (BOOL)  bCan
optional

Callback event for the user get right answer list privilege changed. This is triggered when the host calls EnableGetRightAnswerList in a quiz.

Parameters
bCanSpecify whether the user has get right answer list privilege or not.

◆ onHasAdminRightsNotification:

- (void) onHasAdminRightsNotification: (MobileRTCBOAdmin *_Nonnull)  admin
optional

Notify that the admin role is given.

Parameters
adminThe admin role is given.

◆ onHasAssistantRightsNotification:

- (void) onHasAssistantRightsNotification: (MobileRTCBOAssistant *_Nonnull)  assistant
optional

Notify that the assistant role is given.

Parameters
assistantThe assistant role is given.

◆ onHasAttendeeRightsNotification:

- (void) onHasAttendeeRightsNotification: (MobileRTCBOAttendee *_Nonnull)  attendee
optional

Notify that the attendee role is given.

Parameters
attendeeThe attendee role is given.

◆ onHasCreatorRightsNotification:

- (void) onHasCreatorRightsNotification: (MobileRTCBOCreator *_Nonnull)  creator
optional

Notify that the creator role is given.

Parameters
creatorthe creator role is given.

◆ onHasDataHelperRightsNotification:

- (void) onHasDataHelperRightsNotification: (MobileRTCBOData *_Nonnull)  dataHelper
optional

Notify that the data helper role is given.

Parameters
dataHelperThe data helper role is given.

◆ onHelpRequestHandleResultReceived:

- (void) onHelpRequestHandleResultReceived: (MobileRTCBOHelpReply eResult
optional

Receive the result of sending a help request.

Parameters
eResultThe response result for the help request.

◆ onHelpRequestReceived:

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

Admin receives help request from userID.

Parameters
strUserIDThe identifier of the breakout room meeting user.

◆ onHostInviteReturnToMainSession:replyHandler:

- (void) onHostInviteReturnToMainSession: (NSString *_Nullable)  hostName
replyHandler: (MobileRTCReturnToMainSessionHandler *_Nullable)  replyHandler 
optional

When you are in a breakout room and the host invites you return to main session, you receive the event.

Parameters
hostNamethe host name.
replyHandlerthe handler to reply for the main session invitation.

◆ onHostJoinedThisBOMeeting

- (void) onHostJoinedThisBOMeeting
optional

The host joins the current breakout meeting.

◆ onHostLeaveThisBOMeeting

- (void) onHostLeaveThisBOMeeting
optional

The host leaves the current breakout meeting.

◆ onHostVideoOrderUpdated:

- (void) onHostVideoOrderUpdated: (NSArray< NSNumber * > *_Nullable)  orderArr
optional

The order of users' videos in gallery view has been changed by the host.

Parameters
orderArrThe updated order of user videos.
Warning
This callback is only invoked if the host has enabled the "Follow Host's Video Order" setting.

◆ onInMeetingUserAvatarPathUpdated:

- (void) onInMeetingUserAvatarPathUpdated: (NSInteger)  userID
optional

The user avatar path is updated in the meeting.

◆ onInMeetingUserUpdated

- (void) onInMeetingUserUpdated
optional

The user state is updated in the meeting.

◆ onInterpretationStart

- (void) onInterpretationStart
optional

Interpretation starts. Informs the user that interpretation has been started. All users in the meeting get the event.

◆ onInterpretationStop

- (void) onInterpretationStop
optional

Interpretation stops. Informs the user that interpretation has been stopped. All users in the meeting get the event.

◆ onInterpreterActiveLanguageChanged:activeLanguageId:

- (void) onInterpreterActiveLanguageChanged: (NSInteger)  userID
activeLanguageId: (NSInteger)  activeLanID 
optional

interpreter active language changed callback. When a interpreter's active language changes, all users in meeting get the event.

Parameters
userIDSpecify the user ID whose active language changed.
activeLanIDSpecify the interpreter current active language ID.

◆ onInterpreterLanguageChanged:andLanguage2:

- (void) onInterpreterLanguageChanged: (NSInteger)  lanID1
andLanguage2: (NSInteger)  lanID2 
optional

interpreter languages changed callback. When a interpreter's languages changed, only the interpreter can get the event.

Parameters
lanID1Specify the new language ID1.
lanID2Specify the new language ID2.

◆ onInterpreterLanguagesUpdated:

- (void) onInterpreterLanguagesUpdated: (NSArray< MobileRTCInterpretationLanguage * > *_Nullable)  availableLanguages
optional

Indicates a change in the list of available languages that interpreters can hear. When the list of available languages that interpreters can hear in a meeting changes, all interpreters in the meeting get this event.

Parameters
availableLanguagesThe list of available languages that interpreters can hear.

◆ onInterpreterListChanged

- (void) onInterpreterListChanged
optional

The meeting's interpreter list changes. When one or more interpreters leave or a preset interpreter joins. Only the host gets the event.

◆ onInterpreterRoleChanged:isInterpreter:

- (void) onInterpreterRoleChanged: (NSUInteger)  userID
isInterpreter: (BOOL)  isInterpreter 
optional

Interpreter role changes. When a user's role changed (participant <-> interpreter), all users in meeting get the event.

Parameters
userIDSpecify the user ID whose status changed.
isInterpreterSpecify if user's role is interpreter or not.

◆ onJBHWaitingWithCmd:

- (void) onJBHWaitingWithCmd: (JBHCmd cmd
optional

Join a meeting without a host. You can show or hide the custom JBH waiting UI.

Parameters
cmdShow/Hide JBH command.

◆ onJoinMeetingConfirmed

- (void) onJoinMeetingConfirmed
optional

The meeting has been joined successfully.

◆ onJoinMeetingInfo:completion:

- (void) onJoinMeetingInfo: (MobileRTCJoinMeetingInfo info
completion: (void(^)(NSString *_Nonnull displayName, NSString *_Nonnull password, BOOL cancel))  completion 
optional

The user must provide additional information before joining the meeting.

Parameters
infothe information need for join meeting.
completionthe block for input the information displayName A name to be displayed in the meeting. password The meeting passcode. cancel If YES, the attempt to join the meeting is cancelled.

◆ onLiveStreamStatusChange:

- (void) onLiveStreamStatusChange: (MobileRTCLiveStreamStatus liveStreamStatus
optional

The live stream status has changed.

Parameters
liveStreamStatusThe new status. See [MobileRTCLiveStreamStatus].

◆ onLiveTranscriptionMsgError:transcriptLanguage:

- (void) onLiveTranscriptionMsgError: (MobileRTCLiveTranscriptionLanguage *_Nullable)  speakLanguage
transcriptLanguage: (MobileRTCLiveTranscriptionLanguage *_Nullable)  transcriptLanguage 
optional

Translation message error callback.

Parameters
speakLanguagean object of the speak message language.
transcriptLanguagean object of the message language you want to translate.

◆ onLiveTranscriptionMsgInfoReceived:

- (void) onLiveTranscriptionMsgInfoReceived: (MobileRTCLiveTranscriptionMessageInfo *_Nullable)  messageInfo
optional

◆ onLocalRecordingStatus:status:

- (void) onLocalRecordingStatus: (NSInteger)  userId
status: (MobileRTCRecordingStatus status 
optional

The local recording status has changed.

Parameters
userIdThe ID of the user who caused the change.
statusThe new recording status.

◆ onLocalVideoOrderUpdated:

- (void) onLocalVideoOrderUpdated: (NSArray< NSNumber * > *_Nullable)  localOrderArr
optional

The order of users' videos in gallery view has been changed locally.

Parameters
localOrderArrThe updated order of user videos.

◆ onLostAdminRightsNotification

- (void) onLostAdminRightsNotification
optional

A lost admin role notification.

◆ onLostAssistantRightsNotification

- (void) onLostAssistantRightsNotification
optional

A lost assistant role notification.

◆ onLostAttendeeRightsNotification

- (void) onLostAttendeeRightsNotification
optional

A lost attendee role notification.

◆ onLostCreatorRightsNotification

- (void) onLostCreatorRightsNotification
optional

A lost creator role notification.

◆ onLostDataHelperRightsNotification

- (void) onLostDataHelperRightsNotification
optional

A lost data helper role notification.

◆ onMeetingCoHostChange:isCoHost:

- (void) onMeetingCoHostChange: (NSUInteger)  userID
isCoHost: (BOOL)  isCoHost 
optional

The meeting co-host changes.

Parameters
userIDThe new co-host's user ID.
isCoHostIndicates the user (userID) be assigned to co-host or be remove co-host.

◆ onMeetingEndedReason:

- (void) onMeetingEndedReason: (MobileRTCMeetingEndReason reason
optional

The meeting has ended.

Parameters
reasonThe reason why the meeting has ended. See [MobileRTCMeetingEndReason].

◆ onMeetingError:message:

- (void) onMeetingError: (MobileRTCMeetError error
message: (NSString *_Nullable)  message 
optional

An error has occurred.

Parameters
errorThe error code. See [MobileRTCMeetError].
messageThe message of the error.

◆ onMeetingHostChange:

- (void) onMeetingHostChange: (NSUInteger)  hostId
optional

The meeting host changes.

Parameters
hostIdThe new host's user ID.

◆ onMeetingLockStatus:

- (void) onMeetingLockStatus: (BOOL)  isLock
optional

Sink the event that allow a meeting lock status change

Parameters
isLockYES, the status is locked. If NO, the status is unlocked.

◆ onMeetingParameterNotification:

- (void) onMeetingParameterNotification: (MobileRTCMeetingParameter *_Nullable)  meetingParam
optional

The meeting parameters have been updated.

Parameters
meetingParammeetingParam Meeting parameter. See [MobileRTCMeetingParameter].

◆ onMeetingQAStatusChanged:

- (void) onMeetingQAStatusChanged: (BOOL)  isMeetingQAFeatureOn
optional

Callback event of meeting QA feature status changes.

Parameters
isMeetingQAFeatureOnYES means meeting QA feature is on, otherwise not.

◆ onMeetingReady

- (void) onMeetingReady
optional

The meeting is ready.

◆ onMeetingStateChange:

- (void) onMeetingStateChange: (MobileRTCMeetingState state
optional

Notify the user that the meeting state has changed.

Parameters
stateThe new meeting state. [MobileRTCMeetingState].

◆ onMicrophoneNoPrivilege

- (void) onMicrophoneNoPrivilege
optional

Microphone access permission was denied.

◆ onMicrophoneStatusError:

- (void) onMicrophoneStatusError: (MobileRTCMicrophoneError error
optional

The user's microphone has encountered an error.

Parameters
errorThe error. See [MobileRTCMicropohoneError]

◆ onMyAudioStateChange

- (void) onMyAudioStateChange
optional

The current user's audio state has changed.

◆ onMyHandStateChange

- (void) onMyHandStateChange
optional

The current user's hand state changes.

◆ onMyVideoStateChange

- (void) onMyVideoStateChange
optional

The current user's video status has changed.

◆ onNewBroadcastMessageReceived:senderID:senderName:

- (void) onNewBroadcastMessageReceived: (NSString *_Nullable)  broadcastMsg
senderID: (NSUInteger)  senderID
senderName: (NSString *_Nullable)  senderName 
optional

A broadcast message notification.

Parameters
broadcastMsgThe broadcast message received from host.
senderIDThe senderID.
senderNameThe sender Name.

◆ onNoHostMeetingWillTerminate:

- (void) onNoHostMeetingWillTerminate: (NSUInteger)  minutes
optional

The meeting does not have a host and ends.

Parameters
minutesThe minutes remaining until the meeting ends.

◆ onOngoingShareStopped

- (void) onOngoingShareStopped
optional

All active shares have stopped.

◆ onOriginalLanguageMsgReceived:

- (void) onOriginalLanguageMsgReceived: (MobileRTCLiveTranscriptionMessageInfo *_Nullable)  messageInfo
optional

◆ onParticipantProfilePictureStatusChange:

- (void) onParticipantProfilePictureStatusChange: (BOOL)  hidden
optional

Sink the event that participant profile status change.

Parameters
hiddentrue means hide participant profile picture, false means show participant profile picture.

◆ onPollingActionResult:pollingID:bSuccess:errorMsg:

- (void) onPollingActionResult: (MobileRTCPollingActionType actionType
pollingID: (NSString *_Nullable)  pollingID
bSuccess: (BOOL)  bSuccess
errorMsg: (NSString *_Nullable)  errorMsg 
optional

Polling action result callback. This is triggered when a user perform an action for a poll.

Parameters
actionTypeSpecify the action type. For more details, see MobileRTCPollingActionType enum.
pollingIDSpecify the action poll's ID.
bSuccessSpecify whether the action succeeds.
errorMsgSpecify the error message when the action fails. It is only for MobileRTCPollingActionType_Error.
Warning
If actionType is MobileRTCPollingActionType_Error, use errorMsg. This errorMsg may be triggered by any action.

◆ onPollingElapsedTime:uElapsedtime:

- (void) onPollingElapsedTime: (NSString *_Nullable)  pollingID
uElapsedtime: (int)  uElapsedtime 
optional

Polling elapsed time callback.

Parameters
pollingIDSpecify the polling question's ID.
uElapsedtimeSpecify the polling elapsed time in milliseconds.
Warning
This is triggered when a host starts a poll or a user changes to host from non host.

◆ onPollingInactive

- (void) onPollingInactive
optional

polling inactive callback. When the user starts a meeting in another device by same account, this callback is triggered. Then call CanDoPolling return false.

◆ onPollingListUpdated

- (void) onPollingListUpdated
optional

Polling list updated callback. This is triggered when a host adds, edits, duplicates, or deletes a poll.

◆ onPollingQuestionImageDownloaded:path:

- (void) onPollingQuestionImageDownloaded: (NSString *_Nullable)  questionID
path: (NSString *_Nullable)  path 
optional

Polling question item image downloaded callback.

Parameters
questionIDSpecify the polling question's ID.
pathSpecify the image downloaded path.
Warning
This is triggered when a user starts or joins a meeting, if any polling question has an image, or the host uploads an image to a polling question in the meeting.

◆ onPollingResultUpdated:

- (void) onPollingResultUpdated: (NSString *_Nullable)  pollingID
optional

Polling result updated callback. When a participant submits polling.

Parameters
pollingIDSpecify the result updated poll's ID.

◆ onPollingStatusChanged:status:

- (void) onPollingStatusChanged: (NSString *_Nullable)  pollingID
status: (MobileRTCPollingStatus status 
optional

Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped.

Parameters
pollingIDSpecify the status changed poll's ID.
statusSpecify current polling status. For more details, see MobileRTCPollingStatus enum.

◆ onProxyAuth:port:completion:

- (void) onProxyAuth: (NSString *_Nonnull)  host
port: (NSUInteger)  port
completion: (void(^)(NSString *_Nonnull host, NSUInteger port, NSString *_Nonnull username, NSString *_Nonnull password, BOOL cancel))  completion 
optional

The user must provide proxy information.

Parameters
hostProxy host.
portProxy port.
completionThe SDK asks the user to input proxy information once it detects that the information changed.

◆ onRawLiveStreamPrivilegeChanged:

- (void) onRawLiveStreamPrivilegeChanged: (BOOL)  hasPrivilege
optional

The current user’s raw live streaming privilege has changed.

Parameters
hasPrivilegeWhether the user has privilege.

◆ onRawLiveStreamPrivilegeRequested:

- (void) onRawLiveStreamPrivilegeRequested: (MobileRTCRequestRawLiveStreamPrivilegeHandler *_Nullable)  handler
optional

A user has requested raw live streaming privilege.

Parameters
handlerA pointer to the IRequestRawLiveStreamPrivilegeHandler. For more details, see [MobileRTCRequestRawLiveStreamPrivilegeHandler].

◆ onRawLiveStreamPrivilegeRequestTimeout

- (void) onRawLiveStreamPrivilegeRequestTimeout
optional

The current user's request for raw live streaming privilege has timed out with no response.

◆ onRecordingStatus:

- (void) onRecordingStatus: (MobileRTCRecordingStatus status
optional

The cloud recording status has changed.

Parameters
statusThe new recording status.

◆ onRequestCloudRecordingResponse:

- (void) onRequestCloudRecordingResponse: (MobileRTCRequestStartCloudRecordingStatus status
optional

Callback event for when the host responds to a cloud recording permission request.

Parameters
statusValue of request host to start cloud recording response status. For more details,

◆ onRequestLocalRecordingPrivilegeChanged:

- (void) onRequestLocalRecordingPrivilegeChanged: (MobileRTCLocalRecordingRequestPrivilegeStatus status
optional

Callback event that the request local recording privilege changes.

Parameters
statusValue of request local recording privilege status LocalRecordingRequestPrivilegeStatus

◆ onRequestLocalRecordingPrivilegeReceived:

- (void) onRequestLocalRecordingPrivilegeReceived: (MobileRTCRequestLocalRecordingPrivilegeHandler *_Nullable)  handler
optional

Callback when host received the local recording request from participant.

Parameters
handlerthe host admit or decline the request through this handler.

◆ onRequestSignInterpreterToTalk

- (void) onRequestSignInterpreterToTalk
optional

Callback event of the requirement to unmute sign interpreter's audio from the host.

◆ onSendPairingCodeStateChanged:MeetingNumber:

- (void) onSendPairingCodeStateChanged: (MobileRTCH323ParingStatus state
MeetingNumber: (unsigned long long)  meetingNumber 
optional

The H.323 pairing code status has been updated and may require the end user to input their code.

Parameters
stateThe new paring state. See [MobileRTCH323ParingStatus].
meetingNumberThe meetng number.

◆ onSignInterpretationStatusChange:

- (void) onSignInterpretationStatusChange: (MobileRTCSignInterpretationStatus status
optional

Sign interpretation staus change callback. Informs the user that sign interpretation has been started or stopped. All users in meeting can get the event.

Parameters
statusSpecify current sign interpretation status.

◆ onSignInterpreterLanguageChanged

- (void) onSignInterpreterLanguageChanged
optional

Indicate when a sign interpreter's languages changed. Only the sign interpreter can get the event.

◆ onSignInterpreterListChanged

- (void) onSignInterpreterListChanged
optional

Sign interpreter list changed callback. Informs the host that some interpreter left meeting or a preset interpreter joined meeting, or host add or remove interpreter. Only the host can get the event.

◆ onSignInterpreterRoleChanged

- (void) onSignInterpreterRoleChanged
optional

Indicate when a user's role changed (participant <-> interpreter). Only that specific user gets the event.

◆ onSinkAllowAttendeeChatNotification:

- (void) onSinkAllowAttendeeChatNotification: (MobileRTCChatAllowAttendeeChat currentPrivilege
optional

Invoke this function when the chat privilege of attendees changes.

Parameters
currentPrivilegeThe chat privilege of the current attendee.
Warning
Only webinar meeting can get the callback.

◆ onSinkAttendeeChatPriviledgeChanged:

- (void) onSinkAttendeeChatPriviledgeChanged: (MobileRTCMeetingChatPriviledgeType currentPrivilege
optional

The chat privilege of attendees has changed.

Parameters
currentPrivilegeThe new chat privilege. See [MobileRTCMeetingChatPriviledgeType].
Warning
This callback is only invoked for meetings and not webinars.

◆ onSinkAttendeePromoteConfirmResult:userId:

- (void) onSinkAttendeePromoteConfirmResult: (BOOL)  agree
userId: (NSUInteger)  userId 
optional

When attendee agrees or declines the promote invitation, the host receives this callback.

Parameters
agreeIf attendee agrees, return true. Otherwise, return false.
userIdThe attendee user ID.

◆ onSinkDeleteAnswer:

- (void) onSinkDeleteAnswer: (NSArray< NSString * > *_Nonnull)  answerIDArray
optional

Callback event when an answer is deleted.

Parameters
answerIDArrayThe answer IDs.

◆ onSinkDeleteQuestion:

- (void) onSinkDeleteQuestion: (NSArray< NSString * > *_Nonnull)  questionIDArray
optional

Callback event when a question is deleted.

Parameters
questionIDArrayThe question IDs.

◆ onSinkDePromptPanelist2AttendeeResult:

- (void) onSinkDePromptPanelist2AttendeeResult: (MobileRTCWebinarPromoteorDepromoteError errorCode
optional

Invoke this function when panelist is demoted successfully from panelist to attendee.

Parameters
errorCodeDemotion successful or error type.
Warning
Only meeting host/co-host can get the callback.

◆ onSinkJoin3rdPartyTelephonyAudio:

- (void) onSinkJoin3rdPartyTelephonyAudio: (NSString *_Nullable)  audioInfo
optional

Callback event that requests to join third party telephony audio.

Parameters
audioInfoInstruction on how to join the meeting with third party audio.

◆ onSinkJoinWebinarNeedUserNameAndEmailWithCompletion:

- (void) onSinkJoinWebinarNeedUserNameAndEmailWithCompletion: (BOOL(^)(NSString *_Nonnull username, NSString *_Nonnull email, BOOL cancel))  completion
optional

Callback event that a user joins a webinar which requires username and email.

Parameters
completionUser needs to provide username and email to join meeting or cancel the join action.
Warning
In ZoomUI mode, user can implement this method to avoid Zoom's UI shown. If not implementing this method, Zoom's UI is shown.

◆ onSinkLiveTranscriptionMsgReceived:speakerId:type:

- (void) onSinkLiveTranscriptionMsgReceived: (NSString *_Nonnull)  msg
speakerId: (NSUInteger)  speakerId
type: (MobileRTCLiveTranscriptionOperationType type 
optional

Sink the event of receive the live transcription message.

Parameters
msgThe received live transcription message.
speakerIdThe speaker ID of the received live transcription message.
typeThe live transcription operation type. For more details, see MobileRTCLiveTranscriptionOperationType.

◆ onSinkLiveTranscriptionStatus:

- (void) onSinkLiveTranscriptionStatus: (MobileRTCLiveTranscriptionStatus status
optional

Sink the event of live transcription status.

Parameters
statusThe live transcription status. For more details, see MobileRTCLiveTranscriptionStatus

◆ onSinkLowerAllHands

- (void) onSinkLowerAllHands
optional

A host or cohost lowers all hands.

◆ onSinkMeetingActiveVideo:

- (void) onSinkMeetingActiveVideo: (NSUInteger)  userID
optional

The user being displayed in the active video view has changed.

Parameters
userIDThe ID of user whose video is being displayed.

◆ onSinkMeetingActiveVideoForDeck:

- (void) onSinkMeetingActiveVideoForDeck: (NSUInteger)  userID
optional

The active video user has changed.

Parameters
userIDThe ID of the newly displayed user.

◆ onSinkMeetingAudioRequestUnmuteByHost

- (void) onSinkMeetingAudioRequestUnmuteByHost
optional

The host has requested the current user to unmute their microphone.

◆ onSinkMeetingAudioStatusChange:

- (void) onSinkMeetingAudioStatusChange: (NSUInteger)  userID
optional

A user's audio status has changed. To get their updated status, check [MobileRTCMeetingUserInfo.audioStatus] for the associated user.

Parameters
userIDThe ID of user whose audio status has changed.

◆ onSinkMeetingAudioStatusChange:audioStatus:

- (void) onSinkMeetingAudioStatusChange: (NSUInteger)  userID
audioStatus: (MobileRTC_AudioStatus audioStatus 
optional

A user's audio status has changed.

Parameters
userIDThe ID of the user whose audio status has changed.
audioStatusThe new audio status of the user.

◆ onSinkMeetingAudioTypeChange:

- (void) onSinkMeetingAudioTypeChange: (NSUInteger)  userID
optional

A user's audio type has changed. To get their updated type, check MobileRTCMeetingUserInfo.audioStatus for the associated user.

Parameters
UserIDThe ID of user whose audio type changes.

◆ onSinkMeetingMyAudioTypeChange

- (void) onSinkMeetingMyAudioTypeChange
optional

The audio type of the current user has changed.

◆ onSinkMeetingPreviewStopped

- (void) onSinkMeetingPreviewStopped
optional

The SDK has stopped the current user's video preview.

Warning
When this is invoked, any instances of MobileRTCPreviewVideoView no longer render video and should be removed.

◆ onSinkMeetingShowMinimizeMeetingOrBackZoomUI:

- (void) onSinkMeetingShowMinimizeMeetingOrBackZoomUI: (MobileRTCMinimizeMeetingState state
optional

The meeting UI has been minimized or returned to fullscreen.

Parameters
stateThe new state of the meeting UI.
Warning
This callback is only compatible with the default meeting UI. It is invoked if you are using a custom meeting UI

◆ onSinkMeetingUserJoin:

- (void) onSinkMeetingUserJoin: (NSUInteger)  userID
optional

Callback event of notification of users who are in the meeting.

Parameters
userIDThe ID of the user who joins the meeting.

◆ onSinkMeetingUserLeft:

- (void) onSinkMeetingUserLeft: (NSUInteger)  userID
optional

Callback event of notification of user who leaves the meeting.

Parameters
userIDThe ID of the user who leaves the meeting.

◆ onSinkMeetingUserLowerHand:

- (void) onSinkMeetingUserLowerHand: (NSUInteger)  userID
optional

A user lowers their hand.

Parameters
userIDThe ID of the user who lowers their hand.

◆ onSinkMeetingUserRaiseHand:

- (void) onSinkMeetingUserRaiseHand: (NSUInteger)  userID
optional

A user raises their hand.

Parameters
userIDThe ID of the user who raises their hand.

◆ onSinkMeetingVideoQualityChanged:userID:

- (void) onSinkMeetingVideoQualityChanged: (MobileRTCVideoQuality qality
userID: (NSUInteger)  userID 
optional

The video quality of a user has changed.

Parameters
qalityThe user's new video quality. See MobileRTCVideoQuality.
userIDThe ID of the user whose video quality has changed.

◆ onSinkMeetingVideoRequestUnmuteByHost:

- (void) onSinkMeetingVideoRequestUnmuteByHost: (MobileRTCSDKError(^)(BOOL Accept))  completion
optional

The host has requested the current user to unmute their video.

◆ onSinkMeetingVideoStatusChange:

- (void) onSinkMeetingVideoStatusChange: (NSUInteger)  userID
optional

A participant's video status has changed. To get their updated status, check MobileRTCMeetingUserInfo.videoStatus for the associated user. Valid for both normal user and webinar attendee.

Parameters
userIDThe ID of the user whose video status has changed.

◆ onSinkMeetingVideoStatusChange:videoStatus:

- (void) onSinkMeetingVideoStatusChange: (NSUInteger)  userID
videoStatus: (MobileRTC_VideoStatus videoStatus 
optional

A participant's video status has changed.

Parameters
userIDThe ID of the user whose video status has changed.
videoStatusThe new video status of the user.

◆ onSinkPanelistCapacityExceed

- (void) onSinkPanelistCapacityExceed
optional

Invoke this function once the number of panelists exceeds the upper limit.

◆ onSinkPanelistChatPrivilegeChanged:

- (void) onSinkPanelistChatPrivilegeChanged: (MobileRTCPanelistChatPrivilegeType privilege
optional

The chat privilege of panelists has changed.

Parameters
privilegeThe new chat privilege. See [MobileRTCPanelistChatPrivilegeType].
Warning
This callback is only invoked for webinars and not meetings.

◆ onSinkPromptAttendee2PanelistResult:

- (void) onSinkPromptAttendee2PanelistResult: (MobileRTCWebinarPromoteorDepromoteError errorCode
optional

Invoke this function once a given number of attendees are promoted successfully from attendee to panelist.

Parameters
errorCodePromotion successful or error type.
Warning
Only the meeting host or co-host can get the callback.

◆ onSinkQAAddAnswer:success:

- (void) onSinkQAAddAnswer: (NSString *_Nonnull)  answerID
success: (BOOL)  success 
optional

Callback event when adding a new answer.

Parameters
answerIDThe answer user ID.
successSuccessful or not.

◆ onSinkQAAddQuestion:success:

- (void) onSinkQAAddQuestion: (NSString *_Nonnull)  questionID
success: (BOOL)  success 
optional

Callback event when adding a new question.

Parameters
questionIDThe question ID.
successSuccessful or not.

◆ onSinkQAAllowAskQuestionAnonymouslyNotification:

- (void) onSinkQAAllowAskQuestionAnonymouslyNotification: (BOOL)  beAllowed
optional

Callback event of the permission change to allow users to ask questions anonymously.

Parameters
beAllowedYES means that user can ask question anonymously. Otherwise, they cannot.

◆ onSinkQAAllowAttendeeAnswerQuestionNotification:

- (void) onSinkQAAllowAttendeeAnswerQuestionNotification: (BOOL)  beAllowed
optional

Callback event of the permission change that allows the user to answer questions.

Parameters
beAllowedYES means that user can answer questions. Otherwise, they cannot.

◆ onSinkQAAllowAttendeeUpVoteQuestionNotification:

- (void) onSinkQAAllowAttendeeUpVoteQuestionNotification: (BOOL)  beAllowed
optional

Callback event of the permission change that allows the attendee to submit questions.

Parameters
beAllowedYES means that the user can submit questions. Otherwise, they cannot.

◆ onSinkQAAllowAttendeeViewAllQuestionNotification:

- (void) onSinkQAAllowAttendeeViewAllQuestionNotification: (BOOL)  beAllowed
optional

Callback event of the permission change that allows the attendee to view all questions.

Parameters
beAllowedYES means that user can view all questions. Otherwise, they cannot.

◆ onSinkQAConnected:

- (void) onSinkQAConnected: (BOOL)  connected
optional

Callback event when Q&A is connected or disconnected.

Parameters
connectedThe flag of Q&A is connected ordisconnected.

◆ onSinkQAConnectStarted

- (void) onSinkQAConnectStarted
optional

Indicates when Question and Answer (Q&A) connection starts.

◆ onSinkQAOpenQuestionChanged:

- (void) onSinkQAOpenQuestionChanged: (NSInteger)  count
optional

Callback event when the open-ended question changes.

Parameters
countThe count of open-ended questions.

◆ onSinkQuestionMarkedAsDismissed:

- (void) onSinkQuestionMarkedAsDismissed: (NSString *_Nonnull)  questionID
optional

Callback event when a new question is marked as dismissed.

Parameters
questionIDThe question ID.

◆ onSinkReceiveAnswer:

- (void) onSinkReceiveAnswer: (NSString *_Nonnull)  answerID
optional

Callback event when a new answer is received.

Parameters
answerIDThe question ID.

◆ onSinkReceiveQuestion:

- (void) onSinkReceiveQuestion: (NSString *_Nonnull)  questionID
optional

Callback event when a new question is received.

Parameters
questionIDThe question ID.

◆ onSinkReopenQuestion:

- (void) onSinkReopenQuestion: (NSString *_Nonnull)  questionID
optional

Callback event when a question is opened.

Parameters
questionIDThe question ID.

◆ onSinkRequestForLiveTranscriptReceived:bAnonymous:

- (void) onSinkRequestForLiveTranscriptReceived: (NSUInteger)  requesterUserId
bAnonymous: (BOOL)  bAnonymous 
optional

Sink the event of request for start the live transcription. Only the host can retrieve this callback. You can approve request call start live transcription, or decline as do nothing.

Parameters
requesterUserIdThe user ID of the request from. If bAnonymous is TRUE, requesterUserId has no meaning.
bAnonymousTRUE means the request is anonymous.

◆ onSinkRevokeVoteupQuestion:orderChanged:

- (void) onSinkRevokeVoteupQuestion: (NSString *_Nonnull)  questionID
orderChanged: (BOOL)  orderChanged 
optional

Callback event when the question upvote is revoked.

Parameters
questionIDThe question ID.
orderChangedOrder changed.

◆ onSinkSelfAllowTalkNotification

- (void) onSinkSelfAllowTalkNotification
optional

Invoke this function when the attendee is allowed to talk.

◆ onSinkSelfDisallowTalkNotification

- (void) onSinkSelfDisallowTalkNotification
optional

Invoke this function when the attendee is not allowed to talk.

◆ onSinkShareSettingTypeChanged:

- (void) onSinkShareSettingTypeChanged: (MobileRTCShareSettingType shareSettingType
optional

The sharing settings change.

Parameters
shareSettingTypeThe share setting type of current meeting.

◆ onSinkShareSizeChange:

- (void) onSinkShareSizeChange: (NSUInteger)  userID
optional

The presenter resizes the sharing content.

Parameters
userIDNew size of the shared content and user ID.

◆ onSinkSharingStatus:userID:

- (void) onSinkSharingStatus: (MobileRTCSharingStatus status
userID: (NSUInteger)  userID 
optional

The share status changes.

Parameters
statusSharing status.
userIDSpecify the user ID whose share status changes.

◆ onSinkUserEndLiving:

- (void) onSinkUserEndLiving: (NSString *_Nonnull)  questionID
optional

Callback event when the question live reply ends.

Parameters
questionIDThe question ID.

◆ onSinkUserLivingReply:

- (void) onSinkUserLivingReply: (NSString *_Nonnull)  questionID
optional

Callback event when the question is replied to live.

Parameters
questionIDThe question ID.

◆ onSinkUserNameChanged:

- (void) onSinkUserNameChanged: (NSArray< NSNumber * > *_Nullable)  userNameChangedArr
optional

A user changes their screen name.

Parameters
userNameChangedArrThe user IDs whose user name(s) changed.
Warning
The old interface virtual void '-(void)onSinkUserNameChanged:userName:' is marked as deprecated, and uses this new callback. This is because in a webinar, when the host renames an attendee, only the attendee could receive the old callback. The host/cohost/panlist is not able to receive it, which leads to the developer not being able to update the UI.

◆ onSinkVoteupQuestion:orderChanged:

- (void) onSinkVoteupQuestion: (NSString *_Nonnull)  questionID
orderChanged: (BOOL)  orderChanged 
optional

Callback event when the question is upvoted.

Parameters
questionIDThe question ID.
orderChangedOrder changed.

◆ onSinkWebinarNeedRegister:

- (void) onSinkWebinarNeedRegister: (NSString *_Nonnull)  registerURL
optional

Callback event that a user joins a webinar which requires manual approval.

Parameters
registerURLThe register URL.

◆ onSmartSummaryPrivilegeRequested:handler:

- (void) onSmartSummaryPrivilegeRequested: (NSInteger)  userId
handler: (MobileRTCSmartSummaryPrivilegeHandler *_Nullable)  handler 
optional

Callback event when a user requests the host to start smart summary.

Parameters
userIdThe user who requests the host to start smart summary.
handlerThe handler to handle the smart summary start request.

◆ onSmartSummaryStartReqResponse:decline:

- (void) onSmartSummaryStartReqResponse: (BOOL)  timeout
decline: (BOOL)  isDecline 
optional

Callback event when the host handle the smart summary request.

Parameters
timeouttrue means the host doesn't handle the request until timeout.
isDeclinetrue means the host declines the request, false means the host agrees to the request.

◆ onSmartSummaryStatusChange:

- (void) onSmartSummaryStatusChange: (BOOL)  isStarted
optional

Callback event when smart summary status changes.

Parameters
isStartedtrue means that the smart summary is started. False means it has not.

◆ onSpotlightVideoChange:

- (void) onSpotlightVideoChange: (BOOL)  on
optional

The video status of a spotlit user has changed.

Parameters
onWhether the user's video was turned on.

◆ onSpotlightVideoUserChange:

- (void) onSpotlightVideoUserChange: (NSArray< NSNumber * > *_Nullable)  spotlightedUserList
optional

The list of spotlit users has changed.

Parameters
spotlightedUserListThe users who are currently spotlit.

◆ onStartBOError:

- (void) onStartBOError: (MobileRTCBOControllerError errType
optional

Admin receives an error when breakout room start fails.

Parameters
errTypeThe error type defail of the failure.

◆ onStartCloudRecordingRequested:

- (void) onStartCloudRecordingRequested: (MobileRTCRequestStartCloudRecordingPrivilegeHandler *_Nullable)  handler
optional

Callback event received only by the host when a user requests to start cloud recording.

Parameters
handlerA pointer to the MobileRTCRequestStartCloudRecordingPrivilegeHandler.

◆ onSubscribeUserFail:size:userId:

- (void) onSubscribeUserFail: (MobileRTCSubscribeFailReason errorCode
size: (NSInteger)  size
userId: (NSUInteger)  userId 
optional

The subscription to a user's video has failed.

Parameters
errorCodeThe error code. See {@MobileRTCSubscribeFailReason}.
sizeThe subscription's size.
userIdThe ID of the user whose subscription failed.
Warning
This is only invoked when custom UI mode is enabled.

◆ onSuspendParticipantsActivities

- (void) onSuspendParticipantsActivities
optional

Callback event when a meeting is suspended.

◆ onTalkPrivilegeChanged:

- (void) onTalkPrivilegeChanged: (BOOL)  hasPrivilege
optional

Callback event for the user talk privilege changed. When the interpreter role changed, host changed, host allow or disallow interpreter talk, this will be triggered, and only the sign interpreter itself can get the event.

Parameters
hasPrivilegeSpecify whether the user has talk privilege or not

◆ onUnAssignedUserUpdated

- (void) onUnAssignedUserUpdated
optional

The unassigned user update.

◆ onUpgradeFreeMeetingResult:

- (void) onUpgradeFreeMeetingResult: (NSUInteger)  result
optional

The result of a free meeting upgrade attempt has been received.

Parameters
resultZERO(0) means the upgrade was successful, otherwise it failed.

◆ onUserRawLiveStreamingStatusChanged:

- (void) onUserRawLiveStreamingStatusChanged: (NSArray< MobileRTCRawLiveStreamInfo * > *_Nullable)  liveStreamList
optional

A user has starte or stopped raw live streaming.

Parameters
liveStreamListA list of users with an active raw live stream.

◆ onUserRawLiveStreamPrivilegeChanged:hasPrivilege:

- (void) onUserRawLiveStreamPrivilegeChanged: (NSUInteger)  userId
hasPrivilege: (bool)  hasPrivilege 
optional

Another user’s raw live streaming privilege has changed.

Parameters
userIdThe ID of the user whose privilege has changed.
hasPrivilegeWhether the user has privilege.

◆ onVideoAlphaChannelStatusChanged:

- (void) onVideoAlphaChannelStatusChanged: (BOOL)  alphaChannelOn
optional

Callback event of alpha channel mode changes.

Parameters
alphaChannelOnYES means it's in alpha channel mode. Otherwise, it's not.

◆ onWaitingRoomEntranceEnabled:

- (void) onWaitingRoomEntranceEnabled: (BOOL)  enabled
optional

This callback event will be triggered when host or cohost enables or disables waiting room entrance.

Parameters
enabledTrue means enables waiting room entrance, false means disables waiting room entrance.

◆ onWaitingRoomStatusChange:

- (void) onWaitingRoomStatusChange: (BOOL)  needWaiting
optional

The waiting room status has changed.

◆ onWebinarNeedInputScreenName:

- (void) onWebinarNeedInputScreenName: (MobileRTCWebinarInputScreenNameHandler *_Nullable)  handler
optional

When joining the webinar, this callback is triggered if the user needs to input a username.

Parameters
handlerAn object used by user to complete all the related operations.

◆ onWebPreAssignBODataDownloadStatusChanged:

- (void) onWebPreAssignBODataDownloadStatusChanged: (MobileRTCBOPreAssignBODataStatus status
optional

When the pre-assigned data download status changes, you will receive the event.

Parameters
statusdownload status, for more details, see [MobileRTCBOPreAssignBODataStatus]].

◆ onWhiteboardSettingsChanged:createOption:enable:

- (void) onWhiteboardSettingsChanged: (MobileRTCWhiteboardShareOption shareOption
createOption: (MobileRTCWhiteboardCreateOption createOption
enable: (BOOL)  enable 
optional

Callback event of whiteboard setting type changed.

Parameters
shareOptionWho can share their whiteboard. For more details, see [MobileRTCWhiteboardShareOption]
createOptionWho can create a new whiteboard. For more details, see [MobileRTCWhiteboardCreateOption]
enableWhether enable the participants create whiteboard without host in the meeting.

◆ onWhiteboardStatusChanged:

- (void) onWhiteboardStatusChanged: (MobileRTCWhiteboardStatus status
optional

Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been started or stopped, and all users in the meeting can get the event.

Parameters
statusSpecify current whiteboard status. For more details, see [MobileRTCWhiteboardStatus].
Warning
The function only for Custom UI.

◆ onZoomIdentityExpired

- (void) onZoomIdentityExpired
optional

The ZAK used to authorize the SDK has expired.