<MobileRTCMeetingServiceDelegate> Protocol Reference

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

#import <MobileRTCMeetingDelegate.h>

Inherits <NSObject>.

Inherited by <MobileRTC3DAvatarDelegate>, <MobileRTCAudioServiceDelegate>, <MobileRTCBOAdminDelegate>, <MobileRTCBOAttendeeDelegate>, <MobileRTCBOCreatorDelegate>, <MobileRTCBODataDelegate>, <MobileRTCBOServiceDelegate>, <MobileRTCInterpretationServiceDelegate>, <MobileRTCLiveTranscriptionServiceDelegate>, <MobileRTCReactionServiceDelegate>, <MobileRTCShareServiceDelegate>, <MobileRTCSignInterpretationServiceDelegate>, <MobileRTCUserServiceDelegate>, <MobileRTCVideoServiceDelegate>, and <MobileRTCWebinarServiceDelegate>.

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)	- 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

Delegate containing callbacks related to meeting state updates.

Definition at line 35 of file MobileRTCMeetingDelegate.h.

Method Documentation

onAskToEndOtherMeeting:

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

optional

The user needs to end another ongoing meeting.

Parameters

completion

Ask the user to end another ongoing meeting.

onCallRoomDeviceStateChanged:

- (void) onCallRoomDeviceStateChanged: (H323CallOutStatus)  state

optional

The room device state changed.

Parameters

state

The new state. See [H323CallOutStatus].

onCameraNoPrivilege

- (void) onCameraNoPrivilege

optional

Camera access permission was denied.

onChatMsgDeleteNotification:deleteBy:

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

optional

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

optional

Determine if the current user has cloud recording privileges.

Parameters

result

The result of checking CMR privilege.

onClickedAudioButton:

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

optional

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

optional

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

optional

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

optional

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

optional

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

optional

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. NO if user wants to custom Share Action Item, add items to Share ActionSheet via MobileRTCMeetingShareActionItem. Otherwise YES, the user uses the default UI.

onClickShareScreen:

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

optional

The user has clicked the shared screen.

Parameters

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

optional

A closed caption message has been received. If the meeting supports multi-language transcription and the host set manual captioning to true, attendees must set translation language id to -1 to receive closed caption messages.

Parameters

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

onDialOutStatusChanged:

- (void) onDialOutStatusChanged: (DialOutStatus)  status

optional

The status of an outgoing call has changed.

Parameters

status

The new status.

onFreeMeetingNeedToUpgrade:giftUpgradeURL:

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

optional

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.

onFreeMeetingReminder:canFreeUpgrade:isFirstGift:completion:

- (void) onFreeMeetingReminder: (BOOL)  host canFreeUpgrade: (BOOL)  freeUpgrade isFirstGift: (BOOL)  first completion: (void(^)(BOOL upgrade))  completion

optional

The free meeting ends in 10 minutes.

Parameters

host	If YES, the user is the original host of the meeting.
freeUpgrade	If YES, the meeting can be upgraded and the free meeting limitation is removed.
first	If YES, this is the first meeting which can ignore the limitation.
completion	The SDK calls the module to upgrade the current meeting if the parameter UPGRADE is YES.

onFreeMeetingUpgradedToProMeeting

- (void) onFreeMeetingUpgradedToProMeeting

optional

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

onFreeMeetingUpgradeToGiftFreeTrialStart

- (void) onFreeMeetingUpgradeToGiftFreeTrialStart

optional

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

onFreeMeetingUpgradeToGiftFreeTrialStop

- (void) onFreeMeetingUpgradeToGiftFreeTrialStop

optional

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

onInMeetingChat:

- (void) onInMeetingChat: (NSString *_Nonnull)  messageID

optional

An in-meeting chat message has been received.

Parameters

messageID

The message ID.

onJBHWaitingWithCmd:

- (void) onJBHWaitingWithCmd: (JBHCmd)  cmd

optional

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

optional

The meeting has been joined successfully.

onJoinMeetingInfo:completion:

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

