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

#import <ZoomSDKMeetingActionController.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - onUserAudioStatusChange:
 Notification of user's audio status changes.
 
(void) - onUserJoin:
 Notification of user joins meeting.
 
(void) - onUserLeft:
 Notification of user leaves meeting.
 
(void) - onUserInfoUpdate:
 Upgrade the information of the specified user.
 
(void) - onHostChange:
 Notification of host changes.
 
(void) - onMeetingCoHostChanged:isCoHost:
 Notification of co-host changes.
 
(void) - onSpotlightVideoUserChange:
 Callback event for when the video spotlight user list changes.Spotlight user means that the view will show only the specified user and won't change the view even other users speak.
 
(void) - onVideoStatusChange:UserID:
 Notify that user's video status changes.
 
(void) - onLowOrRaiseHandStatusChange:UserID:
 Notification of user's hand status changes.
 
(void) - onJoinMeetingResponse:
 Callback event of user joins meeting.
 
(void) - onMultiToSingleShareNeedConfirm:
 Notify user to confirm or cancel to switch to single share from multi-share.
 
(void) - onActiveVideoUserChanged:
 Notify that video of active user changes.
 
(void) - onActiveSpeakerVideoUserChanged:
 Notify that video of active speaker changes.
 
(void) - onHostAskUnmute
 Notify that host ask you to unmute yourself.
 
(void) - onHostAskStartVideo
 Notify that host ask you to start video.
 
(void) - onUserActiveAudioChange:
 Notification of in-meeting active speakers.
 
(void) - onUserNamesChanged:
 Notification of user name changed.
 
(void) - onInvalidReclaimHostKey
 Notification of reclaim host key is invalid.
 
(void) - onHostVideoOrderUpdated:
 Notification the video order updated.
 
(void) - onLocalVideoOrderUpdated:
 Notification the local video order updated.
 
(void) - onFollowHostVideoOrderChanged:
 Notification the status of following host's video order changed.
 
(void) - onAllHandsLowered
 When the host calls the lower all hands interface, the host/cohost/panelist will receive this callback.
 
(void) - onUserVideoQualityChanged:userID:
 Notify that user's video quality changes.
 
(void) - onChatMsgDeleteNotification:messageDeleteType:
 Notify that the chat message deleted.
 
(void) - onChatStatusChangedNotification:
 Callback to notif that the privilege of participants/webinar chat has changed.
 
(void) - onShareMeetingChatStatusChanged:
 Notify that the share meeting chat status.
 
(void) - onSuspendParticipantsActivities
 Callback event when a meeting is suspended.
 
(void) - onAllowParticipantsStartVideoNotification:
 Callback event that lets participants start a video.
 
(void) - onAllowParticipantsRenameNotification:
 Callback event that lets participants rename themself.
 
(void) - onAllowParticipantsUnmuteSelfNotification:
 Callback event that lets participants unmute themself.
 
(void) - onAllowParticipantsShareWhiteBoardNotification:
 Callback event that lets participants share a new whiteboard.
 
(void) - onMeetingLockStatus:
 Callback event that allows a meeting lock status change.
 
(void) - onRequestLocalRecordingPrivilegeChanged:
 Callback event that requests local recording privilege changes.
 
(void) - onAllowParticipantsRequestCloudRecording:
 Callback event that lets participants request that the host starts cloud recording.
 
(void) - onInMeetingUserAvatarPathUpdated:
 Callback event that user's avatar path updated when in the meeting.
 
(void) - onAICompanionActiveChangeNotice:
 Sink the event that AI Companion active status changed.
 
(void) - onParticipantProfilePictureStatusChange:
 Sink the event that participant profile status change.
 
(void) - onVideoAlphaChannelStatusChanged:
 Callback event of alpha channel mode changes.
 
(void) - onFocusModeStateChanged:
 Sink the event that focus mode changed by Host/Co-Host.
 
(void) - onFocusModeShareTypeChanged:
 The focus mode share type was changed by the host or co-host.
 
(void) - onMeetingQAStatusChanged:
 Callback event of meeting QA feature status changes.
 
(void) - notifyToJoin3rdPartyTelephonyAudio:
 Callback event that requests to join third party telephony audio.
 

Detailed Description

Definition at line 416 of file ZoomSDKMeetingActionController.h.

Method Documentation

◆ notifyToJoin3rdPartyTelephonyAudio:

- (void) notifyToJoin3rdPartyTelephonyAudio: (NSString *)  audioInfo

Callback event that requests to join third party telephony audio.

Parameters
audioInfoInstruction on how to join the meeting with third party audio.

◆ onActiveSpeakerVideoUserChanged:

- (void) onActiveSpeakerVideoUserChanged: (unsigned int)  userID

Notify that video of active speaker changes.

Parameters
userIDThe user's user ID.

◆ onActiveVideoUserChanged:

- (void) onActiveVideoUserChanged: (unsigned int)  userID

