iOS SDK API Reference
Loading...
Searching...
No Matches
<MobileRTCWebinarServiceDelegate> Protocol Reference

Indicates when the Webinar changes. More...

#import <MobileRTCMeetingDelegate.h>

Inherits <MobileRTCMeetingServiceDelegate>.

Instance Methods

(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.
 
- Instance Methods inherited from <MobileRTCMeetingServiceDelegate>
(void) - onMeetingError:message:
 An error has occurred.
 
(void) - onMeetingStateChange:
 Notify the user that the meeting state has changed.
 
(void) - onMeetingParameterNotification:
 The meeting parameters have been updated.
 
(void) - onJoinMeetingConfirmed
 The meeting has been joined successfully.
 
(void) - onMeetingReady
 The meeting is ready.
 
(void) - onJBHWaitingWithCmd:
 Join a meeting without a host. You can show or hide the custom JBH waiting UI.
 
(void) - onCheckCMRPrivilege:
 Determine if the current user has cloud recording privileges.
 
(void) - onRecordingStatus:
 The cloud recording status has changed.
 
(void) - onLocalRecordingStatus:status:
 The local recording status has changed.
 
(void) - onMeetingEndedReason:
 The meeting has ended.
 
(void) - onNoHostMeetingWillTerminate:
 The meeting does not have a host and ends.
 
(void) - onMicrophoneStatusError:
 The user's microphone has encountered an error.
 
(void) - onJoinMeetingInfo:completion:
 The user must provide additional information before joining the meeting.
 
(void) - onProxyAuth:port:completion:
 The user must provide proxy information.
 
(void) - onAskToEndOtherMeeting:
 The user needs to end another ongoing meeting.
 
(void) - onMicrophoneNoPrivilege
 Microphone access permission was denied.
 
(void) - onCameraNoPrivilege
 Camera access permission was denied.
 
(void) - onFreeMeetingReminder:canFreeUpgrade:isFirstGift:completion:
 The free meeting ends in 10 minutes.
 
(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.
 
(void) - onOngoingShareStopped
 All active shares have stopped.
 
(void) - onClickedDialOut:isCallMe:
 The dial out button has been clicked.
 
(void) - onDialOutStatusChanged:
 The status of an outgoing call has changed.
 
(void) - onSendPairingCodeStateChanged:MeetingNumber:
 The H.323 pairing code status has been updated and may require the end user to input their code.
 
(void) - onCallRoomDeviceStateChanged:
 The room device state changed.
 
(void) - onInMeetingChat:
 An in-meeting chat message has been received.
 
(void) - 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) - 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.
 

Detailed Description

Indicates when the Webinar changes.

Definition at line 741 of file MobileRTCMeetingDelegate.h.

Method Documentation

◆ onAllowAttendeeRaiseHandStatusChanged:

- (void) onAllowAttendeeRaiseHandStatusChanged: (BOOL)  canRaiseHand
optional

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

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

◆ onAllowAttendeeViewTheParticipantCountStatusChanged:

- (void) onAllowAttendeeViewTheParticipantCountStatusChanged: (BOOL)  canViewParticipantCount
optional

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

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

◆ onAllowWebinarReactionStatusChanged:

- (void) onAllowWebinarReactionStatusChanged: (BOOL)  canReaction
optional

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

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

◆ onSinkAllowAttendeeChatNotification:

- (void) onSinkAllowAttendeeChatNotification: (MobileRTCChatAllowAttendeeChat currentPrivilege
optional

Invoke this function when the chat privilege of attendees changes.

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

◆ onSinkAttendeePromoteConfirmResult:userId:

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

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

Parameters
agree,Ifattendee agrees, return true. Otherwise, return false.
userid,Theattendee user ID.

◆ onSinkDeleteAnswer:

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

Callback event when an answer is deleted.

Parameters
answerIDArrayThe answer IDs.

◆ onSinkDeleteQuestion:

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

Callback event when a question is deleted.

Parameters
questionIDArrayThe question IDs.

◆ onSinkDePromptPanelist2AttendeeResult:

- (void) onSinkDePromptPanelist2AttendeeResult: (MobileRTCWebinarPromoteorDepromoteError errorCode
optional

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

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

◆ onSinkJoinWebinarNeedUserNameAndEmailWithCompletion:

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

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

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

◆ onSinkPanelistCapacityExceed

- (void) onSinkPanelistCapacityExceed
optional

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

◆ onSinkPromptAttendee2PanelistResult:

- (void) onSinkPromptAttendee2PanelistResult: (MobileRTCWebinarPromoteorDepromoteError errorCode
optional

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

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

◆ onSinkQAAddAnswer:success:

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

Callback event when adding a new answer.

Parameters
answerIDThe answer user ID.
successSuccessful or not.

◆ onSinkQAAddQuestion:success:

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

Callback event when adding a new question.

Parameters
questionIDThe question ID.
successSuccessful or not.

◆ onSinkQAAllowAskQuestionAnonymouslyNotification:

- (void) onSinkQAAllowAskQuestionAnonymouslyNotification: (BOOL)  beAllowed
optional

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

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

◆ onSinkQAAllowAttendeeAnswerQuestionNotification:

- (void) onSinkQAAllowAttendeeAnswerQuestionNotification: (BOOL)  beAllowed
optional

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

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

◆ onSinkQAAllowAttendeeUpVoteQuestionNotification:

- (void) onSinkQAAllowAttendeeUpVoteQuestionNotification: (BOOL)  beAllowed
optional

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

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

◆ onSinkQAAllowAttendeeViewAllQuestionNotification:

- (void) onSinkQAAllowAttendeeViewAllQuestionNotification: (BOOL)  beAllowed
optional

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

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

◆ onSinkQAConnected:

- (void) onSinkQAConnected: (BOOL)  connected
optional

Callback event when Q&A is connected or disconnected.

Parameters
connectedThe flag of Q&A is connected ordisconnected.

◆ onSinkQAConnectStarted

- (void) onSinkQAConnectStarted
optional

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

◆ onSinkQAOpenQuestionChanged:

- (void) onSinkQAOpenQuestionChanged: (NSInteger)  count
optional

Callback event when the open-ended question changes.

Parameters
countThe count of open-ended questions.

◆ onSinkQuestionMarkedAsDismissed:

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

Callback event when a new question is marked as dismissed.

Parameters
questionIDThe question ID.

◆ onSinkReceiveAnswer:

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

Callback event when a new answer is received.

Parameters
questionIDThe question ID.

◆ onSinkReceiveQuestion:

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

Callback event when a new question is received.

Parameters
questionIDThe question ID.

◆ onSinkReopenQuestion:

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

Callback event when a question is opened.

Parameters
questionIDThe question ID.

◆ onSinkRevokeVoteupQuestion:orderChanged:

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

Callback event when the question upvote is revoked.

Parameters
questionIDThe question ID.
order_changedOrder changed.

◆ onSinkSelfAllowTalkNotification

- (void) onSinkSelfAllowTalkNotification
optional

Invoke this function when the attendee is allowed to talk.

◆ onSinkSelfDisallowTalkNotification

- (void) onSinkSelfDisallowTalkNotification
optional

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

◆ onSinkUserEndLiving:

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

Callback event when the question live reply ends.

Parameters
questionIDThe question ID.

◆ onSinkUserLivingReply:

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

Callback event when the question is replied to live.

Parameters
questionIDThe question ID.

◆ onSinkVoteupQuestion:orderChanged:

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

Callback event when the question is upvoted.

Parameters
questionIDThe question ID.
order_changedOrder changed.

◆ onSinkWebinarNeedRegister:

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

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

Parameters
registerURLThe register URL.