optional

The user must provide additional information before joining the meeting.

Parameters

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

onLiveStreamStatusChange:

- (void) onLiveStreamStatusChange: (MobileRTCLiveStreamStatus)  liveStreamStatus

optional

The live stream status has changed.

Parameters

liveStreamStatus

The new status. See [MobileRTCLiveStreamStatus].

onLocalRecordingStatus:status:

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

optional

The local recording status has changed.

Parameters

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

onMeetingEndedReason:

- (void) onMeetingEndedReason: (MobileRTCMeetingEndReason)  reason

optional

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.

onMeetingParameterNotification:

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

optional

The meeting parameters have been updated.

Parameters

meetingParam

meetingParam Meeting parameter. See [MobileRTCMeetingParameter].

onMeetingReady

- (void) onMeetingReady

optional

The meeting is ready.

onMeetingStateChange:

- (void) onMeetingStateChange: (MobileRTCMeetingState)  state

optional

Notify the user that the meeting state has changed.

Parameters

state

The new meeting state. [MobileRTCMeetingState].

onMicrophoneNoPrivilege

- (void) onMicrophoneNoPrivilege

optional

Microphone access permission was denied.

onMicrophoneStatusError:

- (void) onMicrophoneStatusError: (MobileRTCMicrophoneError)  error

optional

The user's microphone has encountered an error.

Parameters

errror

The error. See [MobileRTCMicropohoneError]

onNoHostMeetingWillTerminate:

- (void) onNoHostMeetingWillTerminate: (NSUInteger)  minutes

optional

The meeting does not have a host and ends.

Parameters

minutes

The minutes remaining until the meeting ends.

onOngoingShareStopped

- (void) onOngoingShareStopped

optional

All active shares have stopped.

onProxyAuth:port:completion:

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

optional

The user must provide proxy information.

Parameters

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

onRawLiveStreamPrivilegeChanged:

- (void) onRawLiveStreamPrivilegeChanged: (BOOL)  hasPrivilege

optional

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

Parameters

hasPrivilege

Whether the user has privilege.

onRawLiveStreamPrivilegeRequested:

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

optional

A user has requested raw live streaming privilege.

Parameters

handler

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

onRawLiveStreamPrivilegeRequestTimeout

- (void) onRawLiveStreamPrivilegeRequestTimeout

optional

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

onRecordingStatus:

- (void) onRecordingStatus: (MobileRTCRecordingStatus)  status

optional

The cloud recording status has changed.

Parameters

status

The new recording status.

onRequestLocalRecordingPrivilegeReceived:

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

optional

Callback when host received the local recording request from participant.

Parameters

handler

the host admit or decline the request through this handler.

onSendPairingCodeStateChanged:MeetingNumber:

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

optional

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

Parameters

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

onSinkAttendeeChatPriviledgeChanged:

- (void) onSinkAttendeeChatPriviledgeChanged: (MobileRTCMeetingChatPriviledgeType)  currentPrivilege

optional

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.

onSinkPanelistChatPrivilegeChanged:

- (void) onSinkPanelistChatPrivilegeChanged: (MobileRTCPanelistChatPrivilegeType)  privilege

optional

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.

onSubscribeUserFail:size:userId:

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

optional

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.

onUpgradeFreeMeetingResult:

- (void) onUpgradeFreeMeetingResult: (NSUInteger)  result

optional

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

Parameters

result

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

onUserRawLiveStreamingStatusChanged:

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

optional

A user has starte or stopped raw live streaming.

Parameters

liveStreamList

A list of users with an active raw live stream.

onUserRawLiveStreamPrivilegeChanged:hasPrivilege:

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

optional

Another user’s raw live streaming privilege has changed.

Parameters

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

onWaitingRoomStatusChange:

- (void) onWaitingRoomStatusChange: (BOOL)  needWaiting

optional

The waiting room status has changed.

onZoomIdentityExpired

- (void) onZoomIdentityExpired

optional

The ZAK used to authorize the SDK has expired.