Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingActionController Class Reference

#import <ZoomSDKMeetingActionController.h>

Inherits NSObject.

Instance Methods

(NSArray *) - getParticipantsList
 Get the list of participants.
 
(ZoomSDKError- actionMeetingWithCmd:userID:onScreen:
 Commands in the meeting.
 
(ZoomSDKError- sendChat:toUser:chatType:
 Send a chat message.
 
(ZoomSDKUserInfo *) - getUserByUserID:
 Get the information of the specified user.
 
(ZoomSDKUserInfo *) - getMyself
 Get the information of myself.
 
(ZoomSDKError- changeUserName:newName:
 Change user's screen name in the meeting.
 
(ZoomSDKError- makeHost:
 Assign a participant to be a new host, or original host who loose the privilege reclaims to be the host.
 
(ZoomSDKError- raiseHand:UserID:
 Make the specified user to raise hand or lower hand.
 
(ZoomSDKError- expelUser:
 Remove the specified user from meeting.
 
(ZoomSDKError- startCMR:
 Start or stop the cloud recording.
 
(ZoomSDKError- getMeetingUIType:isFullScreen:meetingUIType:
 Get the meeting UI display type.
 
(ZoomSDKError- allowLocalRecord:UserID:
 Allow or disallow the specified user to local recording.
 
(BOOL) - canReclaimHost
 Query if user can claim host(be host) or not.
 
(ZoomSDKError- reclaimHost
 Reclaim the role of the host.
 
(ZoomSDKError- claimHostByKey:
 Normal participant claims host by host-key.
 
(ZoomSDKError- assignCoHost:
 Assign a user as co-host in meeting.
 
(ZoomSDKError- revokeCoHost:
 Revoke co-host role of another user in meeting.
 
(ZoomSDKError- setShareSettingType:
 Set sharing types for the host or co-host in meeting.
 
(ZoomSDKError- getShareSettingType:
 Get the sharing types for the host or co-host in meeting.
 
(BOOL) - isUseOriginalSoundOn
 Determine if user's original sound is enabled.
 
(ZoomSDKError- enableUseOriginalSound:
 Set to output original sound of mic in meeting.
 
(BOOL) - isSupportUseOriginalSound
 Determine if the meeting supports user's original sound.
 
(ZoomSDKError- swapToShowShareViewOrVideo:
 Swap to show sharing screen or video.
 
(BOOL) - canSwapBetweenShareViewOrVideo
 Determine if the user can swap between show sharing screen or video now.
 
(ZoomSDKError- isDisplayingShareViewOrVideo:
 Determine if the meeting is displaying the sharing screen now.
 
(ZoomSDKError- setMeetingTopicOnMeetingInfo:
 Set the meeting topic on meeting info.
 
(BOOL) - isParticipantsShareAllowed
 Determine if the share screen is allowed.
 
(ZoomSDKError- allowParticipantsToShare:
 Allow participants to share screen.
 
(BOOL) - isParticipantsChatAllowed
 Determine if the chat is allowed.
 
(ZoomSDKError- allowParticipantsToChat:
 Allow participants to chat.
 
(BOOL) - isParticipantsRenameAllowed
 Determine if the participant rename is disabled.
 
(ZoomSDKError- allowParticipantsToRename:
 Allow participants to rename.
 
(ZoomSDKError- canSpotlight:result:
 Determine if user can spotlight someone.
 
(ZoomSDKError- canUnSpotlight:result:
 Determine if user can unspotlight someone.
 
(ZoomSDKError- spotlightVideo:
 Spotlight someone's video.
 
(ZoomSDKError- unSpotlightVideo:
 Unspotlight someone's video.
 
(ZoomSDKError- unSpotlightAllVideos
 Unspotlight all videos.
 
(NSArray *) - getSpotlightedUserList
 Get all users that has been spotlighted.
 
(ZoomSDKError- canPinToFirstView:result:
 Determine if user can pin someone to first view.
 
(ZoomSDKError- pinVideoToFirstView:
 Pin user's video to first view.
 
(ZoomSDKError- unPinVideoFromFirstView:
 Unpin user's video to first view.
 
(ZoomSDKError- unPinAllVideosFromFirstView
 Unpin all videos to first view.
 
(NSArray *) - getPinnedUserListFromFirstView
 Get all users that has been pined in first view.
 
(ZoomSDKError- canPinToSecondView:result:
 Determine if user can pin someone to second view.
 
(ZoomSDKError- pinVideoToSecondView:
 Pin user's video to second view.
 
(ZoomSDKError- unPinVideoFromSecondView:
 Unpin user's video to second view.
 
(NSArray *) - getPinnedUserListFromSecondView
 Get all users that has been pined in second view.
 
(BOOL) - isParticipantsUnmuteSelfAllowed
 Determine if participants can unmute themselves.
 
(BOOL) - isMeetingChatLegalNoticeAvailable
 Determine whether the legal notice for chat is available.
 
(NSString *) - getChatLegalNoticesPrompt
 Get the chat legal notices prompt.
 
(NSString *) - getChatLegalNoticesExplained
 Get the chat legal notices explained.
 
(ZoomSDKError- enableFollowHostVideoOrder:
 Enable of disable following host's video order.
 
(ZoomSDKError- setVideoOrder:
 Set the video order.
 
(BOOL) - isFollowHostVideoOrderOn
 Determine whether the option of following host's video order is on of off.
 
(BOOL) - isSupportFollowHostVideoOrder
 Determine whether this meeting support following host's video orde.
 
(NSArray< NSNumber * > *) - getVideoOrderList
 Get the video orde list.
 
(ZoomSDKError- lowerAllHands:
 Lower all hands raised.
 
(BOOL) - isChatMessageCanBeDeleted:
 Determine whether the message can be deleted.
 
(ZoomSDKError- deleteChatMessage:
 Delete chat message by message id.
 
(NSArray< NSString * > *) - getAllChatMessageID
 Get all chat message id.
 
(ZoomSDKError- setParticipantsChatPriviledge:
 Set participants chat priviledge.
 
(ZoomSDKChatStatus *) - getChatStatus
 Get the chat status of the current user.
 
(BOOL) - isShareMeetingChatLegalNoticeAvailable
 Determine whether the legal notice for sharing in meeting chat is available.
 
(NSString *) - getShareMeetingChatStartedLegalNoticeContent
 Get the sharing in meeting chat started legal notices content.
 
(NSString *) - getShareMeetingChatStoppedLegalNoticeContent
 Get the sharing in meeting chat stopped legal notices content.
 
(ZoomSDKError- stopIncomingAudio:
 Stop the incoming audio.
 
(BOOL) - isIncomingAudioStopped
 Determine if the incoming audio is stopped.
 
(ZoomSDKError- stopIncomingVideo:
 Stop in coming video.
 
(BOOL) - isIncomingVideoStopped
 Determine whether the coming video is stopedd.
 
(ZoomSDKError- showAvatar:
 Determine if show the last used avatar in the meeting.
 
(BOOL) - isShowAvatar
 Determine if the meeting is showing the avatar.
 
(ZoomSDKError- allowParticipantsToStartVideo:
 Allowing the regular attendees to start video, it can only be used in regular meeetings(no bo).
 
(BOOL) - isParticipantsStartVideoAllowed
 Check whether the current meeting allows participants to start video, it can only be used in regular meeetings(no bo).
 
(ZoomSDKError- allowParticipantsToShareWhiteBoard:
 Allowing the regular attendees to share whiteboard, it can only be used in regular meeetings(no bo).
 
(BOOL) - isParticipantsShareWhiteBoardAllowed
 Check whether the current meeting allows participants to share whiteboard, it can only be used in regular meeetings(no bo).
 
(BOOL) - isParticipantRequestLocalRecordingAllowed
 Check whether the current meeting allows participants to send local recording privilege requests. It can only be used in regular meetings, not in webinar or breakout room.
 
(ZoomSDKError- allowParticipantsToRequestLocalRecording:
 Allow participant to request local recording. It can only be used in regular meetings, not in webinar or breakout room.
 
(BOOL) - isAutoAllowLocalRecordingRequest
 Check whether the current meeting auto-grants participants’ local recording privilege requests. It can only be used in regular meetings (not webinar or breakout room).
 
(ZoomSDKError- autoAllowLocalRecordingRequest:
 Allow participants to request local recording. It can only be used in regular meetings (not webinar or breakout room).
 
(BOOL) - canSuspendParticipantsActivities
 Determine whether suspend all participants activities.
 
(ZoomSDKError- suspendParticipantsActivites
 Suspend all participants activities.
 
(ZoomSDKError- canHideParticipantProfilePictures
 Query if the current user can hide participant profile pictures. @Note: This feature is influenced by focus mode change.
 
(BOOL) - isParticipantProfilePicturesHidden
 Query if the current meeting hides participant pictures.
 
(ZoomSDKError- hideParticipantProfilePictures:
 Hide/Show participant profile pictures.
 
(BOOL) - isFocusModeEnabled
 Get the focus mode enabled or not by web portal.
 
(ZoomSDKError- turnFocusModeOn:
 Turn focus mode on or off. Focus mode on means Participants will only be able to see hosts' videos and shared content, and videos of spotlighted participants.
 
(BOOL) - isFocusModeOn
 Get the focus mode on or off.
 
(ZoomSDKFocusModeShareType- getFocusModeShareType
 Get share focus mode type indicating who can see the shared content which is controlled by host or co-host.
 
(ZoomSDKError- setFocusModeShareType:
 Set the focus mode type indicating who can see the shared content which is controlled by host or co-host.
 
(BOOL) - canEnableAlphaChannelMode
 Determine if alpha channel mode can be enabled.
 
(ZoomSDKError- enableAlphaChannelMode:
 Enable or disable alpha channel mode.
 
(BOOL) - isAlphaChannelModeEnabled
 Determine if alpha channel mode is enabled.
 
(ZoomSDKError- enableMeetingQAFeature:
 Set to enable/disable meeting QA.
 
(BOOL) - isMeetingQAFeatureOn
 Query if meeting QA is enabled in current meeting.
 
(BOOL) - canEnableParticipantRequestCloudRecording
 Determine if the current user can enable participant request clould recording.
 
(BOOL) - isParticipantRequestCloudRecordingAllowed
 Check whether the current meeting allows participants to send cloud recording privilege request, it can be used in regular meeetings and webinar (no bo).
 
(ZoomSDKError- allowParticipantsToRequestCloudRecording:
 Toggle whether attendees can send requests for the host to start a cloud recording. This can only be used in regular meeetings, not breakout rooms.
 

Protected Attributes

id< ZoomSDKMeetingActionControllerDelegate_delegate
 

Properties

id< ZoomSDKMeetingActionControllerDelegatedelegate
 

Detailed Description

Definition at line 669 of file ZoomSDKMeetingActionController.h.

Method Documentation

◆ actionMeetingWithCmd:userID:onScreen:

- (ZoomSDKError) actionMeetingWithCmd: (ActionMeetingCmd cmd
userID: (unsigned int)  userID
onScreen: (ScreenType screen 

Commands in the meeting.

Parameters
cmdThe commands in the meeting.
userIDThe ID of user. Zero(0) means that the current user can control the commands. If it is other participant, it will return the corresponding user ID.
screenSpecify the screen on which you want to do action.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ allowLocalRecord:UserID:

- (ZoomSDKError) allowLocalRecord: (BOOL)  allow
UserID: (unsigned int)  userid 

Allow or disallow the specified user to local recording.

Parameters
allowYES means allow, NO means disallow.
useridUser ID of the user to be modified.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ allowParticipantsToChat:

- (ZoomSDKError) allowParticipantsToChat: (BOOL)  allow

Allow participants to chat.

Parameters
allowYES means allow participants to chat,otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ allowParticipantsToRename:

- (ZoomSDKError) allowParticipantsToRename: (BOOL)  allow

Allow participants to rename.

Parameters
allowYES means allow participants to rename,otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ allowParticipantsToRequestCloudRecording:

- (ZoomSDKError) allowParticipantsToRequestCloudRecording: (BOOL)  allow

Toggle whether attendees can send requests for the host to start a cloud recording. This can only be used in regular meeetings, not breakout rooms.

Parameters
allowYes indicates that participants are allowed to send cloud recording privilege requests.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise not.

◆ allowParticipantsToRequestLocalRecording:

- (ZoomSDKError) allowParticipantsToRequestLocalRecording: (BOOL)  bAllow

Allow participant to request local recording. It can only be used in regular meetings, not in webinar or breakout room.

Parameters
bAllowYES indicates Allowing the regular attendees to send local recording privilege request.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ allowParticipantsToShare:

- (ZoomSDKError) allowParticipantsToShare: (BOOL)  allow

Allow participants to share screen.

Parameters
allowYES means allow participants use share screen,otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ allowParticipantsToShareWhiteBoard:

- (ZoomSDKError) allowParticipantsToShareWhiteBoard: (BOOL)  bAllow

Allowing the regular attendees to share whiteboard, it can only be used in regular meeetings(no bo).

Parameters
bAllowYES indicates Allowing the regular attendees to share whiteboard.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ allowParticipantsToStartVideo:

- (ZoomSDKError) allowParticipantsToStartVideo: (BOOL)  bAllow

Allowing the regular attendees to start video, it can only be used in regular meeetings(no bo).

Parameters
bAllowYES indicates Allowing the regular attendees to start video.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ assignCoHost:

- (ZoomSDKError) assignCoHost: (unsigned int)  userid

Assign a user as co-host in meeting.

Parameters
useridThe ID of user to be a co-host.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.
Note
The co-host cannot be assigned as co-host by himself. And the user should have the power to assign the role.

◆ autoAllowLocalRecordingRequest:

- (ZoomSDKError) autoAllowLocalRecordingRequest: (BOOL)  bAllow

Allow participants to request local recording. It can only be used in regular meetings (not webinar or breakout room).

Parameters
bAllowYES indicates Auto grant or deny the regular attendee's local recording privilege request.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ canEnableAlphaChannelMode

- (BOOL) canEnableAlphaChannelMode

Determine if alpha channel mode can be enabled.

Returns
YES means it can be enabled. Otherwise NO.

◆ canEnableParticipantRequestCloudRecording

- (BOOL) canEnableParticipantRequestCloudRecording

Determine if the current user can enable participant request clould recording.

Returns
YES means the current user can enable participant request clould recording.

◆ canHideParticipantProfilePictures

- (ZoomSDKError) canHideParticipantProfilePictures

Query if the current user can hide participant profile pictures. @Note: This feature is influenced by focus mode change.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ canPinToFirstView:result:

- (ZoomSDKError) canPinToFirstView: (unsigned int)  userID
result: (ZoomSDKPinResult *)  result 

Determine if user can pin someone to first view.

Parameters
userIDThe user id of the user you want to pin.
resultA point to enum ZoomSDKPinResult, if the function call successfully, the value of 'result' means whether the user can be pined.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ canPinToSecondView:result:

- (ZoomSDKError) canPinToSecondView: (unsigned int)  userID
result: (ZoomSDKPinResult *)  result 

Determine if user can pin someone to second view.

Parameters
userIDThe user id of the user you want to pin.
resultA point to enum ZoomSDKPinResult, if the function call successfully, the value of 'result' means whether the user can be pined.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ canReclaimHost

- (BOOL) canReclaimHost

Query if user can claim host(be host) or not.

Returns
YES means able, otherwise not.

◆ canSpotlight:result:

- (ZoomSDKError) canSpotlight: (unsigned int)  userID
result: (ZoomSDKSpotlightResult *)  result 

Determine if user can spotlight someone.

Parameters
userIDThe user id of the user you want to spotlight.
resultA point to enum ZoomSDKSpotlightResult, if the function call successfully, the value of 'result' means whether the user can be spotlighted.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ canSuspendParticipantsActivities

- (BOOL) canSuspendParticipantsActivities

Determine whether suspend all participants activities.

Returns
YES means can suspend participants activities. Otherwise not.

◆ canSwapBetweenShareViewOrVideo

- (BOOL) canSwapBetweenShareViewOrVideo

Determine if the user can swap between show sharing screen or video now.

Returns
YES means can, otherwise not.

◆ canUnSpotlight:result:

- (ZoomSDKError) canUnSpotlight: (unsigned int)  userID
result: (ZoomSDKSpotlightResult *)  result 

Determine if user can unspotlight someone.

Parameters
userIDThe user id of the user you want to unspotlight.
resultA point to enum ZoomSDKSpotlightResult, if the function call successfully, the value of 'result' means whether the user can be unspotlighted.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ changeUserName:newName:

- (ZoomSDKError) changeUserName: (unsigned int)  userID
newName: (NSString *)  name 

Change user's screen name in the meeting.

Parameters
userIDThe ID of user whose screen name will be changed. Normal participants can change only their personal screen name while the host/co-host can change all participants' names.
nameThe new screen name.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ claimHostByKey:

- (ZoomSDKError) claimHostByKey: (NSString *)  hostKey

Normal participant claims host by host-key.

Parameters
hostKeyHost key.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ deleteChatMessage:

- (ZoomSDKError) deleteChatMessage: (NSString *)  msgID

Delete chat message by message id.

Parameters
msgIDthe message id.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableAlphaChannelMode:

- (ZoomSDKError) enableAlphaChannelMode: (BOOL)  enabled

Enable or disable alpha channel mode.

Parameters
enabledYES indicates to enable alpha channel mode. Otherwise, disable it.
Returns
If the function succeeds, the return value is ZoomSDKError_Success.

◆ enableFollowHostVideoOrder:

- (ZoomSDKError) enableFollowHostVideoOrder: (BOOL)  enable

Enable of disable following host's video order.

Parameters
enableYES means enable, otherwise not.

◆ enableMeetingQAFeature:

- (ZoomSDKError) enableMeetingQAFeature: (BOOL)  enable

Set to enable/disable meeting QA.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableUseOriginalSound:

- (ZoomSDKError) enableUseOriginalSound: (BOOL)  enable

Set to output original sound of mic in meeting.

Parameters
enableYES means using original sound, No disabling.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ expelUser:

- (ZoomSDKError) expelUser: (unsigned int)  userid

Remove the specified user from meeting.

Parameters
useridUser ID of the user to be modified.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ getAllChatMessageID

- (NSArray< NSString * > *) getAllChatMessageID

Get all chat message id.

Returns
If the function succeeds, it will return an array with all message id, otherwise not.

◆ getChatLegalNoticesExplained

- (NSString *) getChatLegalNoticesExplained

Get the chat legal notices explained.

Returns
If the function succeeds, it will return the chat legal notices explained. Otherwise nil.

◆ getChatLegalNoticesPrompt

- (NSString *) getChatLegalNoticesPrompt

Get the chat legal notices prompt.

Returns
If the function succeeds, it will return the chat legal notices prompt. Otherwise nil.

◆ getChatStatus

- (ZoomSDKChatStatus *) getChatStatus

Get the chat status of the current user.

Returns
If the function succeeds, it will return the info of the chat status. For details, see ZoomSDKChatStatus, otherwise nil.

◆ getFocusModeShareType

- (ZoomSDKFocusModeShareType) getFocusModeShareType

Get share focus mode type indicating who can see the shared content which is controlled by host or co-host.

Returns
If the function succeeds, it will return the current share focus mode type.

◆ getMeetingUIType:isFullScreen:meetingUIType:

- (ZoomSDKError) getMeetingUIType: (ScreenType type
isFullScreen: (BOOL *)  bFullScreen
meetingUIType: (MeetingUIType *)  meetingUIType 

Get the meeting UI display type.

Parameters
typeSelect the screen where you want to operate on.
bFullScreenA point to A BOOL, if the function call successfully, the value of 'bFullScreen' means whether the specified screen is in full screen mode.
meetingUITypeA point to A MeetingUIType, if the function call successfully, the value of 'meetingUIType' means the meeting UI display type.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ getMyself

- (ZoomSDKUserInfo *) getMyself

Get the information of myself.

Returns
If the function succeeds, it will return the object of ZoomSDKUserInfo, otherwise nil.

◆ getParticipantsList

- (NSArray *) getParticipantsList

Get the list of participants.

Returns
An array of participant ID.

◆ getPinnedUserListFromFirstView

- (NSArray *) getPinnedUserListFromFirstView

Get all users that has been pined in first view.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ getPinnedUserListFromSecondView

- (NSArray *) getPinnedUserListFromSecondView

Get all users that has been pined in second view.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ getShareMeetingChatStartedLegalNoticeContent

- (NSString *) getShareMeetingChatStartedLegalNoticeContent

Get the sharing in meeting chat started legal notices content.

Returns
If the function succeeds, it will return the the sharing in meeting chat started legal notices content. Otherwise nil.

◆ getShareMeetingChatStoppedLegalNoticeContent

- (NSString *) getShareMeetingChatStoppedLegalNoticeContent

Get the sharing in meeting chat stopped legal notices content.

Returns
If the function succeeds, it will return the the sharing in meeting chat stopped legal notices content. Otherwise nil.

◆ getShareSettingType:

- (ZoomSDKError) getShareSettingType: (ZoomSDKShareSettingType *)  type

Get the sharing types for the host or co-host in meeting.

Parameters
typeCustom setting types of ZOOM SDK sharing.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ getSpotlightedUserList

- (NSArray *) getSpotlightedUserList

Get all users that has been spotlighted.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ getUserByUserID:

- (ZoomSDKUserInfo *) getUserByUserID: (unsigned int)  userID

Get the information of the specified user.

Parameters
userIDThe ID of the specified user.
Returns
If the function succeeds, it will return the object of ZoomSDKUserInfo, otherwise nil.

◆ getVideoOrderList

- (NSArray< NSNumber * > *) getVideoOrderList

Get the video orde list.

Returns
If the function succeeds, it will return the video orde list., otherwise nil.

◆ hideParticipantProfilePictures:

- (ZoomSDKError) hideParticipantProfilePictures: (BOOL)  hide

Hide/Show participant profile pictures.

Parameters
hideYES means hide participant profile pictures, NO means show participant pictures.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ isAlphaChannelModeEnabled

- (BOOL) isAlphaChannelModeEnabled

Determine if alpha channel mode is enabled.

Returns
YES indicates is in alpha channel mode. Otherwise NO.

◆ isAutoAllowLocalRecordingRequest

- (BOOL) isAutoAllowLocalRecordingRequest

Check whether the current meeting auto-grants participants’ local recording privilege requests. It can only be used in regular meetings (not webinar or breakout room).

Returns
If auto grant participants local recording privilege request, the return value is YES.

◆ isChatMessageCanBeDeleted:

- (BOOL) isChatMessageCanBeDeleted: (NSString *)  msgID

Determine whether the message can be deleted.

Parameters
msgIDthe message id.
Returns
Yes means can be deleted, otherwise not.

◆ isDisplayingShareViewOrVideo:

- (ZoomSDKError) isDisplayingShareViewOrVideo: (BOOL *)  isShowingShareView

Determine if the meeting is displaying the sharing screen now.

Parameters
isShowingShareViewYES means is showing sharing screen, NO means is showing video.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ isFocusModeEnabled

- (BOOL) isFocusModeEnabled

Get the focus mode enabled or not by web portal.

Returns
YES means focus mode enabled. Otherwise NO.

◆ isFocusModeOn

- (BOOL) isFocusModeOn

Get the focus mode on or off.

Returns
YES means focus mode on, otherwise NO.

◆ isFollowHostVideoOrderOn

- (BOOL) isFollowHostVideoOrderOn

Determine whether the option of following host's video order is on of off.

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

◆ isIncomingAudioStopped

- (BOOL) isIncomingAudioStopped

Determine if the incoming audio is stopped.

Returns
Yes indicates that incoming audio is stopped, otherwise not.

◆ isIncomingVideoStopped

- (BOOL) isIncomingVideoStopped

Determine whether the coming video is stopedd.

Returns
YES indicates the coming video is stopedd. Otherwise NO.

◆ isMeetingChatLegalNoticeAvailable

- (BOOL) isMeetingChatLegalNoticeAvailable

Determine whether the legal notice for chat is available.

Returns
YES means the legal notice for chat is available, otherwise not.

◆ isMeetingQAFeatureOn

- (BOOL) isMeetingQAFeatureOn

Query if meeting QA is enabled in current meeting.

Returns
YES means enabled, otherwise not.

◆ isParticipantProfilePicturesHidden

- (BOOL) isParticipantProfilePicturesHidden

Query if the current meeting hides participant pictures.

Returns
YES means hide participant pictures, NO means show participant pictures.

◆ isParticipantRequestCloudRecordingAllowed

- (BOOL) isParticipantRequestCloudRecordingAllowed

Check whether the current meeting allows participants to send cloud recording privilege request, it can be used in regular meeetings and webinar (no bo).

Returns
YES means allows participants to send request.

◆ isParticipantRequestLocalRecordingAllowed

- (BOOL) isParticipantRequestLocalRecordingAllowed

Check whether the current meeting allows participants to send local recording privilege requests. It can only be used in regular meetings, not in webinar or breakout room.

Returns
If allows participants to share whiteboard, the return value is YES.

◆ isParticipantsChatAllowed

- (BOOL) isParticipantsChatAllowed

Determine if the chat is allowed.

Returns
YES means is disable chat,otherwise not.

◆ isParticipantsRenameAllowed

- (BOOL) isParticipantsRenameAllowed

Determine if the participant rename is disabled.

Returns
YES means is disable participant rename,otherwise not.

◆ isParticipantsShareAllowed

- (BOOL) isParticipantsShareAllowed

Determine if the share screen is allowed.

Returns
YES means is disable share screen,otherwise not.

◆ isParticipantsShareWhiteBoardAllowed

- (BOOL) isParticipantsShareWhiteBoardAllowed

Check whether the current meeting allows participants to share whiteboard, it can only be used in regular meeetings(no bo).

Returns
YES means allows participants to share whiteboard.

◆ isParticipantsStartVideoAllowed

- (BOOL) isParticipantsStartVideoAllowed

Check whether the current meeting allows participants to start video, it can only be used in regular meeetings(no bo).

Returns
YES means allows participants to start video. Otherwise NO.

◆ isParticipantsUnmuteSelfAllowed

- (BOOL) isParticipantsUnmuteSelfAllowed

Determine if participants can unmute themselves.

Returns
YES means can unmute themselves, otherwise not.

◆ isShareMeetingChatLegalNoticeAvailable

- (BOOL) isShareMeetingChatLegalNoticeAvailable

Determine whether the legal notice for sharing in meeting chat is available.

Returns
YES indicates the legal notice for chat is available. Otherwise NO.

◆ isShowAvatar

- (BOOL) isShowAvatar

Determine if the meeting is showing the avatar.

Returns
YES indicates the meeting is showing the avatar.

◆ isSupportFollowHostVideoOrder

- (BOOL) isSupportFollowHostVideoOrder

Determine whether this meeting support following host's video orde.

Returns
Yes means supporting, otherwise not.

◆ isSupportUseOriginalSound

- (BOOL) isSupportUseOriginalSound

Determine if the meeting supports user's original sound.

Returns
YES means supported, otherwise not.

◆ isUseOriginalSoundOn

- (BOOL) isUseOriginalSoundOn

Determine if user's original sound is enabled.

Returns
YES means enabled, otherwise not.

◆ lowerAllHands:

- (ZoomSDKError) lowerAllHands: (BOOL)  forWebinarAttendees

Lower all hands raised.

Parameters
forWebinarAttendeesYES means to lower all hands for webinar attendee.
Note
When forWebinarAttendees is true, the SDK sends the lower all hands command only to webinar attendees. When forWebinarAttendees is false, the SDK sends the lower all hands command to anyone who is not a webinar attendee, such as the webinar host/cohost/panelist or everyone in a regular meeting.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ makeHost:

- (ZoomSDKError) makeHost: (unsigned int)  userID

Assign a participant to be a new host, or original host who loose the privilege reclaims to be the host.

Parameters
userIDUser ID of new host. Zero(0) means that the original host takes back the privilege.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ pinVideoToFirstView:

- (ZoomSDKError) pinVideoToFirstView: (unsigned int)  userID

Pin user's video to first view.

Parameters
userIDThe user id of the user you want to pin.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ pinVideoToSecondView:

- (ZoomSDKError) pinVideoToSecondView: (unsigned int)  userID

Pin user's video to second view.

Parameters
userIDThe user id of the user you want to pin.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ raiseHand:UserID:

- (ZoomSDKError) raiseHand: (BOOL)  raise
UserID: (unsigned int)  userid 

Make the specified user to raise hand or lower hand.

Parameters
raiseYES means to raise hand, NO means lower hand for this specified user.
useridUser ID of the user to be modified.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ reclaimHost

- (ZoomSDKError) reclaimHost

Reclaim the role of the host.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ revokeCoHost:

- (ZoomSDKError) revokeCoHost: (unsigned int)  userid

Revoke co-host role of another user in meeting.

Parameters
useridThe ID of co-host who will loose the co-host privilege.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.
Note
Only meeting host can run the function.

◆ sendChat:toUser:chatType:

- (ZoomSDKError) sendChat: (NSString *)  content
toUser: (unsigned int)  userID
chatType: (ZoomSDKChatMessageType type 

Send a chat message.

Parameters
contentThe content of message.
userIDThe ID of user who will receive the message.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setFocusModeShareType:

- (ZoomSDKError) setFocusModeShareType: (ZoomSDKFocusModeShareType shareType

Set the focus mode type indicating who can see the shared content which is controlled by host or co-host.

Parameters
shareTypeThe type of focus mode share type. For detail, see ZoomSDKFocusModeShareType.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setMeetingTopicOnMeetingInfo:

- (ZoomSDKError) setMeetingTopicOnMeetingInfo: (NSString *)  topic

Set the meeting topic on meeting info.

Parameters
topicThe meeting topic.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setParticipantsChatPriviledge:

- (ZoomSDKError) setParticipantsChatPriviledge: (ZoomSDKChatPriviledgeType priviledge

Set participants chat priviledge.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setShareSettingType:

- (ZoomSDKError) setShareSettingType: (ZoomSDKShareSettingType shareType

Set sharing types for the host or co-host in meeting.

Parameters
shareTypeCustom setting types of ZOOM SDK sharing.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setVideoOrder:

- (ZoomSDKError) setVideoOrder: (NSArray< NSNumber * > *)  orderList

Set the video order.

Parameters
orderListThe array contains the listed user id.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ showAvatar:

- (ZoomSDKError) showAvatar: (BOOL)  show

Determine if show the last used avatar in the meeting.

Parameters
showYES indicates to show the last used avatar.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ spotlightVideo:

- (ZoomSDKError) spotlightVideo: (unsigned int)  userID

Spotlight someone's video.

Parameters
userIDThe user id of the user you want to spotlight.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ startCMR:

- (ZoomSDKError) startCMR: (BOOL)  start

Start or stop the cloud recording.

Parameters
startYES means to start, NO means stop.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ stopIncomingAudio:

- (ZoomSDKError) stopIncomingAudio: (BOOL)  stop

Stop the incoming audio.

Parameters
stopYES means stop, otherwise not.
Returns
If the function succeeds, it will return the the sharing in meeting chat stopped legal notices content. Otherwise nil.

◆ stopIncomingVideo:

- (ZoomSDKError) stopIncomingVideo: (BOOL)  stop

Stop in coming video.

Parameters
stopYES means stop in coming video. NO is start coming video.
Returns
If the function succeeds, it will return the the sharing in meeting chat stopped legal notices content. Otherwise nil.

◆ suspendParticipantsActivites

- (ZoomSDKError) suspendParticipantsActivites

Suspend all participants activities.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ swapToShowShareViewOrVideo:

- (ZoomSDKError) swapToShowShareViewOrVideo: (BOOL)  share

Swap to show sharing screen or video.

Parameters
shareYES means swap to sharing screen, NO means swap to video.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.
Note
Only available for Zoom native ui mode.

◆ turnFocusModeOn:

- (ZoomSDKError) turnFocusModeOn: (BOOL)  on

Turn focus mode on or off. Focus mode on means Participants will only be able to see hosts' videos and shared content, and videos of spotlighted participants.

Parameters
onYes means to turn on. No means to turn off.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise not.

◆ unPinAllVideosFromFirstView

- (ZoomSDKError) unPinAllVideosFromFirstView

Unpin all videos to first view.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ unPinVideoFromFirstView:

- (ZoomSDKError) unPinVideoFromFirstView: (unsigned int)  userID

Unpin user's video to first view.

Parameters
userIDThe user id of the user you want to unpin.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ unPinVideoFromSecondView:

- (ZoomSDKError) unPinVideoFromSecondView: (unsigned int)  userID

Unpin user's video to second view.

Parameters
userIDThe user id of the user you want to unpin.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ unSpotlightAllVideos

- (ZoomSDKError) unSpotlightAllVideos

Unspotlight all videos.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ unSpotlightVideo:

- (ZoomSDKError) unSpotlightVideo: (unsigned int)  userID

Unspotlight someone's video.

Parameters
userIDThe user id of the user you want to unspotlight.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

Field Documentation

◆ _delegate

- (id<ZoomSDKMeetingActionControllerDelegate>) _delegate
protected

Definition at line 671 of file ZoomSDKMeetingActionController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingActionControllerDelegate>) delegate
readwritenonatomicassign

Definition at line 674 of file ZoomSDKMeetingActionController.h.