Notify that video of active user changes.

Parameters
userIDThe user's user ID.

◆ onAICompanionActiveChangeNotice:

- (void) onAICompanionActiveChangeNotice: (BOOL)  active

Sink the event that AI Companion active status changed.

Parameters
activeYES means AI Companion is active.

◆ onAllHandsLowered

- (void) onAllHandsLowered

When the host calls the lower all hands interface, the host/cohost/panelist will receive this callback.

◆ onAllowParticipantsRenameNotification:

- (void) onAllowParticipantsRenameNotification: (BOOL)  allow

Callback event that lets participants rename themself.

Parameters
allowTrue allow. If false, participants may not rename themselves.

◆ onAllowParticipantsRequestCloudRecording:

- (void) onAllowParticipantsRequestCloudRecording: (BOOL)  allow

Callback event that lets participants request that the host starts cloud recording.

Parameters
allowYES allow. If NO, disallow.

◆ onAllowParticipantsShareWhiteBoardNotification:

- (void) onAllowParticipantsShareWhiteBoardNotification: (BOOL)  allow

Callback event that lets participants share a new whiteboard.

Parameters
allowTrue allow. If false, participants may not share new whiteboard.

◆ onAllowParticipantsStartVideoNotification:

- (void) onAllowParticipantsStartVideoNotification: (BOOL)  allow

Callback event that lets participants start a video.

Parameters
allowTrue allow. If false, disallow.

◆ onAllowParticipantsUnmuteSelfNotification:

- (void) onAllowParticipantsUnmuteSelfNotification: (BOOL)  allow

Callback event that lets participants unmute themself.

Parameters
allowTrue allow. If false, participants may not unmute themselves.

◆ onChatMsgDeleteNotification:messageDeleteType:

