<MobileRTCMeetingServiceDelegate> Protocol Reference

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

#include <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)	- onJoinMeetingNeedUserInfo:
	The function is be invoked when a user joins a meeting that needs their username and email.
(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)	- onMeetingFullToWatchLiveStream:
	Calback event that the meeting users have reached the meeting capacity.
(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)	- onMeetingTopicChanged:
	Callback event for the meeting topic changed.
(void)	- onProxyAuth:port:completion:
	The user must provide proxy information.
(void)	- onAskToEndOtherMeeting:
	Callback event when joining a meeting while the meeting is ongoing.
(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)	- onChatMessageEditNotification:
	A chat message is edited.
(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)	- onLiveStreamReminderStatusChanged:
	Callback event when the live stream reminder enable status changed.
(void)	- onLiveStreamReminderStatusChangedFailed
	Callback event when the live stream reminder enable status change failed.
(void)	- onUserThresholdReachedForLiveStream:
	Callback event when the meeting/webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting/webinar capacity.
(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
	Callback event when a meeting is suspended.
(void)	- onAllowParticipantsStartVideoNotification:
	Sink the event that lets participants start a video.
(void)	- onAllowParticipantsRenameNotification:
	Sink the event that lets participants rename them.
(void)	- onAllowParticipantsUnmuteSelfNotification:
	Sink the event that lets participants unmute them.
(void)	- onAllowParticipantsShareWhiteBoardNotification:
	Sink the event that lets participants share a new white board.
(void)	- onAllowParticipantsShareStatusNotification:
	Sink the event that lets participants allow to share.
(void)	- onMeetingLockStatus:
	Sink the event that allow a meeting lock status change.
(void)	- onRequestLocalRecordingPrivilegeChanged:
	Callback event that the request local recording privilege changes.
(void)	- onParticipantProfilePictureStatusChange:
	Sink the event that participant profile status change.
(void)	- onIndicatorItemReceived:
	When new indicator item is received.
(void)	- onIndicatorItemRemoved:
	When the indicator item is removed.
(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)	- onMuteOnEntryStatusChange:
	Callback event for the mute on entry status changed.
(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)	- onActiveSpeakerVideoUserChanged:
	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)	- onFailedToStartShare
	Notification of failure to start sharing.
(void)	- onSinkSharingStatus:
	The share status changes.
(void)	- onShareContentChanged:
	Notification of shared content is changed.
(void)	- onOptimizingShareForVideoClipStatusChanged:
	Designated for the optimize video status have changed.
(void)	- onShareFromMainSession:shareStatus:shareAction:
	You will receive this event when you are in a breakout room, and someone shares from the main session to the breakout room.
(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)	- onStartCaptionsRequestReceived:
	Sink the event to start captions.
(void)	- onStartCaptionsRequestApproved
	Sink the event to start captions was approved.
(void)	- onCaptionStatusChanged:
	Sink the event of captions enabled status changed.
(void)	- onManualCaptionStatusChanged:
	Sink the event of manual captions enable status change.
(void)	- onSinkLiveTranscriptionStatus:
	Sink the event of live transcription status.
(void)	- onLiveTranscriptionMsgInfoReceived:
	live transcription message received callback.
(void)	- onOriginalLanguageMsgReceived:
	original language message received callback.
(void)	- onLiveTranscriptionMsgError:transcriptLanguage:
	Translation message error callback.
(void)	- onSpokenLanguageChanged:
	Callback when the spoken language has changed.
(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)	- onStartBOResponse:
	The callback notification of StartBO.
(void)	- onStopBOResponse:
	The callback notification of StopBO.
(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)	- onCreateBOResponse:BOID:
	The callback notification of CreateBreakoutRoom.
(void)	- onRemoveBOResponse:BOID:
	The callback notification of RemoveBO.
(void)	- onUpdateBONameResponse:BOID:
	The callback notification of UpdateBOName.
