Meeting SDK for iOS API Reference
|
Delegate containing callbacks related to meeting state updates. More...
#import <MobileRTCMeetingDelegate.h>
Inherits <NSObject>.
Instance Methods | |
(void) | - onMeetingError:message: |
An error has occurred. | |
(void) | - onMeetingStateChange: |
Notify the user that the meeting state has changed. | |
(void) | - onMeetingParameterNotification: |
The meeting parameters have been updated. | |
(void) | - onJoinMeetingConfirmed |
The meeting has been joined successfully. | |
(void) | - onMeetingReady |
The meeting is ready. | |
(void) | - onJBHWaitingWithCmd: |
Join a meeting without a host. You can show or hide the custom JBH waiting UI. | |
(void) | - onMeetingEndedReason: |
The meeting has ended. | |
(void) | - onNoHostMeetingWillTerminate: |
The meeting does not have a host and ends. | |
(void) | - onMicrophoneStatusError: |
The user's microphone has encountered an error. | |
(void) | - onJoinMeetingInfo:completion: |
The user must provide additional information before joining the meeting. | |
(void) | - onProxyAuth:port:completion: |
The user must provide proxy information. | |
(void) | - onAskToEndOtherMeeting: |
The user needs to end another ongoing meeting. | |
(void) | - onMicrophoneNoPrivilege |
Microphone access permission was denied. | |
(void) | - onCameraNoPrivilege |
Camera access permission was denied. | |
(void) | - onUpgradeFreeMeetingResult: |
The result of a free meeting upgrade attempt has been received. | |
(void) | - onFreeMeetingNeedToUpgrade:giftUpgradeURL: |
The free meeting needs an upgrade. | |
(void) | - onFreeMeetingUpgradeToGiftFreeTrialStart |
The free meeting was upgraded to a free trial and has started. | |
(void) | - onFreeMeetingUpgradeToGiftFreeTrialStop |
The free meeting which was upgraded to a free trial has stopped. | |
(void) | - onFreeMeetingUpgradedToProMeeting |
The meeting has been upgraded to a pro (licensed) meeting. | |
(BOOL) | - onClickedInviteButton:addInviteActionItem: |
The invite button in the UI has been clicked. | |
(BOOL) | - onClickedAudioButton: |
The audio button in the UI has been clicked. | |
(BOOL) | - onClickedParticipantsButton: |
The participants button has been clicked. | |
(BOOL) | - onClickedShareButton:addShareActionItem: |
The share button has been clicked. | |
(BOOL) | - onClickedEndButton:endButton: |
The meeting end button has been clicked. | |
(BOOL) | - onCheckIfMeetingVoIPCallRunning |
Check if the meeting VoIP call is running. It affects the picture-in-picture function in ZoomUI if videoCallPictureInPictureEnabled returns YES of MobileRTCMeetingSettings. | |
(void) | - onOngoingShareStopped |
All active shares have stopped. | |
(void) | - onClickedDialOut:isCallMe: |
The dial out button has been clicked. | |
(void) | - onDialOutStatusChanged: |
The status of an outgoing call has changed. | |
(void) | - onSendPairingCodeStateChanged:MeetingNumber: |
The H.323 pairing code status has been updated and may require the end user to input their code. | |
(void) | - onCallRoomDeviceStateChanged: |
The room device state changed. | |
(void) | - onChatMessageNotification: |
An in-meeting chat message has been received. | |
(void) | - onChatMsgDeleteNotification:deleteBy: |
A chat message has been deleted. | |
(void) | - onLiveStreamStatusChange: |
The live stream status has changed. | |
(void) | - onRawLiveStreamPrivilegeChanged: |
The current user’s raw live streaming privilege has changed. | |
(void) | - onRawLiveStreamPrivilegeRequestTimeout |
The current user's request for raw live streaming privilege has timed out with no response. | |
(void) | - onUserRawLiveStreamPrivilegeChanged:hasPrivilege: |
Another user’s raw live streaming privilege has changed. | |
(void) | - onRawLiveStreamPrivilegeRequested: |
A user has requested raw live streaming privilege. | |
(void) | - onUserRawLiveStreamingStatusChanged: |
A user has starte or stopped raw live streaming. | |
(void) | - onZoomIdentityExpired |
The ZAK used to authorize the SDK has expired. | |
(void) | - onClickShareScreen: |
The user has clicked the shared screen. | |
(void) | - onClosedCaptionReceived:speakerId:msgTime: |
A closed caption message has been received. If the meeting supports multi-language transcription and the host set manual captioning to true, attendees must set translation language id to -1 to receive closed caption messages. | |
(void) | - onWaitingRoomStatusChange: |
The waiting room status has changed. | |
(void) | - onWaitingRoomEntranceEnabled: |
This callback event will be triggered when host or cohost enables or disables waiting room entrance. | |
(void) | - onSinkAttendeeChatPriviledgeChanged: |
The chat privilege of attendees has changed. | |
(void) | - onSinkPanelistChatPrivilegeChanged: |
The chat privilege of panelists has changed. | |
(void) | - onSubscribeUserFail:size:userId: |
The subscription to a user's video has failed. | |
(void) | - onRequestLocalRecordingPrivilegeReceived: |
Callback when host received the local recording request from participant. | |
(void) | - onSuspendParticipantsActivities |
(void) | - onAllowParticipantsStartVideoNotification: |
(void) | - onAllowParticipantsRenameNotification: |
(void) | - onAllowParticipantsUnmuteSelfNotification: |
(void) | - onAllowParticipantsShareWhiteBoardNotification: |
(void) | - onAllowParticipantsShareStatusNotification: |
(void) | - onMeetingLockStatus: |
(void) | - onRequestLocalRecordingPrivilegeChanged: |
Callback event that the request local recording privilege changes. | |
(void) | - onParticipantProfilePictureStatusChange: |
Sink the event that participant profile status change. | |
(void) | - onCheckCMRPrivilege: |
Determine if the current user has cloud recording privileges. | |
(void) | - onRecordingStatus: |
The cloud recording status has changed. | |
(void) | - onLocalRecordingStatus:status: |
The local recording status has changed. | |
(void) | - onCloudRecordingStorageFull: |
An event sink that the cloud recording storage is full. | |
(void) | - onRequestCloudRecordingResponse: |
Callback event for when the host responds to a cloud recording permission request. | |
(void) | - onStartCloudRecordingRequested: |
Callback event received only by the host when a user requests to start cloud recording. | |
(void) | - onAllowParticipantsRequestCloudRecording: |
Callback event that lets participants request hots to start cloud recording. | |
(void) | - onSmartSummaryStatusChange: |
Callback event when smart summary status changes. | |
(void) | - onSmartSummaryPrivilegeRequested:handler: |
Callback event when a user requests the host to start smart summary. | |
(void) | - onSmartSummaryStartReqResponse:decline: |
Callback event when the host handle the smart summary request. | |
(void) | - onAICompanionActiveChangeNotice: |
Sink the event that AI Companion active status changed. | |
(void) | - onPollingStatusChanged:status: |
Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped. | |
(void) | - onPollingResultUpdated: |
Polling result updated callback. When a participant submits polling. | |
(void) | - onPollingListUpdated |
Polling list updated callback. This is triggered when a host adds, edits, duplicates, or deletes a poll. | |
(void) | - onPollingActionResult:pollingID:bSuccess:errorMsg: |
Polling action result callback. This is triggered when a user perform an action for a poll. | |
(void) | - onPollingQuestionImageDownloaded:path: |
Polling question item image downloaded callback. | |
(void) | - onPollingElapsedTime:uElapsedtime: |
Polling elapsed time callback. | |
(void) | - onGetRightAnswerListPrivilege: |
Callback event for the user get right answer list privilege changed. This is triggered when the host calls EnableGetRightAnswerList in a quiz. | |
(void) | - onPollingInactive |
polling inactive callback. When the user starts a meeting in another device by same account, this callback is triggered. Then call CanDoPolling return false. | |
(void) | - onVideoAlphaChannelStatusChanged: |
Callback event of alpha channel mode changes. | |
(void) | - onSinkMeetingAudioStatusChange: |
A user's audio status has changed. To get their updated status, check [MobileRTCMeetingUserInfo.audioStatus] for the associated user. | |
(void) | - onSinkMeetingMyAudioTypeChange |
The audio type of the current user has changed. | |
(void) | - onSinkMeetingAudioTypeChange: |
A user's audio type has changed. To get their updated type, check MobileRTCMeetingUserInfo.audioStatus for the associated user. | |
(void) | - onSinkJoin3rdPartyTelephonyAudio: |
Callback event that requests to join third party telephony audio. | |
(void) | - onSinkMeetingAudioStatusChange:audioStatus: |
A user's audio status has changed. | |
(void) | - onAudioOutputChange |
The current user's audio output selection has changed. | |
(void) | - onMyAudioStateChange |
The current user's audio state has changed. | |
(void) | - onSinkMeetingAudioRequestUnmuteByHost |
The host has requested the current user to unmute their microphone. | |
(void) | - onSinkMeetingActiveVideo: |
The user being displayed in the active video view has changed. | |
(void) | - onSinkMeetingVideoStatusChange: |
A participant's video status has changed. To get their updated status, check MobileRTCMeetingUserInfo.videoStatus for the associated user. Valid for both normal user and webinar attendee. | |
(void) | - onMyVideoStateChange |
The current user's video status has changed. | |
(void) | - onSinkMeetingVideoStatusChange:videoStatus: |
A participant's video status has changed. | |
(void) | - onSpotlightVideoChange: |
The video status of a spotlit user has changed. | |
(void) | - onSpotlightVideoUserChange: |
The list of spotlit users has changed. | |
(void) | - onSinkMeetingPreviewStopped |
The SDK has stopped the current user's video preview. | |
(void) | - onSinkMeetingActiveVideoForDeck: |
The active video user has changed. | |
(void) | - onSinkMeetingVideoQualityChanged:userID: |
The video quality of a user has changed. | |
(void) | - onSinkMeetingVideoRequestUnmuteByHost: |
The host has requested the current user to unmute their video. | |
(void) | - onSinkMeetingShowMinimizeMeetingOrBackZoomUI: |
The meeting UI has been minimized or returned to fullscreen. | |
(void) | - onHostVideoOrderUpdated: |
The order of users' videos in gallery view has been changed by the host. | |
(void) | - onLocalVideoOrderUpdated: |
The order of users' videos in gallery view has been changed locally. | |
(void) | - onFollowHostVideoOrderChanged: |
The host has enabled/disabled the "Follow Host's Video Order" setting. | |
(void) | - onWhiteboardStatusChanged: |
Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been started or stopped, and all users in the meeting can get the event. | |
(void) | - onWhiteboardSettingsChanged:createOption:enable: |
Callback event of whiteboard setting type changed. | |
(void) | - onMyHandStateChange |
The current user's hand state changes. | |
(void) | - onInMeetingUserUpdated |
The user state is updated in the meeting. | |
(void) | - onInMeetingUserAvatarPathUpdated: |
The user avatar path is updated in the meeting. | |
(void) | - onSinkMeetingUserJoin: |
Callback event of notification of users who are in the meeting. | |
(void) | - onSinkMeetingUserLeft: |
Callback event of notification of user who leaves the meeting. | |
(void) | - onSinkMeetingUserRaiseHand: |
A user raises their hand. | |
(void) | - onSinkMeetingUserLowerHand: |
A user lowers their hand. | |
(void) | - onSinkLowerAllHands |
A host or cohost lowers all hands. | |
(void) | - onSinkUserNameChanged: |
A user changes their screen name. | |
(void) | - onMeetingHostChange: |
The meeting host changes. | |
(void) | - onMeetingCoHostChange:isCoHost: |
The meeting co-host changes. | |
(void) | - onClaimHostResult: |
A user claims the host. | |
(void) | - onAppShareSplash |
A meeting starts by sharing. | |
(void) | - onSinkSharingStatus:userID: |
The share status changes. | |
(void) | - onSinkShareSettingTypeChanged: |
The sharing settings change. | |
(void) | - onSinkShareSizeChange: |
The presenter resizes the sharing content. | |
(void) | - onInterpretationStart |
Interpretation starts. Informs the user that interpretation has been started. All users in the meeting get the event. | |
(void) | - onInterpretationStop |
Interpretation stops. Informs the user that interpretation has been stopped. All users in the meeting get the event. | |
(void) | - onInterpreterListChanged |
The meeting's interpreter list changes. When one or more interpreters leave or a preset interpreter joins. Only the host gets the event. | |
(void) | - onInterpreterRoleChanged:isInterpreter: |
Interpreter role changes. When a user's role changed (participant <-> interpreter), all users in meeting get the event. | |
(void) | - onInterpreterActiveLanguageChanged:activeLanguageId: |
interpreter active language changed callback. When a interpreter's active language changes, all users in meeting get the event. | |
(void) | - onInterpreterLanguageChanged:andLanguage2: |
interpreter languages changed callback. When a interpreter's languages changed, only the interpreter can get the event. | |
(void) | - onAvailableLanguageListUpdated: |
available languages changed callback. When available languages in meeting are changed, all non-interpreter users in a meeting get the event. | |
(void) | - onInterpreterLanguagesUpdated: |
Indicates a change in the list of available languages that interpreters can hear. When the list of available languages that interpreters can hear in a meeting changes, all interpreters in the meeting get this event. | |
(void) | - onSignInterpretationStatusChange: |
Sign interpretation staus change callback. Informs the user that sign interpretation has been started or stopped. All users in meeting can get the event. | |
(void) | - onSignInterpreterListChanged |
Sign interpreter list changed callback. Informs the host that some interpreter left meeting or a preset interpreter joined meeting, or host add or remove interpreter. Only the host can get the event. | |
(void) | - onSignInterpreterRoleChanged |
Indicate when a user's role changed (participant <-> interpreter). Only that specific user gets the event. | |
(void) | - onSignInterpreterLanguageChanged |
Indicate when a sign interpreter's languages changed. Only the sign interpreter can get the event. | |
(void) | - onAvailableSignLanguageListUpdated: |
Indicate when available sign languages in a meeting change. All users in the meeting can get the event. | |
(void) | - onRequestSignInterpreterToTalk |
Callback event of the requirement to unmute sign interpreter's audio from the host. | |
(void) | - onTalkPrivilegeChanged: |
Callback event for the user talk privilege changed. When the interpreter role changed, host changed, host allow or disallow interpreter talk, this will be triggered, and only the sign interpreter itself can get the event. | |
(void) | - onMeetingQAStatusChanged: |
Callback event of meeting QA feature status changes. | |
(void) | - onAllowAskQuestionStatus: |
Notify host/cohost has changed the status of ask question. | |
(void) | - onSinkQAConnectStarted |
Indicates when Question and Answer (Q&A) connection starts. | |
(void) | - onSinkQAConnected: |
Callback event when Q&A is connected or disconnected. | |
(void) | - onSinkQAOpenQuestionChanged: |
Callback event when the open-ended question changes. | |
(void) | - onSinkQAAddQuestion:success: |
Callback event when adding a new question. | |
(void) | - onSinkQAAddAnswer:success: |
Callback event when adding a new answer. | |
(void) | - onSinkQuestionMarkedAsDismissed: |
Callback event when a new question is marked as dismissed. | |
(void) | - onSinkReopenQuestion: |
Callback event when a question is opened. | |
(void) | - onSinkReceiveQuestion: |
Callback event when a new question is received. | |
(void) | - onSinkReceiveAnswer: |
Callback event when a new answer is received. | |
(void) | - onSinkUserLivingReply: |
Callback event when the question is replied to live. | |
(void) | - onSinkUserEndLiving: |
Callback event when the question live reply ends. | |
(void) | - onSinkVoteupQuestion:orderChanged: |
Callback event when the question is upvoted. | |
(void) | - onSinkRevokeVoteupQuestion:orderChanged: |
Callback event when the question upvote is revoked. | |
(void) | - onSinkDeleteQuestion: |
Callback event when a question is deleted. | |
(void) | - onSinkDeleteAnswer: |
Callback event when an answer is deleted. | |
(void) | - onSinkQAAllowAskQuestionAnonymouslyNotification: |
Callback event of the permission change to allow users to ask questions anonymously. | |
(void) | - onSinkQAAllowAttendeeViewAllQuestionNotification: |
Callback event of the permission change that allows the attendee to view all questions. | |
(void) | - onSinkQAAllowAttendeeUpVoteQuestionNotification: |
Callback event of the permission change that allows the attendee to submit questions. | |
(void) | - onSinkQAAllowAttendeeAnswerQuestionNotification: |
Callback event of the permission change that allows the user to answer questions. | |
(void) | - onSinkWebinarNeedRegister: |
Callback event that a user joins a webinar which requires manual approval. | |
(void) | - onSinkJoinWebinarNeedUserNameAndEmailWithCompletion: |
Callback event that a user joins a webinar which requires username and email. | |
(void) | - onSinkPanelistCapacityExceed |
Invoke this function once the number of panelists exceeds the upper limit. | |
(void) | - onSinkPromptAttendee2PanelistResult: |
Invoke this function once a given number of attendees are promoted successfully from attendee to panelist. | |
(void) | - onSinkDePromptPanelist2AttendeeResult: |
Invoke this function when panelist is demoted successfully from panelist to attendee. | |
(void) | - onSinkAllowAttendeeChatNotification: |
Invoke this function when the chat privilege of attendees changes. | |
(void) | - onSinkAttendeePromoteConfirmResult:userId: |
When attendee agrees or declines the promote invitation, the host receives this callback. | |
(void) | - onSinkSelfAllowTalkNotification |
Invoke this function when the attendee is allowed to talk. | |
(void) | - onSinkSelfDisallowTalkNotification |
Invoke this function when the attendee is not allowed to talk. | |
(void) | - onAllowWebinarReactionStatusChanged: |
Invoke this function when the attendee is allow or not allow to using reaction. | |
(void) | - onAllowAttendeeRaiseHandStatusChanged: |
Invoke this function when the attendee is allow or not allow to using raise hand. | |
(void) | - onAllowAttendeeViewTheParticipantCountStatusChanged: |
Invoke this function when the attendee is allow to view the participant count. | |
(void) | - onWebinarNeedInputScreenName: |
When joining the webinar, this callback is triggered if the user needs to input a username. | |
(void) | - onCaptionStatusChanged: |
Sink the event of captions enabled status changed. | |
(void) | - onSinkLiveTranscriptionStatus: |
Sink the event of live transcription status. | |
(void) | - onSinkLiveTranscriptionMsgReceived:speakerId:type: |
Sink the event of receive the live transcription message. | |
(void) | - onLiveTranscriptionMsgInfoReceived: |
(void) | - onOriginalLanguageMsgReceived: |
(void) | - onLiveTranscriptionMsgError:transcriptLanguage: |
Translation message error callback. | |
(void) | - onSinkRequestForLiveTranscriptReceived:bAnonymous: |
Sink the event of request for start the live transcription. Only the host can retrieve this callback. You can approve request call start live transcription, or decline as do nothing. | |
(void) | - on3DAvatarItemThumbnailsDownloaded |
Callback event to notify that all 3D avatar items' thumbnails have been download. | |
(void) | - on3DAvatarItemDataDownloading: |
Callback event to notify that the selected 3D avatar item is downloading. | |
(void) | - on3DAvatarItemDataDownloaded:andIndex: |
Callback event to notify whether the selected 3D avatar item has been downloaded successfully. | |
(void) | - onHasCreatorRightsNotification: |
Notify that the creator role is given. | |
(void) | - onHasAdminRightsNotification: |
Notify that the admin role is given. | |
(void) | - onHasAssistantRightsNotification: |
Notify that the assistant role is given. | |
(void) | - onHasAttendeeRightsNotification: |
Notify that the attendee role is given. | |
(void) | - onHasDataHelperRightsNotification: |
Notify that the data helper role is given. | |
(void) | - onBroadcastBOVoiceStatus: |
The status of broadcasting voice to BO has been changed. | |
(void) | - onLostCreatorRightsNotification |
A lost creator role notification. | |
(void) | - onLostAdminRightsNotification |
A lost admin role notification. | |
(void) | - onLostAssistantRightsNotification |
A lost assistant role notification. | |
(void) | - onLostAttendeeRightsNotification |
A lost attendee role notification. | |
(void) | - onLostDataHelperRightsNotification |
A lost data helper role notification. | |
(void) | - onNewBroadcastMessageReceived:senderID:senderName: |
A broadcast message notification. | |
(void) | - onBOStopCountDown: |
When BOOption.countdownSeconds != MobileRTCBOStopCountDown_Not_CountDown, host stop the breakout room and all users receive the event. | |
(void) | - onHostInviteReturnToMainSession:replyHandler: |
When you are in a breakout room and the host invites you return to main session, you receive the event. | |
(void) | - onBOStatusChanged: |
When host change the breakout room status, all users receive the event. | |
(void) | - onBOSwitchRequestReceived:newBOID: |
When the host modifies the breakout room, all users receive the event. | |
(void) | - onBOInfoUpdated: |
The updated breakout meeting information. | |
(void) | - onUnAssignedUserUpdated |
The unassigned user update. | |
(void) | - onBOListInfoUpdated |
The BO list info updated. | |
(void) | - onHelpRequestReceived: |
Admin receives help request from userID. | |
(void) | - onStartBOError: |
Admin receives an error when breakout room start fails. | |
(void) | - onBOEndTimerUpdated:isTimesUpNotice: |
In a timed breakout, after starting a breakout room, you receive the event. | |
(void) | - onHelpRequestHandleResultReceived: |
Receive the result of sending a help request. | |
(void) | - onHostJoinedThisBOMeeting |
The host joins the current breakout meeting. | |
(void) | - onHostLeaveThisBOMeeting |
The host leaves the current breakout meeting. | |
(void) | - onBOCreateSuccess: |
Creator receives breakout identifier when successfully creating the breakout room. | |
(void) | - onWebPreAssignBODataDownloadStatusChanged: |
When the pre-assigned data download status changes, you will receive the event. | |
(void) | - onBOOptionChanged: |
You will receive the event when the option changes. | |
(void) | - onEmojiReactionReceived:reactionType:reactionSkinTone: |
Notify receipt of the emoji reaction. | |
(void) | - onEmojiReactionReceivedInWebinar: |
Emoji reaction callback. This callback notifies the user when an emoji is received in the webinar. | |
(void) | - onEmojiFeedbackReceived:feedbackType: |
Emoji feedback received callback. This function is used to inform the user once received the emoji feedback sent by others or user himself. | |
(void) | - onEmojiFeedbackCanceled: |
Emoji feedback canceled callback. This function is used to inform the user once the received emoji feedback sent by others or user himself was canceled. | |
(void) | - onE2EEMeetingSecurityCodeChanged |
This callback will be called when the security code changes. | |
(void) | - onFocusModeStateChanged: |
The focus mode state was changed by the host or co-host. | |
(void) | - onFocusModeShareTypeChanged: |
The focus mode share type was changed by the host or co-Host. | |
Delegate containing callbacks related to meeting state updates.
Definition at line 42 of file MobileRTCMeetingDelegate.h.
|
optional |
Callback event to notify whether the selected 3D avatar item has been downloaded successfully.
index | The index of the selected 3D avatar item. |
success | Yes indicates the selected 3D avatar item has been downloaded successfully. |
|
optional |
Callback event to notify that the selected 3D avatar item is downloading.
index | The index of the selected 3D avatar item. |
|
optional |
Callback event to notify that all 3D avatar items' thumbnails have been download.
|
optional |
Sink the event that AI Companion active status changed.
isActive | YES means the AI Companion is active |
|
optional |
Notify host/cohost has changed the status of ask question.
bEnabled | Can ask question or not. |
|
optional |
Invoke this function when the attendee is allow or not allow to using raise hand.
canRaiseHand | If the raise hand is allowed, the result is YES, otherwise NO. |
|
optional |
Invoke this function when the attendee is allow to view the participant count.
canViewParticipantCount | If the view participant is allowed, the result is YES, otherwise NO. |
|
optional |
Sink the event that lets participants rename them
allow | YES allow.If NO,participants may not rename themselves |
|
optional |
Callback event that lets participants request hots to start cloud recording.
allow | True allow. If false, disallow. |
|
optional |
Sink the event that lets participants allow to share
allow | YES allow.if NO.participants may not share |
|
optional |
Sink the event that lets participants share a new white board
allow | YES allow.if NO.participants may not share new white boards |
|
optional |
Sink the event that lets participants start a video
allow | YES allow. if NO disallow |
|
optional |
Sink the event that lets participants unmute them
allow | YES allow. If NO, participants may not unmute themselves |
|
optional |
Invoke this function when the attendee is allow or not allow to using reaction.
canReaction | If the Reaction is allowed, the result is YES, otherwise NO. |
|
optional |
A meeting starts by sharing.
|
optional |
The user needs to end another ongoing meeting.
completion | Ask the user to end another ongoing meeting. |
|
optional |
The current user's audio output selection has changed.
|
optional |
available languages changed callback. When available languages in meeting are changed, all non-interpreter users in a meeting get the event.
availableLanguageList | Specify the available languages list. |
|
optional |
Indicate when available sign languages in a meeting change. All users in the meeting can get the event.
availableSignLanguageList | Specify the available sign languages list. For more details, see ZoomSDKSignInterpretationLanguageInfo object. |
|
optional |
Creator receives breakout identifier when successfully creating the breakout room.
BOID | The identifier of the created breakout. |
|
optional |
In a timed breakout, after starting a breakout room, you receive the event.
remaining | Remaining time. |
isTimesUpNotice | true: when time is up, auto stop breakout room. false: don't auto stop breakout room. |
|
optional |
The updated breakout meeting information.
boId | The identifier for the breakout meeting. |
|
optional |
The BO list info updated.
|
optional |
You will receive the event when the option changes.
newOption | new BO Option. |
|
optional |
When host change the breakout room status, all users receive the event.
status | The current status of the breakout room. |
|
optional |
When BOOption.countdownSeconds != MobileRTCBOStopCountDown_Not_CountDown, host stop the breakout room and all users receive the event.
seconds | The countdown in seconds. |
|
optional |
When the host modifies the breakout room, all users receive the event.
newBOName | The new brekaout room name. |
newBOID | The new breakout room ID. |
|
optional |
The status of broadcasting voice to BO has been changed.
bStart | YES for host begin broadcasting voice to BO, NO for host stop broadcasting voice to BO. |
|
optional |
The room device state changed.
state | The new state. See [H323CallOutStatus]. |
|
optional |
Camera access permission was denied.
|
optional |
Sink the event of captions enabled status changed.
enable | True means the host enables the captions, otherwise means the host disables the captions. |
|
optional |
An in-meeting chat message has been received.
chatInfo | The meeting chat information. |
|
optional |
A chat message has been deleted.
msgID | The ID of the message that was deleted. |
deleteBy | Information about who deleted the message. See [MobileRTCChatMessageDeleteType]. |
|
optional |
Determine if the current user has cloud recording privileges.
result | The result of checking CMR privilege. |
|
optional |
Check if the meeting VoIP call is running. It affects the picture-in-picture function in ZoomUI if videoCallPictureInPictureEnabled returns YES of MobileRTCMeetingSettings.
|
optional |
A user claims the host.
|
optional |
The audio button in the UI has been clicked.
parentVC | Parent viewcontroller used to present custom audio UI. |
|
optional |
The dial out button has been clicked.
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. |
|
optional |
The meeting end button has been clicked.
parentVC | Parent viewcontroller used to present custom Participants UI. |
endButton | The end button. |
|
optional |
The invite button in the UI has been clicked.
parentVC | Parent viewcontroller used to present custom invite UI. |
array | <MobileRTCMeetingInviteActionItem *>Custom invitation actions to be added. |
|
optional |
The participants button has been clicked.
parentVC | Parent viewcontroller used to present custom participants UI. |
|
optional |
The share button has been clicked.
parentVC | Parent viewController used to present the custom share UI. |
|
optional |
The user has clicked the shared screen.
parentVC | Parent viewcontroller used to present the view of Share Screen Usage Guide. |
|
optional |
A closed caption message has been received. If the meeting supports multi-language transcription and the host set manual captioning to true, attendees must set translation language id to -1 to receive closed caption messages.
message | The closed caption text. |
speakerID | The ID of the speaker. |
msgTime | The time of the close caption. |
|
optional |
An event sink that the cloud recording storage is full.
gracePeriodDate | A point in time, in milliseconds in, UTC. |
|
optional |
The status of an outgoing call has changed.
status | The new status. |
|
optional |
This callback will be called when the security code changes.
|
optional |
Emoji feedback canceled callback. This function is used to inform the user once the received emoji feedback sent by others or user himself was canceled.
userId | Specify the user ID of the emoji feedback sender. |
|
optional |
Emoji feedback received callback. This function is used to inform the user once received the emoji feedback sent by others or user himself.
userId | Specify the user ID of the emoji feedback sender. |
type | Specify the type of the received emoji feedback. |
|
optional |
Notify receipt of the emoji reaction.
userId | The user ID of the send emoji reaction. |
type | The send emoji reaction type. |
skinTone | The send emoji reaction skintone. |
|
optional |
Emoji reaction callback. This callback notifies the user when an emoji is received in the webinar.
type | Specify the received reaction's type. |
|
optional |
The focus mode share type was changed by the host or co-Host.
shareType | share type change. |
|
optional |
The focus mode state was changed by the host or co-host.
on | YES means the focus mode on. |
|
optional |
The host has enabled/disabled the "Follow Host's Video Order" setting.
follow | If yes, the host has enabled the setting. Otherwise, it was disabled. |
|
optional |
The free meeting needs an upgrade.
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. |
|
optional |
The meeting has been upgraded to a pro (licensed) meeting.
|
optional |
The free meeting was upgraded to a free trial and has started.
|
optional |
The free meeting which was upgraded to a free trial has stopped.
|
optional |
Callback event for the user get right answer list privilege changed. This is triggered when the host calls EnableGetRightAnswerList in a quiz.
bCan | Specify whether the user has get right answer list privilege or not. |
|
optional |
Notify that the admin role is given.
admin | The admin role is given. |
|
optional |
Notify that the assistant role is given.
assistant | The assistant role is given. |
|
optional |
Notify that the attendee role is given.
attendee | The attendee role is given. |
|
optional |
Notify that the creator role is given.
creator | the creator role is given. |
|
optional |
Notify that the data helper role is given.
dataHelper | The data helper role is given. |
|
optional |
Receive the result of sending a help request.
eResult | The response result for the help request. |
|
optional |
Admin receives help request from userID.
strUserID | The identifier of the breakout room meeting user. |
|
optional |
When you are in a breakout room and the host invites you return to main session, you receive the event.
hostName | the host name. |
replyHandler | the handler to reply for the main session invitation. |
|
optional |
The host joins the current breakout meeting.
|
optional |
The host leaves the current breakout meeting.
|
optional |
The order of users' videos in gallery view has been changed by the host.
orderArr | The updated order of user videos. |
|
optional |
The user avatar path is updated in the meeting.
|
optional |
The user state is updated in the meeting.
|
optional |
Interpretation starts. Informs the user that interpretation has been started. All users in the meeting get the event.
|
optional |
Interpretation stops. Informs the user that interpretation has been stopped. All users in the meeting get the event.
|
optional |
interpreter active language changed callback. When a interpreter's active language changes, all users in meeting get the event.
userID | Specify the user ID whose active language changed. |
activeLanID | Specify the interpreter current active language ID. |
|
optional |
interpreter languages changed callback. When a interpreter's languages changed, only the interpreter can get the event.
lanID1 | Specify the new language ID1. |
lanID2 | Specify the new language ID2. |
|
optional |
Indicates a change in the list of available languages that interpreters can hear. When the list of available languages that interpreters can hear in a meeting changes, all interpreters in the meeting get this event.
availableLanguages | The list of available languages that interpreters can hear. |
|
optional |
The meeting's interpreter list changes. When one or more interpreters leave or a preset interpreter joins. Only the host gets the event.
|
optional |
Interpreter role changes. When a user's role changed (participant <-> interpreter), all users in meeting get the event.
userID | Specify the user ID whose status changed. |
isInterpreter | Specify if user's role is interpreter or not. |
|
optional |
Join a meeting without a host. You can show or hide the custom JBH waiting UI.
cmd | Show/Hide JBH command. |
|
optional |
The meeting has been joined successfully.
|
optional |
The user must provide additional information before joining the meeting.
info | the information need for join meeting. |
completion | the block for input the information displayName A name to be displayed in the meeting. password The meeting passcode. cancel If YES, the attempt to join the meeting is cancelled. |
|
optional |
The live stream status has changed.
liveStreamStatus | The new status. See [MobileRTCLiveStreamStatus]. |
|
optional |
Translation message error callback.
speakLanguage | an object of the speak message language. |
transcriptLanguage | an object of the message language you want to translate. |
|
optional |
|
optional |
The local recording status has changed.
userId | The ID of the user who caused the change. |
status | The new recording status. |
|
optional |
The order of users' videos in gallery view has been changed locally.
localOrderArr | The updated order of user videos. |
|
optional |
A lost admin role notification.
|
optional |
A lost assistant role notification.
|
optional |
A lost attendee role notification.
|
optional |
A lost creator role notification.
|
optional |
A lost data helper role notification.
|
optional |
The meeting co-host changes.
userID | The new co-host's user ID. |
isCoHost | Indicates the user (userID) be assigned to co-host or be remove co-host. |
|
optional |
The meeting has ended.
reason | The reason why the meeting has ended. See [MobileRTCMeetingEndReason]. |
|
optional |
An error has occurred.
error | The error code. See [MobileRTCMeetError]. |
message | The message of the error. |
|
optional |
The meeting host changes.
hostId | The new host's user ID. |
|
optional |
Sink the event that allow a meeting lock status change
isLock | YES, the status is locked. If NO, the status is unlocked. |
|
optional |
The meeting parameters have been updated.
meetingParam | meetingParam Meeting parameter. See [MobileRTCMeetingParameter]. |
|
optional |
Callback event of meeting QA feature status changes.
isMeetingQAFeatureOn | YES means meeting QA feature is on, otherwise not. |
|
optional |
The meeting is ready.
|
optional |
Notify the user that the meeting state has changed.
state | The new meeting state. [MobileRTCMeetingState]. |
|
optional |
Microphone access permission was denied.
|
optional |
The user's microphone has encountered an error.
error | The error. See [MobileRTCMicropohoneError] |
|
optional |
The current user's audio state has changed.
|
optional |
The current user's hand state changes.
|
optional |
The current user's video status has changed.
|
optional |
A broadcast message notification.
broadcastMsg | The broadcast message received from host. |
senderID | The senderID. |
senderName | The sender Name. |
|
optional |
The meeting does not have a host and ends.
minutes | The minutes remaining until the meeting ends. |
|
optional |
All active shares have stopped.
|
optional |
|
optional |
Sink the event that participant profile status change.
hidden | true means hide participant profile picture, false means show participant profile picture. |
|
optional |
Polling action result callback. This is triggered when a user perform an action for a poll.
actionType | Specify the action type. For more details, see MobileRTCPollingActionType enum. |
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. |
|
optional |
Polling elapsed time callback.
pollingID | Specify the polling question's ID. |
uElapsedtime | Specify the polling elapsed time in milliseconds. |
|
optional |
polling inactive callback. When the user starts a meeting in another device by same account, this callback is triggered. Then call CanDoPolling return false.
|
optional |
Polling list updated callback. This is triggered when a host adds, edits, duplicates, or deletes a poll.
|
optional |
Polling question item image downloaded callback.
questionID | Specify the polling question's ID. |
path | Specify the image downloaded path. |
|
optional |
Polling result updated callback. When a participant submits polling.
pollingID | Specify the result updated poll's ID. |
|
optional |
Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped.
pollingID | Specify the status changed poll's ID. |
status | Specify current polling status. For more details, see MobileRTCPollingStatus enum. |
|
optional |
The user must provide proxy information.
host | Proxy host. |
port | Proxy port. |
completion | The SDK asks the user to input proxy information once it detects that the information changed. |
|
optional |
The current user’s raw live streaming privilege has changed.
hasPrivilege | Whether the user has privilege. |
|
optional |
A user has requested raw live streaming privilege.
handler | A pointer to the IRequestRawLiveStreamPrivilegeHandler. For more details, see [MobileRTCRequestRawLiveStreamPrivilegeHandler]. |
|
optional |
The current user's request for raw live streaming privilege has timed out with no response.
|
optional |
The cloud recording status has changed.
status | The new recording status. |
|
optional |
Callback event for when the host responds to a cloud recording permission request.
status | Value of request host to start cloud recording response status. For more details, |
|
optional |
Callback event that the request local recording privilege changes.
status | Value of request local recording privilege status LocalRecordingRequestPrivilegeStatus |
|
optional |
Callback when host received the local recording request from participant.
handler | the host admit or decline the request through this handler. |
|
optional |
Callback event of the requirement to unmute sign interpreter's audio from the host.
|
optional |
The H.323 pairing code status has been updated and may require the end user to input their code.
state | The new paring state. See [MobileRTCH323ParingStatus]. |
meetingNumber | The meetng number. |
|
optional |
Sign interpretation staus change callback. Informs the user that sign interpretation has been started or stopped. All users in meeting can get the event.
status | Specify current sign interpretation status. |
|
optional |
Indicate when a sign interpreter's languages changed. Only the sign interpreter can get the event.
|
optional |
Sign interpreter list changed callback. Informs the host that some interpreter left meeting or a preset interpreter joined meeting, or host add or remove interpreter. Only the host can get the event.
|
optional |
Indicate when a user's role changed (participant <-> interpreter). Only that specific user gets the event.
|
optional |
Invoke this function when the chat privilege of attendees changes.
currentPrivilege | The chat privilege of the current attendee. |
|
optional |
The chat privilege of attendees has changed.
currentPrivilege | The new chat privilege. See [MobileRTCMeetingChatPriviledgeType]. |
|
optional |
When attendee agrees or declines the promote invitation, the host receives this callback.
agree | If attendee agrees, return true. Otherwise, return false. |
userId | The attendee user ID. |
|
optional |
Callback event when an answer is deleted.
answerIDArray | The answer IDs. |
|
optional |
Callback event when a question is deleted.
questionIDArray | The question IDs. |
|
optional |
Invoke this function when panelist is demoted successfully from panelist to attendee.
errorCode | Demotion successful or error type. |
|
optional |
Callback event that requests to join third party telephony audio.
audioInfo | Instruction on how to join the meeting with third party audio. |
|
optional |
Callback event that a user joins a webinar which requires username and email.
completion | User needs to provide username and email to join meeting or cancel the join action. |
|
optional |
Sink the event of receive the live transcription message.
msg | The received live transcription message. |
speakerId | The speaker ID of the received live transcription message. |
type | The live transcription operation type. For more details, see MobileRTCLiveTranscriptionOperationType. |
|
optional |
Sink the event of live transcription status.
status | The live transcription status. For more details, see MobileRTCLiveTranscriptionStatus |
|
optional |
A host or cohost lowers all hands.
|
optional |
The user being displayed in the active video view has changed.
userID | The ID of user whose video is being displayed. |
|
optional |
The active video user has changed.
userID | The ID of the newly displayed user. |
|
optional |
The host has requested the current user to unmute their microphone.
|
optional |
A user's audio status has changed. To get their updated status, check [MobileRTCMeetingUserInfo.audioStatus] for the associated user.
userID | The ID of user whose audio status has changed. |
|
optional |
A user's audio status has changed.
userID | The ID of the user whose audio status has changed. |
audioStatus | The new audio status of the user. |
|
optional |
A user's audio type has changed. To get their updated type, check MobileRTCMeetingUserInfo.audioStatus
for the associated user.
UserID | The ID of user whose audio type changes. |
|
optional |
The audio type of the current user has changed.
|
optional |
The SDK has stopped the current user's video preview.
MobileRTCPreviewVideoView
no longer render video and should be removed.
|
optional |
The meeting UI has been minimized or returned to fullscreen.
state | The new state of the meeting UI. |
|
optional |
Callback event of notification of users who are in the meeting.
userID | The ID of the user who joins the meeting. |
|
optional |
Callback event of notification of user who leaves the meeting.
userID | The ID of the user who leaves the meeting. |
|
optional |
A user lowers their hand.
userID | The ID of the user who lowers their hand. |
|
optional |
A user raises their hand.
userID | The ID of the user who raises their hand. |
|
optional |
The video quality of a user has changed.
qality | The user's new video quality. See MobileRTCVideoQuality . |
userID | The ID of the user whose video quality has changed. |
|
optional |
The host has requested the current user to unmute their video.
|
optional |
A participant's video status has changed. To get their updated status, check MobileRTCMeetingUserInfo.videoStatus
for the associated user. Valid for both normal user and webinar attendee.
userID | The ID of the user whose video status has changed. |
|
optional |
A participant's video status has changed.
userID | The ID of the user whose video status has changed. |
videoStatus | The new video status of the user. |
|
optional |
Invoke this function once the number of panelists exceeds the upper limit.
|
optional |
The chat privilege of panelists has changed.
privilege | The new chat privilege. See [MobileRTCPanelistChatPrivilegeType]. |
|
optional |
Invoke this function once a given number of attendees are promoted successfully from attendee to panelist.
errorCode | Promotion successful or error type. |
|
optional |
Callback event when adding a new answer.
answerID | The answer user ID. |
success | Successful or not. |
|
optional |
Callback event when adding a new question.
questionID | The question ID. |
success | Successful or not. |
|
optional |
Callback event of the permission change to allow users to ask questions anonymously.
beAllowed | YES means that user can ask question anonymously. Otherwise, they cannot. |
|
optional |
Callback event of the permission change that allows the user to answer questions.
beAllowed | YES means that user can answer questions. Otherwise, they cannot. |
|
optional |
Callback event of the permission change that allows the attendee to submit questions.
beAllowed | YES means that the user can submit questions. Otherwise, they cannot. |
|
optional |
Callback event of the permission change that allows the attendee to view all questions.
beAllowed | YES means that user can view all questions. Otherwise, they cannot. |
|
optional |
Callback event when Q&A is connected or disconnected.
connected | The flag of Q&A is connected ordisconnected. |
|
optional |
Indicates when Question and Answer (Q&A) connection starts.
|
optional |
Callback event when the open-ended question changes.
count | The count of open-ended questions. |
|
optional |
Callback event when a new question is marked as dismissed.
questionID | The question ID. |
|
optional |
Callback event when a new answer is received.
answerID | The question ID. |
|
optional |
Callback event when a new question is received.
questionID | The question ID. |
|
optional |
Callback event when a question is opened.
questionID | The question ID. |
|
optional |
Sink the event of request for start the live transcription. Only the host can retrieve this callback. You can approve request call start live transcription, or decline as do nothing.
requesterUserId | The user ID of the request from. If bAnonymous is TRUE, requesterUserId has no meaning. |
bAnonymous | TRUE means the request is anonymous. |
|
optional |
Callback event when the question upvote is revoked.
questionID | The question ID. |
orderChanged | Order changed. |
|
optional |
Invoke this function when the attendee is allowed to talk.
|
optional |
Invoke this function when the attendee is not allowed to talk.
|
optional |
The sharing settings change.
shareSettingType | The share setting type of current meeting. |
|
optional |
The presenter resizes the sharing content.
userID | New size of the shared content and user ID. |
|
optional |
The share status changes.
status | Sharing status. |
userID | Specify the user ID whose share status changes. |
|
optional |
Callback event when the question live reply ends.
questionID | The question ID. |
|
optional |
Callback event when the question is replied to live.
questionID | The question ID. |
|
optional |
A user changes their screen name.
userNameChangedArr | The user IDs whose user name(s) changed. |
|
optional |
Callback event when the question is upvoted.
questionID | The question ID. |
orderChanged | Order changed. |
|
optional |
Callback event that a user joins a webinar which requires manual approval.
registerURL | The register URL. |
|
optional |
Callback event when a user requests the host to start smart summary.
userId | The user who requests the host to start smart summary. |
handler | The handler to handle the smart summary start request. |
|
optional |
Callback event when the host handle the smart summary request.
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. |
|
optional |
Callback event when smart summary status changes.
isStarted | true means that the smart summary is started. False means it has not. |
|
optional |
The video status of a spotlit user has changed.
on | Whether the user's video was turned on. |
|
optional |
The list of spotlit users has changed.
spotlightedUserList | The users who are currently spotlit. |
|
optional |
Admin receives an error when breakout room start fails.
errType | The error type defail of the failure. |
|
optional |
Callback event received only by the host when a user requests to start cloud recording.
handler | A pointer to the MobileRTCRequestStartCloudRecordingPrivilegeHandler. |
|
optional |
The subscription to a user's video has failed.
errorCode | The error code. See {@MobileRTCSubscribeFailReason}. |
size | The subscription's size. |
userId | The ID of the user whose subscription failed. |
|
optional |
Callback event when a meeting is suspended.
|
optional |
Callback event for the user talk privilege changed. When the interpreter role changed, host changed, host allow or disallow interpreter talk, this will be triggered, and only the sign interpreter itself can get the event.
hasPrivilege | Specify whether the user has talk privilege or not |
|
optional |
The unassigned user update.
|
optional |
The result of a free meeting upgrade attempt has been received.
result | ZERO(0) means the upgrade was successful, otherwise it failed. |
|
optional |
A user has starte or stopped raw live streaming.
liveStreamList | A list of users with an active raw live stream. |
|
optional |
Another user’s raw live streaming privilege has changed.
userId | The ID of the user whose privilege has changed. |
hasPrivilege | Whether the user has privilege. |
|
optional |
Callback event of alpha channel mode changes.
alphaChannelOn | YES means it's in alpha channel mode. Otherwise, it's not. |
|
optional |
This callback event will be triggered when host or cohost enables or disables waiting room entrance.
enabled | True means enables waiting room entrance, false means disables waiting room entrance. |
|
optional |
The waiting room status has changed.
|
optional |
When joining the webinar, this callback is triggered if the user needs to input a username.
handler | An object used by user to complete all the related operations. |
|
optional |
When the pre-assigned data download status changes, you will receive the event.
status | download status, for more details, see [MobileRTCBOPreAssignBODataStatus]]. |
|
optional |
Callback event of whiteboard setting type changed.
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. |
|
optional |
Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been started or stopped, and all users in the meeting can get the event.
status | Specify current whiteboard status. For more details, see [MobileRTCWhiteboardStatus]. |
|
optional |
The ZAK used to authorize the SDK has expired.