Meeting SDK for macOS API 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. | |
Definition at line 416 of file ZoomSDKMeetingActionController.h.
- (void) notifyToJoin3rdPartyTelephonyAudio: | (NSString *) | audioInfo |
Callback event that requests to join third party telephony audio.
audioInfo | Instruction on how to join the meeting with third party audio. |
- (void) onActiveSpeakerVideoUserChanged: | (unsigned int) | userID |
Notify that video of active speaker changes.
userID | The user's user ID. |
- (void) onActiveVideoUserChanged: | (unsigned int) | userID |
Notify that video of active user changes.
userID | The user's user ID. |
- (void) onAICompanionActiveChangeNotice: | (BOOL) | active |
Sink the event that AI Companion active status changed.
active | YES means AI Companion is active. |
- (void) onAllHandsLowered |
When the host calls the lower all hands interface, the host/cohost/panelist will receive this callback.
- (void) onAllowParticipantsRenameNotification: | (BOOL) | allow |
Callback event that lets participants rename themself.
allow | True allow. If false, participants may not rename themselves. |
- (void) onAllowParticipantsRequestCloudRecording: | (BOOL) | allow |
Callback event that lets participants request that the host starts cloud recording.
allow | YES allow. If NO, disallow. |
- (void) onAllowParticipantsShareWhiteBoardNotification: | (BOOL) | allow |
Callback event that lets participants share a new whiteboard.
allow | True allow. If false, participants may not share new whiteboard. |
- (void) onAllowParticipantsStartVideoNotification: | (BOOL) | allow |
Callback event that lets participants start a video.
allow | True allow. If false, disallow. |
- (void) onAllowParticipantsUnmuteSelfNotification: | (BOOL) | allow |
Callback event that lets participants unmute themself.
allow | True allow. If false, participants may not unmute themselves. |
- (void) onChatMsgDeleteNotification: | (NSString *) | msgID | |
messageDeleteType: | (ZoomSDKChatMessageDeleteType) | deleteBy | |
Notify that the chat message deleted.
msgID | The ID of deleted chat message. |
deleteBy | Indicates the message was deleted by whom. |
- (void) onChatStatusChangedNotification: | (ZoomSDKChatStatus *) | chatStatus |
Callback to notif that the privilege of participants/webinar chat has changed.
chatStatus | The info of the privilege.For detail,see ZoomSDKChatStatus . |
- (void) onFocusModeShareTypeChanged: | (ZoomSDKFocusModeShareType) | shareType |
The focus mode share type was changed by the host or co-host.
shareType | Share type change. For detail, see ZoomSDKFocusModeShareType . |
- (void) onFocusModeStateChanged: | (BOOL) | on |
Sink the event that focus mode changed by Host/Co-Host.
on | YES means the focus mode change to on, otherwise NO. |
- (void) onFollowHostVideoOrderChanged: | (BOOL) | follow |
Notification the status of following host's video order changed.
follow | Yes means the option of following host's video order is on, otherwise not. |
- (void) onHostAskStartVideo |
Notify that host ask you to start video.
- (void) onHostAskUnmute |
Notify that host ask you to unmute yourself.
- (void) onHostChange: | (unsigned int) | userID |
Notification of host changes.
userID | User ID of new host. |
- (void) onHostVideoOrderUpdated: | (NSArray *) | orderList |
Notification the video order updated.
orderList | The order list contains the user ID of listed users. |
- (void) onInMeetingUserAvatarPathUpdated: | (unsigned int) | userID |
Callback event that user's avatar path updated when in the meeting.
userID | The ID of user whose avatar path updated. |
- (void) onInvalidReclaimHostKey |
Notification of reclaim host key is invalid.
- (void) onJoinMeetingResponse: | (ZoomSDKJoinMeetingHelper *) | joinMeetingHelper |
Callback event of user joins meeting.
joinMeetingHelper | An object for inputing password or canceling to join meeting. |
- (void) onLocalVideoOrderUpdated: | (NSArray *) | localOrderList |
Notification the local video order updated.
localOrderList | The lcoal vidoe order list contains the user ID of listed users. |
- (void) onLowOrRaiseHandStatusChange: | (BOOL) | raise | |
UserID: | (unsigned int) | userID | |
Notification of user's hand status changes.
raise | YES means that the specified user raises hand, otherwise, puts hand down. |
userID | The ID of user whose hand status changes. |
- (void) onMeetingCoHostChanged: | (unsigned int) | userID | |
isCoHost: | (BOOL) | isCoHost | |
Notification of co-host changes.
userID | User ID with coHost privilege changes. |
isCoHost | YES indicates that the specified user is co-host. |
- (void) onMeetingLockStatus: | (BOOL) | isLock |
Callback event that allows a meeting lock status change.
allow | If true, the status is locked. If false, the status is unlocked. |
- (void) onMeetingQAStatusChanged: | (BOOL) | isMeetingQAFeatureOn |
Callback event of meeting QA feature status changes.
isMeetingQAFeatureOn | YES means meeting QA feature is on, otherwise not. |
- (void) onMultiToSingleShareNeedConfirm: | (ZoomSDKMultiToSingleShareConfirmHandler *) | confirmHandle |
Notify user to confirm or cancel to switch to single share from multi-share.
confirmHandle | An object used to handle the action to switch to single share from multi-share. |
- (void) onParticipantProfilePictureStatusChange: | (BOOL) | hidden |
Sink the event that participant profile status change.
hidden | YES means hide participant profile picture, NO means show participant profile picture. |
- (void) onRequestLocalRecordingPrivilegeChanged: | (ZoomSDKLocalRecordingRequestPrivilegeStatus) | status |
Callback event that requests local recording privilege changes.
status | Value of request for local recording privilege status. For detail, see ZoomSDKLocalRecordingRequestPrivilegeStatus . |
- (void) onShareMeetingChatStatusChanged: | (BOOL) | isStart |
Notify that the share meeting chat status.
isStart | YES means share meeting chat is started, otherwise not. |
- (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.
spotlightedUserList | Spotlight user list. |
- (void) onSuspendParticipantsActivities |
Callback event when a meeting is suspended.
- (void) onUserActiveAudioChange: | (NSArray *) | useridArray |
Notification of in-meeting active speakers.
useridArray | The array contain userid of the active speakers. |
- (void) onUserAudioStatusChange: | (NSArray *) | userAudioStatusArray |
Notification of user's audio status changes.
userAudioStatusArray | An array contains ZoomSDKUserAudioStatus elements of each user's audio status. |
- (void) onUserInfoUpdate: | (unsigned int) | userID |
Upgrade the information of the specified user.
userID | The ID of the specified user. |
- (void) onUserJoin: | (NSArray *) | array |
Notification of user joins meeting.
array | Array of users who join meeting. |
- (void) onUserLeft: | (NSArray *) | array |
Notification of user leaves meeting.
array | Array of users leave meeting. |
- (void) onUserNamesChanged: | (NSArray< NSNumber * > *) | userList |
Notification of user name changed.
userList | The list of user whose user name have changed. |
- (void) onUserVideoQualityChanged: | (ZoomSDKVideoQuality) | quality | |
userID: | (unsigned int) | userID | |
Notify that user's video quality changes.
quality | The quality of the Video. |
userID | The ID of user whose video quality changed. |
- (void) onVideoAlphaChannelStatusChanged: | (BOOL) | isAlphaModeOn |
Callback event of alpha channel mode changes.
isAlphaModeOn | YES means it's in alpha channel mode. Otherwise, it's not. |
- (void) onVideoStatusChange: | (ZoomSDKVideoStatus) | videoStatus | |
UserID: | (unsigned int) | userID | |
Notify that user's video status changes.
videoStatus | The status of the video.For detail,see ZoomSDKVideoStatus . |
userID | The ID of user who video status changes. |