(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.
(void)	- onUserConfirmToStartArchive:
	Callback event when join meeting if the admin has set the user can choose to archive the meeting.
(void)	- onUserConfirmRecoverMeeting:
	Callback event when host start a deleted or expired meeting(not PMI meeting).
(void)	- onAICompanionFeatureTurnOffByParticipant:
	Callback the event when the auto start AI Companion feature is turned off by an attendee before the host joins. Only the host or cohost can receive the callback.
(void)	- onAICompanionFeatureSwitchRequested:
	Callback the event when the host receives the request to turn the AI Companion features on or off.
(void)	- onAICompanionFeatureSwitchRequestResponse:agree:turn:
	Callback the event when the host handles the request to turn the AI Companion features on or off.
(void)	- onAICompanionFeatureCanNotBeTurnedOff:
	Callback the event when the started AI Companion feature can't be turned off.
(void)	- onFileSendStart:
	Invoked when start send file.
(void)	- onFileReceived:
	Invoked when receiving a file from another user.
(void)	- onFileTransferProgress:
	Invoked when send or receive file status change.
(void)	- onPSUserStatusChanged:isStart:
	This callback is received when the production studio user starts and stops sending video and audio.
(void)	- onUVCCameraStatusChange:
	Callback is invoked when external UVC camera status changes.
(void)	- onVirtualNameTagStatusChanged:userID:
	Notification of virtual name tag status change.
(void)	- onVirtualNameTagRosterInfoUpdated:
	Notification of virtual name tag roster info update.
(void)	- onBotAuthorizerRelationChanged:
	Callback event that the bot relationship changed in the meeting.
(void)	- onGrantCoOwnerPrivilegeChanged:
	Callback event when the user's grant co-owner permission changed.
(void)	- onDocsStatusChanged:
	Docs status changed callback. This function is used to inform the user docs has been started or stopped, and all users in the meeting can get the event.
(void)	- onDocsPermissionChangedCreateOption:shareOption:
	Callback event of docs share setting type changed.
(void)	- onCompanionRelationChangedParentUserID:childUserID:
	Callback event that the companion relationship created in the meeting.
(void)	- onRemoveCompanionRelation:
	Callback event that the companion relationship removed in the meeting.

Detailed Description

Delegate containing callbacks related to meeting state updates.

Definition at line 53 of file MobileRTCMeetingDelegate.h.

Method Documentation

on3DAvatarItemDataDownloaded:andIndex:

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

optionalrequired

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

Parameters

index	The index of the selected 3D avatar item.
success	Yes indicates the selected 3D avatar item has been downloaded successfully.

on3DAvatarItemDataDownloading:

- (void) on3DAvatarItemDataDownloading: (int) index

optionalrequired

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

Parameters

index

The index of the selected 3D avatar item.

on3DAvatarItemThumbnailsDownloaded

- (void) on3DAvatarItemThumbnailsDownloaded

optionalrequired

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

onActiveSpeakerVideoUserChanged:

- (void) onActiveSpeakerVideoUserChanged: (NSUInteger) userID

optionalrequired

The active video user has changed.

Parameters

userID

The ID of the newly displayed user.

onAICompanionActiveChangeNotice:

- (void) onAICompanionActiveChangeNotice: (BOOL) isActive

optionalrequired

Sink the event that AI Companion active status changed.

Parameters

isActive

YES means the AI Companion is active.

onAICompanionFeatureCanNotBeTurnedOff:

- (void) onAICompanionFeatureCanNotBeTurnedOff: (NSArray< NSNumber * > *_Nullable) featuresArr

optionalrequired

Callback the event when the started AI Companion feature can't be turned off.

Parameters

featuresArr

The AI features that can't be turned off. see MobileRTCAICompanionType.

onAICompanionFeatureSwitchRequested:

- (void) onAICompanionFeatureSwitchRequested: (MobileRTCAICompanionSwitchHandler *_Nullable) handler

optionalrequired

Callback the event when the host receives the request to turn the AI Companion features on or off.

Parameters

handler

Tthe handler to turn the AI Companions features on or off.

onAICompanionFeatureSwitchRequestResponse:agree:turn:

- (void) onAICompanionFeatureSwitchRequestResponse: (BOOL) timeout agree: (BOOL) agree turn: (BOOL) turnOn

optionalrequired

Callback the event when the host handles the request to turn the AI Companion features on or off.

Parameters

timeout	The host will not handle the request until timeout.
agree	the host agrees to the request to turn the AI Companion features on or off.
turnOn	True means the request is to turn the AI Ccompanion features on. False means turn the AI Companion features off.

onAICompanionFeatureTurnOffByParticipant:

- (void) onAICompanionFeatureTurnOffByParticipant: (MobileRTCAICompanionTurnOnAgainHandler *_Nullable) handler

optionalrequired

Callback the event when the auto start AI Companion feature is turned off by an attendee before the host joins. Only the host or cohost can receive the callback.

Parameters

handler

The handler to turn on again the AI feature or leave the feature turned off.

onAllowAskQuestionStatus:

- (void) onAllowAskQuestionStatus: (BOOL) bEnabled

optionalrequired

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

Parameters

bEnabled

Can ask question or not.

onAllowAttendeeRaiseHandStatusChanged:

- (void) onAllowAttendeeRaiseHandStatusChanged: (BOOL) canRaiseHand

optionalrequired

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

Parameters

canRaiseHand

If the raise hand is allowed, the result is YES, otherwise NO.

onAllowAttendeeViewTheParticipantCountStatusChanged:

- (void) onAllowAttendeeViewTheParticipantCountStatusChanged: (BOOL) canViewParticipantCount

optionalrequired

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

Parameters

canViewParticipantCount

If the view participant is allowed, the result is YES, otherwise NO.

onAllowParticipantsRenameNotification:

- (void) onAllowParticipantsRenameNotification: (BOOL) allow

optionalrequired

Sink the event that lets participants rename them.

Parameters

allow

YES allow.If NO,participants may not rename themselves.

onAllowParticipantsRequestCloudRecording:

- (void) onAllowParticipantsRequestCloudRecording: (BOOL) allow

optionalrequired

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

Parameters

allow

True allow. If false, disallow.

onAllowParticipantsShareStatusNotification:

- (void) onAllowParticipantsShareStatusNotification: (BOOL) allow

optionalrequired

Sink the event that lets participants allow to share.

Parameters

allow

YES allow.if NO.participants may not share.

onAllowParticipantsShareWhiteBoardNotification:

- (void) onAllowParticipantsShareWhiteBoardNotification: (BOOL) allow

optionalrequired

Sink the event that lets participants share a new white board.

Parameters

allow

YES allow.if NO.participants may not share new white boards.

onAllowParticipantsStartVideoNotification:

- (void) onAllowParticipantsStartVideoNotification: (BOOL) allow

optionalrequired

Sink the event that lets participants start a video.

Parameters

allow

YES allow. if NO disallow.

onAllowParticipantsUnmuteSelfNotification:

- (void) onAllowParticipantsUnmuteSelfNotification: (BOOL) allow

optionalrequired

Sink the event that lets participants unmute them.

Parameters

allow

YES allow. If NO, participants may not unmute themselves.

onAllowWebinarReactionStatusChanged:

- (void) onAllowWebinarReactionStatusChanged: (BOOL) canReaction

optionalrequired

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

Parameters

canReaction

If the Reaction is allowed, the result is YES, otherwise NO.

onAppShareSplash

- (void) onAppShareSplash

optionalrequired

A meeting starts by sharing.

onAskToEndOtherMeeting:

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

optionalrequired

Callback event when joining a meeting while the meeting is ongoing.

Parameters

completion

Ask the user to end another ongoing meeting.

Warning

Completion(YES) means leave or end current meeting. completion(NO) means end other meeting to continue current join meeting flow.

onAudioOutputChange

- (void) onAudioOutputChange

optionalrequired

The current user's audio output selection has changed.

onAvailableLanguageListUpdated:

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

optionalrequired

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

Parameters

availableLanguageList

Specify the available languages list.

onAvailableSignLanguageListUpdated:

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

optionalrequired

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

Parameters

availableSignLanguageList

Specify the available sign languages list.

onBOCreateSuccess:

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

optionalrequired

Creator receives breakout identifier when successfully creating the breakout room.

Parameters

BOID	The identifier of the created breakout.

Deprecated

Use onCreateBOResponse:BOID: instead.

onBOEndTimerUpdated:isTimesUpNotice:

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

optionalrequired

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

Parameters

remaining	Remaining time.
isTimesUpNotice	true: when time is up, auto stop breakout room. false: don't auto stop breakout room.

onBOInfoUpdated:

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

optionalrequired

The updated breakout meeting information.

Parameters

boId	The identifier for the breakout meeting.

onBOListInfoUpdated

- (void) onBOListInfoUpdated

optionalrequired

The BO list info updated.

onBOOptionChanged:

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

optionalrequired

You will receive the event when the option changes.

Parameters

newOption

new BO Option.

onBOStatusChanged:

- (void) onBOStatusChanged: (MobileRTCBOStatus) status

optionalrequired

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

Parameters

status

The current status of the breakout room.

onBOStopCountDown:

- (void) onBOStopCountDown: (NSUInteger) seconds

optionalrequired

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

Parameters

seconds

The countdown in seconds.

Warning

Please leave the breakout room when the countdown ends.

onBOSwitchRequestReceived:newBOID:

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

optionalrequired

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

Parameters

newBOName	The new brekaout room name.
newBOID	The new breakout room ID.

onBotAuthorizerRelationChanged:

- (void) onBotAuthorizerRelationChanged: (NSUInteger) userID

optionalrequired

Callback event that the bot relationship changed in the meeting.

Parameters

userID

Specify the authorizer user ID.

onBroadcastBOVoiceStatus:

- (void) onBroadcastBOVoiceStatus: (BOOL) bStart

optionalrequired

The status of broadcasting voice to BO has been changed.

Parameters

bStart

YES for host begin broadcasting voice to BO, NO for host stop broadcasting voice to BO.

onCallRoomDeviceStateChanged:

- (void) onCallRoomDeviceStateChanged: (H323CallOutStatus) state

optionalrequired

The room device state changed.

Parameters

state

The new state. See [H323CallOutStatus].

onCameraNoPrivilege

- (void) onCameraNoPrivilege

optionalrequired

Camera access permission was denied.

onCaptionStatusChanged:

- (void) onCaptionStatusChanged: (BOOL) enable

optionalrequired

Sink the event of captions enabled status changed.

Parameters

enable

True means the host enables the captions, otherwise means the host disables the captions.

onChatMessageEditNotification:

- (void) onChatMessageEditNotification: (MobileRTCMeetingChat *_Nullable) chatInfo

optionalrequired

A chat message is edited.

Parameters

chatInfo

The meeting chat information.

onChatMessageNotification:

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

optionalrequired

An in-meeting chat message has been received.

Parameters

chatInfo

The meeting chat information.

onChatMsgDeleteNotification:deleteBy:

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

optionalrequired

A chat message has been deleted.

Parameters

msgID	The ID of the message that was deleted.
deleteBy	Information about who deleted the message. See [MobileRTCChatMessageDeleteType].

onCheckCMRPrivilege:

- (void) onCheckCMRPrivilege: (MobileRTCCMRError) result

optionalrequired

Determine if the current user has cloud recording privileges.

Parameters

result

The result of checking CMR privilege.

Deprecated

Not maintain anymore.

onCheckIfMeetingVoIPCallRunning

- (BOOL) onCheckIfMeetingVoIPCallRunning

optionalrequired

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

optionalrequired

A user claims the host.

onClickedAudioButton:

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

optionalrequired

The audio button in the UI has been clicked.

Parameters

parentVC

Parent 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

optionalrequired

The dial out button has been clicked.

Parameters

parentVC	Parent viewcontroller used to present outgoing call UI.
me	If 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

optionalrequired

The meeting end button has been clicked.

Parameters

parentVC	Parent viewcontroller used to present custom Participants UI.
endButton	The 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

optionalrequired

The invite button in the UI has been clicked.

Parameters

parentVC	Parent 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

optionalrequired

The participants button has been clicked.

Parameters

parentVC

Parent 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

optionalrequired

The share button has been clicked.

Parameters

parentVC

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

Note

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

optionalrequired

The user has clicked the shared screen.

Parameters

parentVC

Parent 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

optionalrequired

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

message	The closed caption text.
speakerID	The ID of the speaker.
msgTime	The time of the close caption.

onCloudRecordingStorageFull:

- (void) onCloudRecordingStorageFull: (long) gracePeriodDate

optionalrequired

An event sink that the cloud recording storage is full.

Parameters

gracePeriodDate

A point in time, in milliseconds in, UTC.

Warning

You can use the cloud recording storage until the gracePeriodDate.

onCompanionRelationChangedParentUserID:childUserID:

- (void) onCompanionRelationChangedParentUserID: (NSUInteger) parentUserID childUserID: (NSUInteger) childUserID

optionalrequired

Callback event that the companion relationship created in the meeting.

Parameters

parentUserID	Specify the parent user ID.
childUserID	Specify the child user ID.

onCreateBOResponse:BOID:

- (void) onCreateBOResponse: (BOOL) success BOID: (NSString *_Nullable) BOID

optionalrequired

The callback notification of CreateBreakoutRoom.

Parameters

success	Indicate whether the creation is actually successful. True indicates success, false indicates failure.
BOID	If the creation is successful, its value is the breakout room's ID, otherwise the value is nil.

onDialOutStatusChanged:

- (void) onDialOutStatusChanged: (DialOutStatus) status

optionalrequired

The status of an outgoing call has changed.

Parameters

status

The new status.

onDocsPermissionChangedCreateOption:shareOption:

- (void) onDocsPermissionChangedCreateOption: (MobileRTCDocsCreateOption) createOption shareOption: (MobileRTCDocsShareOption) shareOption

optionalrequired

Callback event of docs share setting type changed.

Parameters

createOption	Docs who can create new Docs type.
shareOption	Docs who can share type.

onDocsStatusChanged:

- (void) onDocsStatusChanged: (MobileRTCDocSharingSourceInfo *_Nullable) sourceInfo

optionalrequired

Docs status changed callback. This function is used to inform the user docs has been started or stopped, and all users in the meeting can get the event.

Parameters

sourceInfo

docs source info.

onE2EEMeetingSecurityCodeChanged

- (void) onE2EEMeetingSecurityCodeChanged

optionalrequired

This callback will be called when the security code changes.

onEmojiFeedbackCanceled:

- (void) onEmojiFeedbackCanceled: (NSUInteger) userId

optionalrequired

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

userId

Specify the user ID of the emoji feedback sender.

onEmojiFeedbackReceived:feedbackType:

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

optionalrequired

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

Parameters

userId	Specify the user ID of the emoji feedback sender.
type	Specify the type of the received emoji feedback.

onEmojiReactionReceived:reactionType:reactionSkinTone:

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

optionalrequired

Notify receipt of the emoji reaction.

Parameters

userId	The user ID of the send emoji reaction.
type	The send emoji reaction type.
skinTone	The send emoji reaction skintone.

onEmojiReactionReceivedInWebinar:

- (void) onEmojiReactionReceivedInWebinar: (MobileRTCEmojiReactionType) type

optionalrequired

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

Parameters

type	Specify the received reaction's type.

onFailedToStartShare

- (void) onFailedToStartShare

optionalrequired

Notification of failure to start sharing.

onFileReceived:

- (void) onFileReceived: (MobileRTCFileReceiver *_Nullable) receiver

optionalrequired

Invoked when receiving a file from another user.

Parameters

receiver

The class to receive file object.

onFileSendStart:

- (void) onFileSendStart: (MobileRTCFileSender *_Nullable) sender

optionalrequired

Invoked when start send file.

Parameters

sender

The class to sendfile object.

onFileTransferProgress:

- (void) onFileTransferProgress: (MobileRTCFileTransferInfo *_Nullable) info

optionalrequired

Invoked when send or receive file status change.

Parameters

info	The class to basic transfer information.

onFocusModeShareTypeChanged:

- (void) onFocusModeShareTypeChanged: (MobileRTCFocusModeShareType) shareType

optionalrequired

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

Parameters

shareType

share type change.

onFocusModeStateChanged:

- (void) onFocusModeStateChanged: (BOOL) on

optionalrequired

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

Parameters

on	YES means the focus mode on.

onFollowHostVideoOrderChanged:

- (void) onFollowHostVideoOrderChanged: (BOOL) follow

optionalrequired

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

Parameters

follow

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

onFreeMeetingNeedToUpgrade:giftUpgradeURL:

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

optionalrequired

The free meeting needs an upgrade.

Parameters

type	See [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.
giftURL	The URL through which the meeting can be upgraded.

onFreeMeetingUpgradedToProMeeting

- (void) onFreeMeetingUpgradedToProMeeting

optionalrequired

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

onFreeMeetingUpgradeToGiftFreeTrialStart

- (void) onFreeMeetingUpgradeToGiftFreeTrialStart

optionalrequired

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

onFreeMeetingUpgradeToGiftFreeTrialStop

- (void) onFreeMeetingUpgradeToGiftFreeTrialStop

optionalrequired

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

onGetRightAnswerListPrivilege:

- (void) onGetRightAnswerListPrivilege: (BOOL) bCan

optionalrequired

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

Parameters

bCan	Specify whether the user has get right answer list privilege or not.

onGrantCoOwnerPrivilegeChanged:

- (void) onGrantCoOwnerPrivilegeChanged: (BOOL) canGrantOther

optionalrequired

Callback event when the user's grant co-owner permission changed.

Parameters

canGrantOther

true means can grant others,otherwise not.

onHasAdminRightsNotification:

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

optionalrequired

Notify that the admin role is given.

Parameters

admin

The admin role is given.

onHasAssistantRightsNotification:

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

optionalrequired

Notify that the assistant role is given.

Parameters

assistant

The assistant role is given.

onHasAttendeeRightsNotification:

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

optionalrequired

Notify that the attendee role is given.

Parameters

attendee

The attendee role is given.

onHasCreatorRightsNotification:

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

optionalrequired

Notify that the creator role is given.

Parameters

creator

the creator role is given.

onHasDataHelperRightsNotification:

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

optionalrequired

Notify that the data helper role is given.

Parameters

dataHelper

The data helper role is given.

onHelpRequestHandleResultReceived:

- (void) onHelpRequestHandleResultReceived: (MobileRTCBOHelpReply) eResult

optionalrequired

Receive the result of sending a help request.

Parameters

eResult

The response result for the help request.

onHelpRequestReceived:

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

optionalrequired

Admin receives help request from userID.

Parameters

strUserID

The identifier of the breakout room meeting user.

onHostInviteReturnToMainSession:replyHandler:

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

optionalrequired

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

Parameters

hostName	the host name.
replyHandler	the handler to reply for the main session invitation.

onHostJoinedThisBOMeeting

- (void) onHostJoinedThisBOMeeting

optionalrequired

The host joins the current breakout meeting.

onHostLeaveThisBOMeeting

- (void) onHostLeaveThisBOMeeting

optionalrequired

The host leaves the current breakout meeting.

onHostVideoOrderUpdated:

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

optionalrequired

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

Parameters

orderArr

The updated order of user videos.

Warning

This callback is only invoked if the host has enabled the "Follow Host's Video Order" setting.

onIndicatorItemReceived:

- (void) onIndicatorItemReceived: (MobileRTCIndicatorHandler *_Nullable) inMeetingIndicatorHandler

optionalrequired

When new indicator item is received.

Parameters

inMeetingIndicatorHandler

the handle to show/hide the indicator panel.

onIndicatorItemRemoved:

- (void) onIndicatorItemRemoved: (MobileRTCIndicatorHandler *_Nullable) inMeetingIndicatorHandler

optionalrequired

When the indicator item is removed.

Parameters

inMeetingIndicatorHandler

the handle will be removed, should not be used anymore.

onInMeetingUserAvatarPathUpdated:

- (void) onInMeetingUserAvatarPathUpdated: (NSInteger) userID

optionalrequired

The user avatar path is updated in the meeting.

onInMeetingUserUpdated

- (void) onInMeetingUserUpdated

optionalrequired

The user state is updated in the meeting.

Deprecated

Will delete later, if you need this API, please contact us.

onInterpretationStart

- (void) onInterpretationStart

optionalrequired

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

onInterpretationStop

- (void) onInterpretationStop

optionalrequired

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

optionalrequired

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

Parameters

userID	Specify the user ID whose active language changed.
activeLanID	Specify the interpreter current active language ID.

onInterpreterLanguageChanged:andLanguage2:

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

optionalrequired

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

Parameters

lanID1	Specify the new language ID1.
lanID2	Specify the new language ID2.

onInterpreterLanguagesUpdated:

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

optionalrequired

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

availableLanguages

The list of available languages that interpreters can hear.

onInterpreterListChanged

- (void) onInterpreterListChanged

optionalrequired

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

optionalrequired

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

Parameters

userID	Specify the user ID whose status changed.
isInterpreter	Specify if user's role is interpreter or not.

onJBHWaitingWithCmd:

- (void) onJBHWaitingWithCmd: (JBHCmd) cmd

optionalrequired

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

Parameters

cmd	Show/Hide JBH command.

onJoinMeetingConfirmed

- (void) onJoinMeetingConfirmed

optionalrequired

The meeting has been joined successfully.

onJoinMeetingInfo:completion:

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

optionalrequired

The user must provide additional information before joining the meeting.

Parameters

info	the information need for join meeting.
completion	the block for input the information.

Note

DisplayName A name to be displayed in the meeting, password The meeting passcode, cancel If YES, the attempt to join the meeting is cancelled.

onJoinMeetingNeedUserInfo:

- (void) onJoinMeetingNeedUserInfo: (MobileRTCInputUserInfoHandler *_Nullable) handler

optionalrequired

The function is be invoked when a user joins a meeting that needs their username and email.

Parameters

handler

Configure information or leave meeting, see [MobileRTCInputUserInfoHandler].

onLiveStreamReminderStatusChanged:

- (void) onLiveStreamReminderStatusChanged: (BOOL) enable

optionalrequired

Callback event when the live stream reminder enable status changed.

Parameters

enable

true means the live stream reminder is enabled.

onLiveStreamReminderStatusChangedFailed

- (void) onLiveStreamReminderStatusChangedFailed

optionalrequired

Callback event when the live stream reminder enable status change failed.

onLiveStreamStatusChange:

- (void) onLiveStreamStatusChange: (MobileRTCLiveStreamStatus) liveStreamStatus

optionalrequired

The live stream status has changed.

Parameters

liveStreamStatus

The new status. See [MobileRTCLiveStreamStatus].

onLiveTranscriptionMsgError:transcriptLanguage:

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

optionalrequired

Translation message error callback.

Parameters

speakLanguage	an object of the speak message language.
transcriptLanguage	an object of the message language you want to translate.

onLiveTranscriptionMsgInfoReceived:

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

optionalrequired

live transcription message received callback.

Parameters

messageInfo

The live transcription message.

onLocalRecordingStatus:status:

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

optionalrequired

The local recording status has changed.

Parameters

userId	The ID of the user who caused the change.
status	The new recording status.

onLocalVideoOrderUpdated:

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

optionalrequired

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

Parameters

localOrderArr

The updated order of user videos.

onLostAdminRightsNotification

- (void) onLostAdminRightsNotification

optionalrequired

A lost admin role notification.

onLostAssistantRightsNotification

- (void) onLostAssistantRightsNotification

optionalrequired

A lost assistant role notification.

onLostAttendeeRightsNotification

- (void) onLostAttendeeRightsNotification

optionalrequired

A lost attendee role notification.

onLostCreatorRightsNotification

- (void) onLostCreatorRightsNotification

optionalrequired

A lost creator role notification.

onLostDataHelperRightsNotification

- (void) onLostDataHelperRightsNotification

optionalrequired

A lost data helper role notification.

onManualCaptionStatusChanged:

- (void) onManualCaptionStatusChanged: (BOOL) bEnabled

optionalrequired

Sink the event of manual captions enable status change.

Parameters

bEnabled

True means the host enable the manual captions, otherwise, the host disable the manual captions.

onMeetingCoHostChange:isCoHost:

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

optionalrequired

The meeting co-host changes.

Parameters

userID	The new co-host's user ID.
isCoHost	Indicates the user (userID) be assigned to co-host or be remove co-host.

onMeetingEndedReason:

- (void) onMeetingEndedReason: (MobileRTCMeetingEndReason) reason

optionalrequired

The meeting has ended.

Parameters

reason

The reason why the meeting has ended. See [MobileRTCMeetingEndReason].

onMeetingError:message:

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

optional

An error has occurred.

Parameters

error	The error code. See [MobileRTCMeetError].
message	The message of the error.

onMeetingFullToWatchLiveStream:

- (void) onMeetingFullToWatchLiveStream: (NSString *_Nonnull) liveStreamUrl

optionalrequired

Calback event that the meeting users have reached the meeting capacity.

Parameters

liveStreamUrl

the live stream URL towatch the meeting live stream.

Note

The new join user can not join meeting, but they can watch the meeting live stream.

onMeetingHostChange:

- (void) onMeetingHostChange: (NSUInteger) hostId

optionalrequired

The meeting host changes.

Parameters

hostId

The new host's user ID.

onMeetingLockStatus:

- (void) onMeetingLockStatus: (BOOL) isLock

optionalrequired

Sink the event that allow a meeting lock status change.

Parameters

isLock

YES, the status is locked. If NO, the status is unlocked.

onMeetingParameterNotification:

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

optionalrequired

The meeting parameters have been updated.

Parameters

meetingParam

meetingParam Meeting parameter. See [MobileRTCMeetingParameter].

onMeetingQAStatusChanged:

- (void) onMeetingQAStatusChanged: (BOOL) isMeetingQAFeatureOn

optionalrequired

Callback event of meeting QA feature status changes.

Parameters

isMeetingQAFeatureOn

YES means meeting QA feature is on, otherwise not.

onMeetingReady

- (void) onMeetingReady

optionalrequired

The meeting is ready.

onMeetingStateChange:

- (void) onMeetingStateChange: (MobileRTCMeetingState) state

optionalrequired

Notify the user that the meeting state has changed.

Parameters

state

The new meeting state. [MobileRTCMeetingState].

onMeetingTopicChanged:

- (void) onMeetingTopicChanged: (NSString *_Nullable) meetingTopic

optionalrequired

Callback event for the meeting topic changed.

Parameters

meetingTopic

The new meeting topic.

onMicrophoneNoPrivilege

- (void) onMicrophoneNoPrivilege

optionalrequired

Microphone access permission was denied.

onMicrophoneStatusError:

- (void) onMicrophoneStatusError: (MobileRTCMicrophoneError) error

optionalrequired

The user's microphone has encountered an error.

Parameters

error

The error. See [MobileRTCMicropohoneError].

onMuteOnEntryStatusChange:

- (void) onMuteOnEntryStatusChange: (BOOL) bEnabled

optionalrequired

Callback event for the mute on entry status changed.

Parameters

bEnabled

Specify whether the mute on entry is enabled or not.

onMyAudioStateChange

- (void) onMyAudioStateChange

optionalrequired

The current user's audio state has changed.

onMyHandStateChange

- (void) onMyHandStateChange

optionalrequired

The current user's hand state changes.

Deprecated

Not maintain anymore,Use onSinkMeetingUserRaiseHand or onSinkMeetingUserLowerHand instead.

onMyVideoStateChange

- (void) onMyVideoStateChange

optionalrequired

The current user's video status has changed.

onNewBroadcastMessageReceived:senderID:senderName:

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

optionalrequired

A broadcast message notification.

Parameters

broadcastMsg	The broadcast message received from host.
senderID	The senderID.
senderName	The sender Name.

onNoHostMeetingWillTerminate:

- (void) onNoHostMeetingWillTerminate: (NSUInteger) minutes

optionalrequired

The meeting does not have a host and ends.

Parameters

minutes

The minutes remaining until the meeting ends.

onOngoingShareStopped

- (void) onOngoingShareStopped

optionalrequired

All active shares have stopped.

onOptimizingShareForVideoClipStatusChanged:

- (void) onOptimizingShareForVideoClipStatusChanged: (MobileRTCSSharingSourceInfo *_Nonnull) shareInfo

optionalrequired

Designated for the optimize video status have changed.

Parameters

shareInfo

The share source info that has changed.

onOriginalLanguageMsgReceived:

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

optionalrequired

original language message received callback.

Parameters

messageInfo

The spoken language message.

onParticipantProfilePictureStatusChange:

- (void) onParticipantProfilePictureStatusChange: (BOOL) hidden

optionalrequired

Sink the event that participant profile status change.

Parameters

hidden

true 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

optionalrequired

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

Parameters

actionType	Specify the action type.
pollingID	Specify the action poll's ID.
bSuccess	Specify whether the action succeeds.
errorMsg	Specify 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

optionalrequired

Polling elapsed time callback.

Parameters

pollingID	Specify the polling question's ID.
uElapsedtime	Specify 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

optionalrequired

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

optionalrequired

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

optionalrequired

Polling question item image downloaded callback.

Parameters

questionID	Specify the polling question's ID.
path	Specify 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

optionalrequired

Polling result updated callback. When a participant submits polling.

Parameters

pollingID

Specify the result updated poll's ID.

onPollingStatusChanged:status:

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

optionalrequired

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

Parameters

pollingID	Specify the status changed poll's ID.
status	Specify current polling status.

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

optionalrequired

The user must provide proxy information.

Parameters

host	Proxy host.
port	Proxy port.
completion	The SDK asks the user to input proxy information once it detects that the information changed.

onPSUserStatusChanged:isStart:

- (void) onPSUserStatusChanged: (NSUInteger) userId isStart: (BOOL) isStart

optionalrequired

This callback is received when the production studio user starts and stops sending video and audio.

Parameters

userId	the production studio user's user ID.
isStart	YES means that means the production studio user starts sending video and audio. NO means the production studio user stopped sending video.

onRawLiveStreamPrivilegeChanged:

- (void) onRawLiveStreamPrivilegeChanged: (BOOL) hasPrivilege

optionalrequired

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

Parameters

hasPrivilege

Whether the user has privilege.

onRawLiveStreamPrivilegeRequested:

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

optionalrequired

A user has requested raw live streaming privilege.

Parameters

handler

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

onRawLiveStreamPrivilegeRequestTimeout

- (void) onRawLiveStreamPrivilegeRequestTimeout

optionalrequired

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

onRecordingStatus:

- (void) onRecordingStatus: (MobileRTCRecordingStatus) status

optionalrequired

The cloud recording status has changed.

Parameters

status

The new recording status.

onRemoveBOResponse:BOID:

- (void) onRemoveBOResponse: (BOOL) success BOID: (NSString *_Nullable) BOID

optionalrequired

The callback notification of RemoveBO.

Parameters

success	Indicates whether the removal was actually successful. YES indicates success, NO indicates failure.
BOID	Identifies which breakout room is being removed.

onRemoveCompanionRelation:

- (void) onRemoveCompanionRelation: (NSUInteger) childUserID

optionalrequired

Callback event that the companion relationship removed in the meeting.

Parameters

childUserID

Specify the child user ID.

onRequestCloudRecordingResponse:

- (void) onRequestCloudRecordingResponse: (MobileRTCRequestStartCloudRecordingStatus) status

optionalrequired

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

Parameters

status

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

onRequestLocalRecordingPrivilegeChanged:

- (void) onRequestLocalRecordingPrivilegeChanged: (MobileRTCLocalRecordingRequestPrivilegeStatus) status

optionalrequired

Callback event that the request local recording privilege changes.

Parameters

status

Value of request local recording privilege status.

onRequestLocalRecordingPrivilegeReceived:

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

optionalrequired

Callback when host received the local recording request from participant.

Parameters

handler

the host admit or decline the request through this handler.

onRequestSignInterpreterToTalk

- (void) onRequestSignInterpreterToTalk

optionalrequired

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

optionalrequired

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

Parameters

state	The new paring state. See [MobileRTCH323ParingStatus].
meetingNumber	The meetng number.

onShareContentChanged:

- (void) onShareContentChanged: (MobileRTCSSharingSourceInfo *_Nonnull) shareInfo

optionalrequired

Notification of shared content is changed.

Parameters

shareInfo

The shared content.

onShareFromMainSession:shareStatus:shareAction:

- (void) onShareFromMainSession: (NSUInteger) sharingID shareStatus: (MobileRTCSharingStatus) status shareAction: (MobileRTCShareAction *_Nullable) shareAction

optionalrequired

You will receive this event when you are in a breakout room, and someone shares from the main session to the breakout room.

Parameters

sharingID	The sharing ID.
status	The sharing status.
shareAction	The pointer of share action object.

onSignInterpretationStatusChange:

- (void) onSignInterpretationStatusChange: (MobileRTCSignInterpretationStatus) status

optionalrequired

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

status

Specify current sign interpretation status.

onSignInterpreterLanguageChanged

- (void) onSignInterpreterLanguageChanged

optionalrequired

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

onSignInterpreterListChanged

- (void) onSignInterpreterListChanged

optionalrequired

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

optionalrequired

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

onSinkAllowAttendeeChatNotification:

- (void) onSinkAllowAttendeeChatNotification: (MobileRTCChatAllowAttendeeChat) currentPrivilege

optionalrequired

Invoke this function when the chat privilege of attendees changes.

Parameters

currentPrivilege

The chat privilege of the current attendee.

Warning

Only webinar meeting can get the callback.

onSinkAttendeeChatPriviledgeChanged:

- (void) onSinkAttendeeChatPriviledgeChanged: (MobileRTCMeetingChatPriviledgeType) currentPrivilege

optionalrequired

The chat privilege of attendees has changed.

Parameters

currentPrivilege

The 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

optionalrequired

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

Parameters

agree	If attendee agrees, return true. Otherwise, return false.
userId	The attendee user ID.

onSinkDeleteAnswer:

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

optionalrequired

Callback event when an answer is deleted.

Parameters

answerIDArray

The answer IDs.

onSinkDeleteQuestion:

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

optionalrequired

Callback event when a question is deleted.

Parameters

questionIDArray

The question IDs.

onSinkDePromptPanelist2AttendeeResult:

- (void) onSinkDePromptPanelist2AttendeeResult: (MobileRTCWebinarPromoteorDepromoteError) errorCode

optionalrequired

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

Parameters

errorCode

Demotion successful or error type.

Warning

Only meeting host/co-host can get the callback.

onSinkJoin3rdPartyTelephonyAudio:

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

optionalrequired

Callback event that requests to join third party telephony audio.

Parameters

audioInfo

Instruction on how to join the meeting with third party audio.

onSinkJoinWebinarNeedUserNameAndEmailWithCompletion:

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

optionalrequired

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

Parameters

completion

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

onSinkLiveTranscriptionStatus:

- (void) onSinkLiveTranscriptionStatus: (MobileRTCLiveTranscriptionStatus) status

optionalrequired

Sink the event of live transcription status.

Parameters

status

The live transcription status. For more details, see MobileRTCLiveTranscriptionStatus.

onSinkLowerAllHands

- (void) onSinkLowerAllHands

optionalrequired

A host or cohost lowers all hands.

onSinkMeetingActiveVideo:

- (void) onSinkMeetingActiveVideo: (NSUInteger) userID

optionalrequired

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

Parameters

userID

The ID of user whose video is being displayed.

onSinkMeetingActiveVideoForDeck:

- (void) onSinkMeetingActiveVideoForDeck: (NSUInteger) userID

optionalrequired

The active video user has changed.

Parameters

userID

The ID of the newly displayed user.

Deprecated

Use onActiveSpeakerVideoUserChanged: instead.

onSinkMeetingAudioRequestUnmuteByHost

- (void) onSinkMeetingAudioRequestUnmuteByHost

optionalrequired

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

onSinkMeetingAudioStatusChange:

- (void) onSinkMeetingAudioStatusChange: (NSUInteger) userID

optionalrequired

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

Parameters

userID

The ID of user whose audio status has changed.

onSinkMeetingAudioStatusChange:audioStatus:

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

optionalrequired

A user's audio status has changed.

Parameters

userID	The ID of the user whose audio status has changed.
audioStatus	The new audio status of the user.

onSinkMeetingAudioTypeChange:

- (void) onSinkMeetingAudioTypeChange: (NSUInteger) userID

optionalrequired

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

Parameters

UserID

The ID of user whose audio type changes.

onSinkMeetingMyAudioTypeChange

- (void) onSinkMeetingMyAudioTypeChange

optionalrequired

The audio type of the current user has changed.

onSinkMeetingPreviewStopped

- (void) onSinkMeetingPreviewStopped

optionalrequired

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

optionalrequired

The meeting UI has been minimized or returned to fullscreen.

Parameters

state

The 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

optionalrequired

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

Parameters

userID

The ID of the user who joins the meeting.

onSinkMeetingUserLeft:

- (void) onSinkMeetingUserLeft: (NSUInteger) userID

optionalrequired

Callback event of notification of user who leaves the meeting.

Parameters

userID

The ID of the user who leaves the meeting.

onSinkMeetingUserLowerHand:

- (void) onSinkMeetingUserLowerHand: (NSUInteger) userID

optionalrequired

A user lowers their hand.

Parameters

userID

The ID of the user who lowers their hand.

onSinkMeetingUserRaiseHand:

- (void) onSinkMeetingUserRaiseHand: (NSUInteger) userID

optionalrequired

A user raises their hand.

Parameters

userID

The ID of the user who raises their hand.

onSinkMeetingVideoQualityChanged:userID:

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

optionalrequired

The video quality of a user has changed.

Parameters

qality	The user's new video quality.
userID	The ID of the user whose video quality has changed.

onSinkMeetingVideoRequestUnmuteByHost:

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

optionalrequired

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

onSinkMeetingVideoStatusChange:

- (void) onSinkMeetingVideoStatusChange: (NSUInteger) userID

optionalrequired

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

userID

The ID of the user whose video status has changed.

onSinkMeetingVideoStatusChange:videoStatus:

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

optionalrequired

A participant's video status has changed.

Parameters

userID	The ID of the user whose video status has changed.
videoStatus	The new video status of the user.

onSinkPanelistCapacityExceed

- (void) onSinkPanelistCapacityExceed

optionalrequired

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

onSinkPanelistChatPrivilegeChanged:

- (void) onSinkPanelistChatPrivilegeChanged: (MobileRTCPanelistChatPrivilegeType) privilege

optionalrequired

The chat privilege of panelists has changed.

Parameters

privilege

The new chat privilege. See [MobileRTCPanelistChatPrivilegeType].

Warning

This callback is only invoked for webinars and not meetings.

onSinkPromptAttendee2PanelistResult:

- (void) onSinkPromptAttendee2PanelistResult: (MobileRTCWebinarPromoteorDepromoteError) errorCode

optionalrequired

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

Parameters

errorCode

Promotion 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

optionalrequired

Callback event when adding a new answer.

Parameters

answerID	The answer user ID.
success	Successful or not.

onSinkQAAddQuestion:success:

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

optionalrequired

Callback event when adding a new question.

Parameters

questionID	The question ID.
success	Successful or not.

onSinkQAAllowAskQuestionAnonymouslyNotification:

- (void) onSinkQAAllowAskQuestionAnonymouslyNotification: (BOOL) beAllowed

optionalrequired

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

Parameters

beAllowed

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

onSinkQAAllowAttendeeAnswerQuestionNotification:

- (void) onSinkQAAllowAttendeeAnswerQuestionNotification: (BOOL) beAllowed

optionalrequired

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

Parameters

beAllowed

YES means that user can answer questions. Otherwise, they cannot.

onSinkQAAllowAttendeeUpVoteQuestionNotification:

- (void) onSinkQAAllowAttendeeUpVoteQuestionNotification: (BOOL) beAllowed

optionalrequired

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

Parameters

beAllowed

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

onSinkQAAllowAttendeeViewAllQuestionNotification:

- (void) onSinkQAAllowAttendeeViewAllQuestionNotification: (BOOL) beAllowed

optionalrequired

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

Parameters

beAllowed

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

onSinkQAConnected:

- (void) onSinkQAConnected: (BOOL) connected

optionalrequired

Callback event when Q&A is connected or disconnected.

Parameters

connected

The flag of Q&A is connected ordisconnected.

onSinkQAConnectStarted

- (void) onSinkQAConnectStarted

optionalrequired

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

onSinkQAOpenQuestionChanged:

- (void) onSinkQAOpenQuestionChanged: (NSInteger) count

optionalrequired

Callback event when the open-ended question changes.

Parameters

count

The count of open-ended questions.

onSinkQuestionMarkedAsDismissed:

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

optionalrequired

Callback event when a new question is marked as dismissed.

Parameters

questionID

The question ID.

onSinkReceiveAnswer:

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

optionalrequired

Callback event when a new answer is received.

Parameters

answerID

The question ID.

onSinkReceiveQuestion:

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

optionalrequired

Callback event when a new question is received.

Parameters

questionID

The question ID.

onSinkReopenQuestion:

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

optionalrequired

Callback event when a question is opened.

Parameters

questionID

The question ID.

onSinkRequestForLiveTranscriptReceived:bAnonymous:

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

optionalrequired

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

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

onSinkRevokeVoteupQuestion:orderChanged:

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

optionalrequired

Callback event when the question upvote is revoked.

Parameters

questionID	The question ID.
orderChanged	Order changed.

onSinkSelfAllowTalkNotification

- (void) onSinkSelfAllowTalkNotification

optionalrequired

Invoke this function when the attendee is allowed to talk.

onSinkSelfDisallowTalkNotification

- (void) onSinkSelfDisallowTalkNotification

optionalrequired

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

onSinkShareSettingTypeChanged:

- (void) onSinkShareSettingTypeChanged: (MobileRTCShareSettingType) shareSettingType

optionalrequired

The sharing settings change.

Parameters

shareSettingType

The share setting type of current meeting.

onSinkShareSizeChange:

- (void) onSinkShareSizeChange: (NSUInteger) userID

optionalrequired

The presenter resizes the sharing content.

Parameters

userID

New size of the shared content and user ID.

onSinkSharingStatus:

- (void) onSinkSharingStatus: (MobileRTCSSharingSourceInfo *_Nonnull) shareInfo

optionalrequired

The share status changes.

Parameters

shareInfo

Sharing status.

onSinkUserEndLiving:

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

optionalrequired

Callback event when the question live reply ends.

Parameters

questionID

The question ID.

onSinkUserLivingReply:

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

optionalrequired

Callback event when the question is replied to live.

Parameters

questionID

The question ID.

onSinkUserNameChanged:

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

optionalrequired

A user changes their screen name.

Parameters

userNameChangedArr

The 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

optionalrequired

Callback event when the question is upvoted.

Parameters

questionID	The question ID.
orderChanged	Order changed.

onSinkWebinarNeedRegister:

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

optionalrequired

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

Parameters

registerURL

The register URL.

onSmartSummaryPrivilegeRequested:handler:

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

optionalrequired

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

Parameters

userId	The user who requests the host to start smart summary.
handler	The handler to handle the smart summary start request.

Deprecated

Use MobileRTCAICompanionSmartSummaryHelperDelegate instead.

onSmartSummaryStartReqResponse:decline:

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

optionalrequired

Callback event when the host handle the smart summary request.

Parameters

timeout	true means the host doesn't handle the request until timeout.
isDecline	true means the host declines the request, false means the host agrees to the request.

Deprecated

Use MobileRTCAICompanionSmartSummaryHelperDelegate instead.

onSmartSummaryStatusChange:

- (void) onSmartSummaryStatusChange: (BOOL) isStarted

optionalrequired

Callback event when smart summary status changes.

Parameters

isStarted

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

Deprecated

Use MobileRTCAICompanionSmartSummaryHelperDelegate instead.

onSpokenLanguageChanged:

- (void) onSpokenLanguageChanged: (MobileRTCLiveTranscriptionLanguage *_Nullable) spokenLanguage

optionalrequired

Callback when the spoken language has changed.

Parameters

spokenLanguage

The spoken message language.

onSpotlightVideoChange:

- (void) onSpotlightVideoChange: (BOOL) on

optionalrequired

The video status of a spotlit user has changed.

Parameters

on	Whether the user's video was turned on.

onSpotlightVideoUserChange:

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

optionalrequired

The list of spotlit users has changed.

Parameters

spotlightedUserList

The users who are currently spotlit.

onStartBOError:

- (void) onStartBOError: (MobileRTCBOControllerError) errType

optionalrequired

Admin receives an error when breakout room start fails.

Parameters

errType

The error type defail of the failure.

onStartBOResponse:

- (void) onStartBOResponse: (BOOL) success

optionalrequired

The callback notification of StartBO.

Parameters

success

Indicates whether the startup is actually successful. YES indicates success, and NO indicates failure.

onStartCaptionsRequestApproved

- (void) onStartCaptionsRequestApproved

optionalrequired

Sink the event to start captions was approved.

onStartCaptionsRequestReceived:

- (void) onStartCaptionsRequestReceived: (MobileRTCCaptionsControlHandler *_Nullable) handler

optionalrequired

Sink the event to start captions.

Parameters

handler

The helper to handle the start captions.

onStartCloudRecordingRequested:

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

optionalrequired

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

Parameters

handler

A pointer to the MobileRTCRequestStartCloudRecordingPrivilegeHandler.

onStopBOResponse:

- (void) onStopBOResponse: (BOOL) success

optionalrequired

The callback notification of StopBO.

Parameters

success

Indicates whether the stop is actually successful. True indicates success, and false indicates failure.

onSubscribeUserFail:size:userId:

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

optionalrequired

The subscription to a user's video has failed.

Parameters

errorCode	The error code. See {@MobileRTCSubscribeFailReason}.
size	The subscription's size.
userId	The ID of the user whose subscription failed.

Warning

This is only invoked when custom UI mode is enabled.

onSuspendParticipantsActivities

- (void) onSuspendParticipantsActivities

optionalrequired

Callback event when a meeting is suspended.

onTalkPrivilegeChanged:

- (void) onTalkPrivilegeChanged: (BOOL) hasPrivilege

optionalrequired

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

hasPrivilege

Specify whether the user has talk privilege or not.

onUnAssignedUserUpdated

- (void) onUnAssignedUserUpdated

optionalrequired

The unassigned user update.

onUpdateBONameResponse:BOID:

- (void) onUpdateBONameResponse: (BOOL) success BOID: (NSString *_Nullable) BOID

optionalrequired

The callback notification of UpdateBOName.

Parameters

success	Indicates whether the update was actually successful. YES indicates success, NO indicates failure.
BOID	Identifies which breakout room is being updated.

onUpgradeFreeMeetingResult:

- (void) onUpgradeFreeMeetingResult: (NSUInteger) result

optionalrequired

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

Parameters

result

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

onUserConfirmRecoverMeeting:

- (void) onUserConfirmRecoverMeeting: (MobileRTCRecoverMeetingHandle *_Nullable) handler

optionalrequired

Callback event when host start a deleted or expired meeting(not PMI meeting).

Parameters

handler

The handler for the host user to handle recover or not.

onUserConfirmToStartArchive:

- (void) onUserConfirmToStartArchive: (MobileRTCArchiveConfrimHandle *_Nullable) handler

optionalrequired

Callback event when join meeting if the admin has set the user can choose to archive the meeting.

Parameters

handler

the handler for the user to choose whether archive the meeting when join the meeting.

onUserRawLiveStreamingStatusChanged:

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

optionalrequired

A user has starte or stopped raw live streaming.

Parameters

liveStreamList

A list of users with an active raw live stream.

onUserRawLiveStreamPrivilegeChanged:hasPrivilege:

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

optionalrequired

Another user’s raw live streaming privilege has changed.

Parameters

userId	The ID of the user whose privilege has changed.
hasPrivilege	Whether the user has privilege.

onUserThresholdReachedForLiveStream:

- (void) onUserThresholdReachedForLiveStream: (NSUInteger) percent

optionalrequired

Callback event when the meeting/webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting/webinar capacity.

Parameters

percent

proportion of joined users to the total capacity.

Note

The host can start live stream to let unjoined users watch live stream.

onUVCCameraStatusChange:

- (void) onUVCCameraStatusChange: (MobileRTCUVCCameraStatus) status

optionalrequired

Callback is invoked when external UVC camera status changes.

Parameters

status

UVC camera status.

Warning

Only iOS 17.0 or above and iPad device can receive this callback.

onVideoAlphaChannelStatusChanged:

- (void) onVideoAlphaChannelStatusChanged: (BOOL) alphaChannelOn

optionalrequired

Callback event of alpha channel mode changes.

Parameters

alphaChannelOn

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

onVirtualNameTagRosterInfoUpdated:

- (void) onVirtualNameTagRosterInfoUpdated: (NSUInteger) userID

optionalrequired

Notification of virtual name tag roster info update.

Parameters

userID

The ID of user who virtual name tag status change.

onVirtualNameTagStatusChanged:userID:

- (void) onVirtualNameTagStatusChanged: (BOOL) bOn userID: (NSUInteger) userID

optionalrequired

Notification of virtual name tag status change.

Parameters

bOn	YES means virtual name tag is turn on. Otherwise not.
userID	The ID of user who virtual name tag status change.

onWaitingRoomEntranceEnabled:

- (void) onWaitingRoomEntranceEnabled: (BOOL) enabled

optionalrequired

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

Parameters

enabled

True means enables waiting room entrance, false means disables waiting room entrance.

onWaitingRoomStatusChange:

- (void) onWaitingRoomStatusChange: (BOOL) needWaiting

optionalrequired

The waiting room status has changed.

onWebinarNeedInputScreenName:

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

optionalrequired

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

Parameters

handler

An object used by user to complete all the related operations.

onWebPreAssignBODataDownloadStatusChanged:

- (void) onWebPreAssignBODataDownloadStatusChanged: (MobileRTCBOPreAssignBODataStatus) status

optionalrequired

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

Parameters

status

download status, for more details, see [MobileRTCBOPreAssignBODataStatus]].

onWhiteboardSettingsChanged:createOption:enable:

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

optionalrequired

Callback event of whiteboard setting type changed.

Parameters

shareOption	Who can share their whiteboard. For more details, see [MobileRTCWhiteboardShareOption].
createOption	Who can create a new whiteboard. For more details, see [MobileRTCWhiteboardCreateOption].
enable	Whether enable the participants create whiteboard without host in the meeting.

onWhiteboardStatusChanged:

- (void) onWhiteboardStatusChanged: (MobileRTCWhiteboardStatus) status

optionalrequired

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

status

Specify current whiteboard status. For more details, see [MobileRTCWhiteboardStatus].

Warning

The function only for Custom UI.

onZoomIdentityExpired

- (void) onZoomIdentityExpired

optionalrequired

The ZAK used to authorize the SDK has expired.