<ZoomSDKMeetingActionControllerDelegate> Protocol Reference

Protocol for receiving meeting events such as user join, leave, and audio status changes. More...

#include <ZoomSDKMeetingActionController.h>

Inherits <NSObjectNSObject>.

Instance Methods
(void)	- onUserAudioStatusChange:
	Notification of audio status of the user changes.
(void)	- onUserJoin:
	Notification of user joins meeting.
(void)	- onUserLeft:
	Notification of user leaves meeting.
(void)	- onUserInfoUpdate:
	Upgrade the information of specified user.
(void)	- onVirtualNameTagStatusChanged:userID:
	Notification of virtual name tag status change.
(void)	- onVirtualNameTagRosterInfoUpdated:
	Notification of virtual name tag roster info update.
(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 shows only the specified user and won't change the view even other users speak.
(void)	- onVideoStatusChange:UserID:
	Notify that video status of the user changes.
(void)	- onLowOrRaiseHandStatusChange:UserID:
	Notification of hand status of the user 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, or panelist receives 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 notify that the privilege of participants or 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 or 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.
(void)	- onCameraControlRequestReceived:requestType:actionApprove:actionDecline:
	Callback for when the current user receives a camera control request. This callback triggers when another user requests control of the current user’s camera.
(void)	- onCameraControlRequestResult:resultType:
	Callback for when the current user is granted camera control access. Once the current user sends the camera control request, this callback triggers when they receive a request result.
(void)	- onMuteOnEntryStatusChange:
	Callback event for the mute on entry status change.
(void)	- onMeetingTopicChanged:
	Callback event for the meeting topic changed.
(void)	- onBotAuthorizerRelationChanged:
	Callback event that the bot relationship changed in the meeting.
(void)	- onCreateCompanionRelation:childUserID:
	Callback event that the companion relationship created in the meeting.
(void)	- onRemoveCompanionRelation:
	Callback event that the companion relationship removed in the meeting.
(void)	- onGrantCoOwnerPrivilegeChanged:
	Callback event when the grant co-owner permission changed.

Detailed Description

Protocol for receiving meeting events such as user join, leave, and audio status changes.

Definition at line 569 of file ZoomSDKMeetingActionController.h.

Method Documentation

notifyToJoin3rdPartyTelephonyAudio:

- (void) notifyToJoin3rdPartyTelephonyAudio:

(NSString *)

audioInfo

Callback event that requests to join third party telephony audio.

Parameters

audioInfo

Instruction on how to join the meeting with third party audio.

onActiveSpeakerVideoUserChanged:

- (void) onActiveSpeakerVideoUserChanged:

(unsigned int)

userID

Notify that video of active speaker changes.

Parameters

userID

The user ID.

onActiveVideoUserChanged:

- (void) onActiveVideoUserChanged:

(unsigned int)

userID

Notify that video of active user changes.

Parameters

userID

The user ID.

onAICompanionActiveChangeNotice:

- (void) onAICompanionActiveChangeNotice:

(BOOL)

active

Sink the event that AI Companion active status changed.

Parameters

active

YES if AI Companion is active, NO otherwise.

onAllHandsLowered

- (void) onAllHandsLowered

When the host calls the lower all hands interface, the host, cohost, or panelist receives this callback.

onAllowParticipantsRenameNotification:

- (void) onAllowParticipantsRenameNotification:

(BOOL)

allow

Callback event that lets participants rename themself.

Parameters

allow

YES allow. If NO, participants may not rename themselves.

onAllowParticipantsRequestCloudRecording:

- (void) onAllowParticipantsRequestCloudRecording:

(BOOL)

allow

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

Parameters

allow

YES allow. If NO, disallow.

onAllowParticipantsShareWhiteBoardNotification:

- (void) onAllowParticipantsShareWhiteBoardNotification:

(BOOL)

allow

Callback event that lets participants share a new whiteboard.

Parameters

allow

YES allow. If NO, participants may not share new whiteboard.

onAllowParticipantsStartVideoNotification:

- (void) onAllowParticipantsStartVideoNotification:

(BOOL)

allow

Callback event that lets participants start a video.

Parameters

allow

YES allow. If NO, disallow.

onAllowParticipantsUnmuteSelfNotification:

- (void) onAllowParticipantsUnmuteSelfNotification:

(BOOL)

allow

Callback event that lets participants unmute themself.

Parameters

allow

YES allow. If NO, participants may not unmute themselves.

onBotAuthorizerRelationChanged:

- (void) onBotAuthorizerRelationChanged:

(unsigned int)

authorizeUserID

Callback event that the bot relationship changed in the meeting.

Parameters

authorizeUserID

Specify the authorizer user ID.

onCameraControlRequestReceived:requestType:actionApprove:actionDecline:

- (void) onCameraControlRequestReceived:		(unsigned int)	userId
requestType:		(ZoomSDKCameraControlRequestType)	requestType
actionApprove:		(nullable ZoomSDKError(^)(void))	actionApprove
actionDecline:		(nullable ZoomSDKError(^)(void))	actionDecline

Callback for when the current user receives a camera control request. This callback triggers when another user requests control of the current user’s camera.

Parameters

userId	The user ID that sent the request.
requestType	The request type.
actionApprove	Execute this block to approve.
actionDecline	Execute this block to decline.

onCameraControlRequestResult:resultType:

- (void) onCameraControlRequestResult:		(unsigned int)	userId
resultType:		(ZoomSDKCameraControlRequestResult)	resultType

Callback for when the current user is granted camera control access. Once the current user sends the camera control request, this callback triggers when they receive a request result.

Parameters

userId	The user ID that response the request.
resultType	The result type.

onChatMsgDeleteNotification:messageDeleteType:

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

Notify that the chat message deleted.

Parameters

msgID	The ID of deleted chat message.
deleteBy	Indicates the message was deleted by whom.

onChatStatusChangedNotification:

- (void) onChatStatusChangedNotification:

(ZoomSDKChatStatus *)

chatStatus

Callback to notify that the privilege of participants or webinar chat has changed.

Parameters

chatStatus

The privilege's info.

onCreateCompanionRelation:childUserID:

- (void) onCreateCompanionRelation:		(unsigned int)	parentUserID
childUserID:		(unsigned int)	childUserID

Callback event that the companion relationship created in the meeting.

Parameters

parentUserID	Specify the parent user ID.
childUserID	Specify the child user ID.

onFocusModeShareTypeChanged:

- (void) onFocusModeShareTypeChanged:

(ZoomSDKFocusModeShareType)

shareType

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

Parameters

shareType

Share type change.

onFocusModeStateChanged:

- (void) onFocusModeStateChanged:

(BOOL)

on

Sink the event that focus mode changed by host or co-host.

Parameters

on	YES if the focus mode change to on, NO otherwise.

onFollowHostVideoOrderChanged:

- (void) onFollowHostVideoOrderChanged:

(BOOL)

follow

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

Parameters

follow

Yes means the option of following host's video order is on, NO otherwise.

onGrantCoOwnerPrivilegeChanged:

- (void) onGrantCoOwnerPrivilegeChanged:

(BOOL)

canGrantOther

Callback event when the grant co-owner permission changed.

Parameters

canGrantOther

YES if can grant others, NO otherwise.

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

userID

User ID of new host.

onHostVideoOrderUpdated:

- (void) onHostVideoOrderUpdated:

(NSArray *)

orderList

Notification the video order updated.

Parameters

orderList

The 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

userID

The ID of user whose avatar path updated.

onInvalidReclaimHostKey

- (void) onInvalidReclaimHostKey

Notification of reclaim host key is invalid.

onJoinMeetingResponse:

- (void) onJoinMeetingResponse:

(ZoomSDKJoinMeetingHelper *_Nullable)

joinMeetingHelper

Callback event of user joins meeting.

Parameters

joinMeetingHelper

An object for inputing password or canceling to join meeting.

onLocalVideoOrderUpdated:

- (void) onLocalVideoOrderUpdated:

(NSArray *)

localOrderList

Notification the local video order updated.

Parameters

localOrderList

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

onLowOrRaiseHandStatusChange:UserID:

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

Notification of hand status of the user changes.

Parameters

raise	YES if the specified user raises hand, NO if puts hand down.
userID	The ID of user whose hand status changes.

onMeetingCoHostChanged:isCoHost:

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

Notification of co-host changes.

Parameters

userID	User ID with coHost privilege changes.
isCoHost	YES indicates that the specified user is co-host, NO otherwise.

onMeetingLockStatus:

- (void) onMeetingLockStatus:

(BOOL)

isLock

Callback event that allows a meeting lock status change.

Parameters

isLock

If YES, the status is locked. If NO, the status is unlocked.

onMeetingQAStatusChanged:

- (void) onMeetingQAStatusChanged:

(BOOL)

isMeetingQAFeatureOn

Callback event of meeting QA feature status changes.

Parameters

isMeetingQAFeatureOn

YES if meeting QA feature is on, NO otherwise.

onMeetingTopicChanged:

- (void) onMeetingTopicChanged:

(NSString *)

topic

Callback event for the meeting topic changed.

Parameters

topic

The new meeting topic.

onMultiToSingleShareNeedConfirm:

- (void) onMultiToSingleShareNeedConfirm:

(ZoomSDKMultiToSingleShareConfirmHandler *_Nullable)

confirmHandle

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

Parameters

confirmHandle

An object that handles the action to switch to single share from multi-share.

onMuteOnEntryStatusChange:

- (void) onMuteOnEntryStatusChange:

(BOOL)

enable

Callback event for the mute on entry status change.

Parameters

enable

Specify whether mute on entry is enabled or not.

onParticipantProfilePictureStatusChange:

- (void) onParticipantProfilePictureStatusChange:

(BOOL)

hidden

Sink the event that participant profile status change.

Parameters

hidden

YES to hide participant profile picture, NO to show participant profile picture.

onRemoveCompanionRelation:

- (void) onRemoveCompanionRelation:

(unsigned int)

childUserID

Callback event that the companion relationship removed in the meeting.

Parameters

childUserID

Specify the child user ID.

onRequestLocalRecordingPrivilegeChanged:

- (void) onRequestLocalRecordingPrivilegeChanged:

(ZoomSDKLocalRecordingRequestPrivilegeStatus)

status

Callback event that requests local recording privilege changes.

Parameters

status

Value of request for local recording privilege status.

onShareMeetingChatStatusChanged:

- (void) onShareMeetingChatStatusChanged:

(BOOL)

isStart

Notify that the share meeting chat status.

Parameters

isStart

YES if share meeting chat is started, NO otherwise.

onSpotlightVideoUserChange:

- (void) onSpotlightVideoUserChange:

(NSArray *_Nullable)

spotlightedUserList

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

Parameters

spotlightedUserList

Spotlight user list.

onSuspendParticipantsActivities

- (void) onSuspendParticipantsActivities

Callback event when a meeting is suspended.

onUserActiveAudioChange:

- (void) onUserActiveAudioChange:

(NSArray *)

useridArray

Notification of in-meeting active speakers.

Parameters

useridArray

The active's array contain userid speakers.

onUserAudioStatusChange:

- (void) onUserAudioStatusChange:

(NSArray *)

userAudioStatusArray

Notification of audio status of the user changes.

Parameters

userAudioStatusArray

An array contains ZoomSDKUserAudioStatus elements of each audio status of the user.

onUserInfoUpdate:

- (void) onUserInfoUpdate:

(unsigned int)

userID

Upgrade the information of specified user.

Parameters

userID

The specified' user's ID.

Deprecated

This method is no longer used.

onUserJoin:

- (void) onUserJoin:

(NSArray *)

array

Notification of user joins meeting.

Parameters

array

Array of users who join meeting.

onUserLeft:

- (void) onUserLeft:

(NSArray *)

array

Notification of user leaves meeting.

Parameters

array

Array of users leave meeting.

onUserNamesChanged:

- (void) onUserNamesChanged:

(NSArray< NSNumber * > *)

userList

Notification of user name changed.

Parameters

userList

The 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, or panelist 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

quality	The Video's quality.
userID	The ID of user whose video quality changed.

onVideoAlphaChannelStatusChanged:

- (void) onVideoAlphaChannelStatusChanged:

(BOOL)

isAlphaModeOn

Callback event of alpha channel mode changes.

Parameters

isAlphaModeOn

YES if in alpha channel mode, NO otherwise.

onVideoStatusChange:UserID:

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

Notify that video status of the user changes.

Parameters

videoStatus	The video's status.
userID	The ID of user who video status changes.

onVirtualNameTagRosterInfoUpdated:

- (void) onVirtualNameTagRosterInfoUpdated:

(unsigned int)

userID

Notification of virtual name tag roster info update.

Parameters

userID

The ID of user who virtual name tag status changed.

onVirtualNameTagStatusChanged:userID:

- (void) onVirtualNameTagStatusChanged:		(BOOL)	bOn
userID:		(unsigned int)	userID

Notification of virtual name tag status change.

Parameters

bOn	YES if virtual name tag is turned on, NO otherwise.
userID	The ID of user who virtual name tag status changed.