Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
<ZoomSDKMeetingServiceDelegate> Protocol Reference

#include <ZoomSDKMeetingService.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - onMeetingStatusChange:meetingError:EndReason:
 Notify if ZOOM meeting status Changes.
 
(void) - onMeetingStatisticWarning:
 Notification of statistic warnings of Zoom Meeting.
 
(void) - onFreeMeetingNeedToUpgrade:giftUpgradeURL:
 Designated for notify the free meeting need upgrade.
 
(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.
 
(void) - onFreeMeetingRemainTimeStopCountDown
 Designated for notify the free meeting remain time has been stoped to count down.
 
(void) - onFreeMeetingRemainTime:
 Inform user the remaining time of free meeting.
 
(void) - onMeetingParameterNotification:
 Meeting parameter notification callback,The callback will be triggered right before the meeting starts. The meetingParameter will be destroyed once the function calls end.
 
(void) - onJoinMeetingNeedUserInfo:
 The function is invoked when a user joins a meeting that needs their username and email.
 
(void) - onUserConfirmToStartArchive:
 Callback event when joining a meeting if the admin allows the user to choose to archive the meeting.
 
(void) - onEndOtherMeetingToJoinMeetingNotification:actionCancel:
 Callback event when join a meeting while the meeting is ongoing.
 
(void) - onMeetingFullToWatchLiveStream:
 Calback event that the meeting users have reached the meeting capacity. The new join user can not join the meeting, but they can watch the meeting live stream.
 
(void) - onUserConfirmRecoverMeeting:
 Callback event when host starts a deleted or expired meeting (not a PMI meeting).
 

Detailed Description

Definition at line 321 of file ZoomSDKMeetingService.h.

Method Documentation

◆ onEndOtherMeetingToJoinMeetingNotification:actionCancel:

- (void) onEndOtherMeetingToJoinMeetingNotification: (ZoomSDKError(^)(void)) actionEndOtherMeeting
actionCancel: (void(^)(void)) actionCancel 
optionalrequired

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

Parameters
actionEndOtherMeetingblock to end other meeting.
actionCancelblock to cancel join meeting.

◆ onFreeMeetingNeedToUpgrade:giftUpgradeURL:

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

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.

◆ onFreeMeetingRemainTime:

- (void) onFreeMeetingRemainTime: (unsigned int) seconds
optionalrequired

Inform user the remaining time of free meeting.

Parameters
secondsThe remaining time of the free meeting.

◆ onFreeMeetingRemainTimeStopCountDown

- (void) onFreeMeetingRemainTimeStopCountDown
optionalrequired

Designated for notify the free meeting remain time has been stoped to count down.

◆ onFreeMeetingUpgradedToProMeeting

- (void) onFreeMeetingUpgradedToProMeeting
optionalrequired

Designated for notify the free meeting has been upgraded to professional meeting.

◆ onFreeMeetingUpgradeToGiftFreeTrialStart

- (void) onFreeMeetingUpgradeToGiftFreeTrialStart
optionalrequired

Designated for notify the free meeting which has been upgraded to free trail meeting has started.

◆ onFreeMeetingUpgradeToGiftFreeTrialStop

- (void) onFreeMeetingUpgradeToGiftFreeTrialStop
optionalrequired

Designated for notify the free meeting which has been upgraded to free trail meeting has stoped.

◆ onJoinMeetingNeedUserInfo:

- (void) onJoinMeetingNeedUserInfo: (ZoomSDKMeetingInputUserInfoHandler *_Nullable) handler
optionalrequired

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

Parameters
handlerConfigure information or leave meeting, see ZoomSDKMeetingInputUserInfoHandler.

◆ onMeetingFullToWatchLiveStream:

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

Calback event that the meeting users have reached the meeting capacity. The new join user can not join the meeting, but they can watch the meeting live stream.

Parameters
liveStreamUrlthe live stream URL to watch the meeting live stream.

◆ onMeetingParameterNotification:

- (void) onMeetingParameterNotification: (ZoomSDKMeetingParameter *_Nullable) meetingParameter
optionalrequired

Meeting parameter notification callback,The callback will be triggered right before the meeting starts. The meetingParameter will be destroyed once the function calls end.

Parameters
meetingParameterMeeting parameter.

◆ onMeetingStatisticWarning:

- (void) onMeetingStatisticWarning: (StatisticWarningType) type
optionalrequired

Notification of statistic warnings of Zoom Meeting.

Parameters
typeThe statistic type.

◆ onMeetingStatusChange:meetingError:EndReason:

- (void) onMeetingStatusChange: (ZoomSDKMeetingStatus) state
meetingError: (ZoomSDKMeetingError) error
EndReason: (EndMeetingReason) reason 
optional

Notify if ZOOM meeting status Changes.

Parameters
stateThe status of ZOOM meeting.
errorThe enum of ZoomSDKMeetingError.
reasonThe enum of EndMeetingReason.

◆ onUserConfirmRecoverMeeting:

- (void) onUserConfirmRecoverMeeting: (ZoomSDKRecoverMeetingHandler *_Nullable) handler
optionalrequired

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

Parameters
handlerThe handler for the host user to handle recover or not.

◆ onUserConfirmToStartArchive:

- (void) onUserConfirmToStartArchive: (ZoomSDKMeetingArchiveConfirmHandler *_Nullable) handler
optionalrequired

Callback event when joining a meeting if the admin allows the user to choose to archive the meeting.

Parameters
handlerThe handler for the user to choose whether to archive the meeting when joining the meeting.