iOS API
Instance Methods | List of all members
<MobileRTCMeetingServiceDelegate > Protocol Reference
Inheritance diagram for <MobileRTCMeetingServiceDelegate >:

Instance Methods

(void) - onMeetingError:message:
 Specified Meeting Errors. More...
 
(void) - onMeetingStateChange:
 Notify the user that the meeting status changes. More...
 
(void) - onJoinMeetingConfirmed
 Notify the user that the requirement to join meeting is confirmed.
 
(void) - onMeetingReady
 The meeting is ready.
 
(void) - onJBHWaitingWithCmd:
 Join a meeting without host, you can show/hide the custom JBH waiting UI. More...
 
(void) - onCheckCMRPrivilege:
 Determine if the current user has the cloud recording privilege.
More...
 
(void) - onRecordingStatus:
 Recording status notify callback. More...
 
(void) - onMeetingEndedReason:
 Meeting is ended by some reasons. More...
 
(void) - onNoHostMeetingWillTerminate:
 Meeting without host will be ended after some-awhile. More...
 
(void) - onMicrophoneStatusError:
 Notify user the issues of microphone.
 
(void) - onJoinMeetingInfo:completion:
 Notify user to provide join meeting information: screen name or meeting password. More...
 
(void) - onProxyAuth:port:completion:
 Set to ask user to provide proxy information: username and password. More...
 
(void) - onAskToEndOtherMeeting:
 Set if user needs to end another ongoing meeting. More...
 
(void) - onMicrophoneNoPrivilege
 Notify user that microphone access permission is denied.

 
(void) - onCameraNoPrivilege
 Notify user that camera access permission is denied.
 
(void) - onFreeMeetingReminder:canFreeUpgrade:isFirstGift:completion:
 Inform user that free meeting will be ended in 10 minutes. More...
 
(void) - onUpgradeFreeMeetingResult:
 The result of upgrading free meeting. More...
 
(void) - onFreeMeetingNeedToUpgrade:giftUpgradeURL:
 Designated for notify the free meeting need upgrade. More...
 
(void) - onFreeMeetingUpgradeToGiftFreeTrialStart
 Designated for notify the free meeting which has been upgraded to free trail meeting has started.
 
(void) - onFreeMeetingUpgradeToGiftFreeTrialStop
 Designated for notify the free meeting which has been upgraded to free trail meeting has stoped.
 
(void) - onFreeMeetingUpgradedToProMeeting
 Designated for notify the free meeting has been upgraded to professional meeting.
 
(BOOL) - onClickedInviteButton:addInviteActionItem:
 Customize the invitation event. More...
 
(BOOL) - onClickedAudioButton:
 Customize the audio button clicked event. More...
 
(BOOL) - onClickedParticipantsButton:
 Custom the UI of Participants management. More...
 
(BOOL) - onClickedShareButton:addShareActionItem:
 User needs to click the SHARE button in meeting. More...
 
(BOOL) - onClickedEndButton:endButton:
 Custom the UI of Leave Meeting Alert. More...
 
(void) - onOngoingShareStopped
 Notify users that there is no sharing for the moment.
 
(void) - onClickedDialOut:isCallMe:
 Customize outgoing call interface. More...
 
(void) - onDialOutStatusChanged:
 Callback event that outgoing call status changes.
More...
 
(void) - onSendPairingCodeStateChanged:MeetingNumber:
 Callback event while calling H.323 device, and you should input the pairing code. More...
 
(void) - onCallRoomDeviceStateChanged:
 Callback event when Room Device state changes. More...
 
(void) - onInMeetingChat:
 Callback event of new message. More...
 
(void) - onWaitExternalSessionKey:
 Notify user if the meeting is end to end. More...
 
(void) - onLiveStreamStatusChange:
 Callback event that live stream status changes.
 
(void) - onZoomIdentityExpired
 Callback event that ZAK expired.
 
(void) - onClickShareScreen:
 Callback event that user clicks the sharing screen. More...
 