- (void) onChatMsgDeleteNotification: (NSString *)  msgID
messageDeleteType: (ZoomSDKChatMessageDeleteType deleteBy 

Notify that the chat message deleted.

Parameters
msgIDThe ID of deleted chat message.
deleteByIndicates the message was deleted by whom.

◆ onChatStatusChangedNotification:

- (void) onChatStatusChangedNotification: (ZoomSDKChatStatus *)  chatStatus

Callback to notif that the privilege of participants/webinar chat has changed.

Parameters
chatStatusThe info of the privilege.For detail,see ZoomSDKChatStatus.

◆ onFocusModeShareTypeChanged:

- (void) onFocusModeShareTypeChanged: (ZoomSDKFocusModeShareType shareType

The focus mode share type was changed by the host or co-host.

Parameters
shareTypeShare type change. For detail, see ZoomSDKFocusModeShareType.

◆ onFocusModeStateChanged:

- (void) onFocusModeStateChanged: (BOOL)  on

Sink the event that focus mode changed by Host/Co-Host.

Parameters
onYES means the focus mode change to on, otherwise NO.

◆ onFollowHostVideoOrderChanged:

- (void) onFollowHostVideoOrderChanged: (BOOL)  follow

Notification the status of following host's video order changed.

Parameters
followYes means the option of following host's video order is on, otherwise not.

◆ onHostAskStartVideo

- (void) onHostAskStartVideo

Notify that host ask you to start video.

◆ onHostAskUnmute

- (void) onHostAskUnmute

Notify that host ask you to unmute yourself.

◆ onHostChange:

- (void) onHostChange: (unsigned int)  userID

Notification of host changes.

Parameters
userIDUser ID of new host.

◆ onHostVideoOrderUpdated:

- (void) onHostVideoOrderUpdated: (NSArray *)  orderList

Notification the video order updated.

Parameters
orderListThe order list contains the user ID of listed users.

◆ onInMeetingUserAvatarPathUpdated:

- (void) onInMeetingUserAvatarPathUpdated: (unsigned int)  userID

Callback event that user's avatar path updated when in the meeting.

Parameters
userIDThe ID of user whose avatar path updated.

◆ onInvalidReclaimHostKey

- (void) onInvalidReclaimHostKey

Notification of reclaim host key is invalid.

◆ onJoinMeetingResponse:

- (void) onJoinMeetingResponse: (ZoomSDKJoinMeetingHelper *)  joinMeetingHelper

Callback event of user joins meeting.

Parameters
joinMeetingHelperAn object for inputing password or canceling to join meeting.

◆ onLocalVideoOrderUpdated:

- (void) onLocalVideoOrderUpdated: (NSArray *)  localOrderList

Notification the local video order updated.

Parameters
localOrderListThe lcoal vidoe order list contains the user ID of listed users.

◆ onLowOrRaiseHandStatusChange:UserID:

- (void) onLowOrRaiseHandStatusChange: (BOOL)  raise
UserID: (unsigned int)  userID 

Notification of user's hand status changes.

Parameters
raiseYES means that the specified user raises hand, otherwise, puts hand down.
userIDThe ID of user whose hand status changes.

◆ onMeetingCoHostChanged:isCoHost:

- (void) onMeetingCoHostChanged: (unsigned int)  userID
isCoHost: (BOOL)  isCoHost 

Notification of co-host changes.

Parameters
userIDUser ID with coHost privilege changes.
isCoHostYES indicates that the specified user is co-host.

◆ onMeetingLockStatus:

- (void) onMeetingLockStatus: (BOOL)  isLock

Callback event that allows a meeting lock status change.

Parameters
allowIf true, the status is locked. If false, the status is unlocked.

◆ onMeetingQAStatusChanged:

- (void) onMeetingQAStatusChanged: (BOOL)  isMeetingQAFeatureOn

Callback event of meeting QA feature status changes.

Parameters
isMeetingQAFeatureOnYES means meeting QA feature is on, otherwise not.

◆ onMultiToSingleShareNeedConfirm:

- (void) onMultiToSingleShareNeedConfirm: (ZoomSDKMultiToSingleShareConfirmHandler *)  confirmHandle

Notify user to confirm or cancel to switch to single share from multi-share.

Parameters
confirmHandleAn object used to handle the action to switch to single share from multi-share.

◆ onParticipantProfilePictureStatusChange:

- (void) onParticipantProfilePictureStatusChange: (BOOL)  hidden

Sink the event that participant profile status change.

Parameters
hiddenYES means hide participant profile picture, NO means show participant profile picture.

◆ onRequestLocalRecordingPrivilegeChanged:

- (void) onRequestLocalRecordingPrivilegeChanged: (ZoomSDKLocalRecordingRequestPrivilegeStatus status

Callback event that requests local recording privilege changes.

Parameters
statusValue of request for local recording privilege status. For detail, see ZoomSDKLocalRecordingRequestPrivilegeStatus.

◆ onShareMeetingChatStatusChanged:

- (void) onShareMeetingChatStatusChanged: (BOOL)  isStart

Notify that the share meeting chat status.

Parameters
isStartYES means share meeting chat is started, otherwise not.

◆ onSpotlightVideoUserChange:

- (void) onSpotlightVideoUserChange: (NSArray *)  spotlightedUserList

Callback event for when the video spotlight user list changes.Spotlight user means that the view will show only the specified user and won't change the view even other users speak.

Parameters
spotlightedUserListSpotlight user list.

◆ onSuspendParticipantsActivities

- (void) onSuspendParticipantsActivities

Callback event when a meeting is suspended.

◆ onUserActiveAudioChange:

- (void) onUserActiveAudioChange: (NSArray *)  useridArray

Notification of in-meeting active speakers.

Parameters
useridArrayThe array contain userid of the active speakers.

◆ onUserAudioStatusChange:

- (void) onUserAudioStatusChange: (NSArray *)  userAudioStatusArray

Notification of user's audio status changes.

Parameters
userAudioStatusArrayAn array contains ZoomSDKUserAudioStatus elements of each user's audio status.

◆ onUserInfoUpdate:

- (void) onUserInfoUpdate: (unsigned int)  userID

Upgrade the information of the specified user.

Parameters
userIDThe ID of the specified user.

◆ onUserJoin:

- (void) onUserJoin: (NSArray *)  array

Notification of user joins meeting.

Parameters
arrayArray of users who join meeting.

◆ onUserLeft:

- (void) onUserLeft: (NSArray *)  array

Notification of user leaves meeting.

Parameters
arrayArray of users leave meeting.

◆ onUserNamesChanged:

- (void) onUserNamesChanged: (NSArray< NSNumber * > *)  userList

Notification of user name changed.

Parameters
userListThe list of user whose user name have changed.
Note
The old interface - (void)onUserNameChanged:(unsigned int)userid userName:(NSString *)userName; will be marked as deprecated, and all platforms will be using this new callbacks. This is because in a webinar, when the host renamed an attendee, only the attendee could receive the old callback, and the host/cohost/panlist is not able to receive it, which leads to the developer not being able to update the UI.

◆ onUserVideoQualityChanged:userID:

- (void) onUserVideoQualityChanged: (ZoomSDKVideoQuality quality
userID: (unsigned int)  userID 

Notify that user's video quality changes.

Parameters
qualityThe quality of the Video.
userIDThe ID of user whose video quality changed.

◆ onVideoAlphaChannelStatusChanged:

- (void) onVideoAlphaChannelStatusChanged: (BOOL)  isAlphaModeOn

Callback event of alpha channel mode changes.

Parameters
isAlphaModeOnYES means it's in alpha channel mode. Otherwise, it's not.

◆ onVideoStatusChange:UserID:

- (void) onVideoStatusChange: (ZoomSDKVideoStatus videoStatus
UserID: (unsigned int)  userID 

Notify that user's video status changes.

Parameters
videoStatusThe status of the video.For detail,see ZoomSDKVideoStatus.
userIDThe ID of user who video status changes.