(void) - onClosedCaptionReceived:
 Callback event that user receives the Closed Caption.
 
(void) - onWaitingRoomStatusChange:
 Callback event that waiting room status changes.
 
(void) - onSinkAttendeeChatPriviledgeChanged:
 The function will be invoked when the chat privilege of attendees changes. More...
 
(void) - onSubscribeUserFail:size:userId:
 Callback when subscribe fail. More...
 

Method Documentation

◆ onAskToEndOtherMeeting:()

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

Set if user needs to end another ongoing meeting.

Parameters
completionAsk user to end another ongoing meeting or not.

◆ onCallRoomDeviceStateChanged:()

- (void MobileRTCMeetingServiceDelegate) onCallRoomDeviceStateChanged: (H323CallOutStatus)  state
optional

Callback event when Room Device state changes.

Parameters
stateNotify user the status of calling Room Device.

◆ onCheckCMRPrivilege:()

- (void MobileRTCMeetingServiceDelegate) onCheckCMRPrivilege: (MobileRTCCMRError)  result
optional

Determine if the current user has the cloud recording privilege.

Parameters
resultThe result of checking CMR privilege.

◆ onClickedAudioButton:()

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

Customize the audio button clicked event.

Parameters
parentVCParent viewcontroller to present custom Invite UI.
Returns
YES if user wants to custom the audio button clicked event, Otherwise NO, will use the default method.

◆ onClickedDialOut:isCallMe:()

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

Customize outgoing call interface.

Parameters
parentVCParent viewcontroller to present outgoing call UI.
meYES means to CALL ME; NO means INVITE BY PHONE.

◆ onClickedEndButton:endButton:()

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

Custom the UI of Leave Meeting Alert.

Parameters
parentVCParent viewcontroller to present custom Participants UI.
endButtonThe endButton.

◆ onClickedInviteButton:addInviteActionItem:()

- (BOOL MobileRTCMeetingServiceDelegate) onClickedInviteButton: (UIViewController *_Nonnull)  parentVC
addInviteActionItem: (NSMutableArray *_Nonnull)  array 
optional

Customize the invitation event.

Parameters
parentVCParent viewcontroller to present custom Invite UI.
arrayAdd custom InviteActionItem to Invite ActionSheet.
Returns
NO if user wants to custom the invite items, add items to Invite ActionSheet via MobileRTCMeetingInviteActionItem. Otherwise YES, user will use the default UI.

◆ onClickedParticipantsButton:()

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

Custom the UI of Participants management.

Parameters
parentVCParent viewcontroller to present custom Participants UI.

◆ onClickedShareButton:addShareActionItem:()

- (BOOL MobileRTCMeetingServiceDelegate) onClickedShareButton: (UIViewController *_Nonnull)  parentVC
addShareActionItem: (NSMutableArray *_Nonnull)  array 
optional

User needs to click the SHARE button in meeting.

Returns
NO if user wants to custom Share Action Item, add items to Share ActionSheet via MobileRTCMeetingShareActionItem. Otherwise YES, user will use the default UI.

◆ onClickShareScreen:()

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

Callback event that user clicks the sharing screen.

Parameters
parentVCParent viewcontroller to present the view of Sharing Screen Usage Guide. Application will present Share Screen Usage Guide.

◆ onDialOutStatusChanged:()

- (void MobileRTCMeetingServiceDelegate) onDialOutStatusChanged: (DialOutStatus)  status
optional

Callback event that outgoing call status changes.

Parameters
statusNotify user the outgoing call status.

◆ onFreeMeetingNeedToUpgrade:giftUpgradeURL:()

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

Designated for notify the free meeting need upgrade.

Parameters
typeThe enumeration of FreeMeetingNeedUpgradeType, if the type is FreeMeetingNeedUpgradeType_BY_GIFTURL, user can upgrade free meeting through url. if the type is FreeMeetingNeedUpgradeType_BY_ADMIN, user can ask admin user to upgrade the meeting.
giftURLUser can upgrade the free meeting through the url.

◆ onFreeMeetingReminder:canFreeUpgrade:isFirstGift:completion:()

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

Inform user that free meeting will be ended in 10 minutes.

Parameters
hostYES means the original host of the current meeting, otherwise not.
freeUpgradeYES means the current free meeting will be upgraded. Once upgraded, the current meeting can last for more than 40 minutes.
firstand second time, meeting is no limit, from third time, will end meeting at 40 mins.
completionMobileRTC will call the module to upgrade the current meeting once the parameter UPGRADE is YES.

◆ onInMeetingChat:()

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

Callback event of new message.

Parameters
messageIDThe message ID.

◆ onJBHWaitingWithCmd:()

- (void MobileRTCMeetingServiceDelegate) onJBHWaitingWithCmd: (JBHCmd)  cmd
optional

Join a meeting without host, you can show/hide the custom JBH waiting UI.

Parameters
cmdShow/Hide JBH command.

◆ onJoinMeetingInfo:completion:()

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

Notify user to provide join meeting information: screen name or meeting password.

Parameters
displayNameUser needs to provide screen name to join a meeting.
passwordUser needs to provide meeting password to join a meeting.
cancelOnce the user cancels to provide screen name or meeting password, it is canceled to join the meeting.

◆ onMeetingEndedReason:()

- (void MobileRTCMeetingServiceDelegate) onMeetingEndedReason: (MobileRTCMeetingEndReason)  reason
optional

Meeting is ended by some reasons.

Parameters
reasonThe reason why meeting is ended.

◆ onMeetingError:message:()

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

Specified Meeting Errors.

Parameters
errorInternal error code.
messageThe message for meeting errors.

◆ onMeetingStateChange:()

- (void MobileRTCMeetingServiceDelegate) onMeetingStateChange: (MobileRTCMeetingState)  state
optional

Notify the user that the meeting status changes.

Parameters
stateThe meeting status changes.

◆ onNoHostMeetingWillTerminate:()

- (void MobileRTCMeetingServiceDelegate) onNoHostMeetingWillTerminate: (NSUInteger)  minutes
optional

Meeting without host will be ended after some-awhile.

Parameters
minutesThe minutes remaining to end the meeting.

◆ onProxyAuth:port:completion:()

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

Set to ask user to provide proxy information: username and password.

Parameters
hostProxy host.
portProxy port.
completionSDK will ask user to input proxy information once it detects the information changes.

◆ onRecordingStatus:()

- (void MobileRTCMeetingServiceDelegate) onRecordingStatus: (MobileRTCRecordingStatus)  status
optional

Recording status notify callback.

Parameters
statusrecording status.

◆ onSendPairingCodeStateChanged:MeetingNumber:()

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

Callback event while calling H.323 device, and you should input the pairing code.

Parameters
stateZERO(0) means pairing successfully, otherwise failed.
meetingNumberThe meetng number

◆ onSinkAttendeeChatPriviledgeChanged:()

- (void MobileRTCMeetingServiceDelegate) onSinkAttendeeChatPriviledgeChanged: (MobileRTCMeetingChatPriviledgeType)  currentPrivilege
optional

The function will be invoked when the chat privilege of attendees changes.

Parameters
currentPrivilegeThe chat privilege of the current attendee.
Warning
only normal meeting(non webinar meeting) can get the callback.

◆ onSubscribeUserFail:size:userId:()

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

Callback when subscribe fail.

Parameters
errorCodeerrorCode.
sizesubscribe size.
userIdsubscribe userId.
Warning
the call back only for Custom UI Mode.

◆ onUpgradeFreeMeetingResult:()

- (void MobileRTCMeetingServiceDelegate) onUpgradeFreeMeetingResult: (NSUInteger)  result
optional

The result of upgrading free meeting.

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

◆ onWaitExternalSessionKey:()

- (void MobileRTCMeetingServiceDelegate) onWaitExternalSessionKey: (NSData *_Nonnull)  key
optional

Notify user if the meeting is end to end.

Parameters
keyThe meeting session key.

The documentation for this protocol was generated from the following file: