- Generated by
1.12.0
|
Meeting SDK for macOS API Reference
|
Interface for managing participant-related actions in a meeting, such as retrieving participant list, muting audio, or controlling roles. More...
#include <ZoomSDKMeetingActionController.h>
Inherits NSObject.
Instance Methods | |
| (NSArray *_Nullable) | - getParticipantsList |
| Get the list of participants. | |
| (ZoomSDKError) | - actionMeetingWithCmd:userID:onScreen: |
| Commands in the meeting. | |
| (ZoomSDKUserInfo *_Nullable) | - getUserByUserID: |
| Get the information of the specified user. | |
| (ZoomSDKUserInfo *_Nullable) | - 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) | - allowLocalRecord:UserID: |
| Allow or disallow the specified user to local recording. | |
| (BOOL) | - isSelfOriginalHost |
| Query whether the current user is the original host. | |
| (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) | - canSetMeetingTopic |
| Determine if the current user can change the meeting topic. | |
| (ZoomSDKError) | - setMeetingTopic: |
| Change the meeting topic. | |
| (BOOL) | - canEnableMuteOnEntry |
| Check if the host or cohost can enable mute on entry. | |
| (BOOL) | - isMuteOnEntryEnabled |
| Determine if mute on entry is enabled. | |
| (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 *_Nullable) | - 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 *_Nullable) | - 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 *_Nullable) | - 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 * > *_Nullable) | - 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 * > *_Nullable) | - getAllChatMessageID |
| Get all chat message id. | |
| (ZoomSDKError) | - setParticipantsChatPrivilege: |
| Set participants chat privilege. | |
| (ZoomSDKChatStatus *_Nullable) | - 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) | - suspendParticipantsActivities |
| Suspend all participants activities. | |
| (ZoomSDKError) | - canHideParticipantProfilePictures |
| Query if the current user can hide participant profile pictures. | |
| (BOOL) | - isParticipantProfilePicturesHidden |
| Query if the current meeting hides participant pictures. | |
| (ZoomSDKError) | - hideParticipantProfilePictures: |
| Hide/Show participant profile pictures. | |
| (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. | |
| (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. | |
| (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. | |
| (BOOL) | - is3rdPartyTelephonyAudioOn |
| Determine if the meeting has third party telephony audio enabled. | |
| (ZoomSDKUserInfo *_Nullable) | - getBotAuthorizedUserInfoByUserID: |
| Get the information about the bot's authorized user. | |
| (NSArray< NSNumber * > *_Nullable) | - getAuthorizedBotListByUserID: |
| Get the authorizer's bot list. | |
| (BOOL) | - isSupportVirtualNameTag |
| Determine if there is support for the virtual name tag feature. | |
| (ZoomSDKError) | - enableVirtualNameTag: |
| Enable the virtual name tag feature for the account. | |
| (ZoomSDKError) | - updateVirtualNameTagRosterInfo: |
| Update the virtual name tag roster infomation for the account. | |
| (BOOL) | - isPlayMeetingAudioEnabled |
| Determine if play meeting audio is enabled or not. | |
| (ZoomSDKError) | - enablePlayMeetingAudio: |
| Enable or disable SDK to play meeting audio. | |
| (BOOL) | - isSpeakerContrastEnhanceEnabled |
| Determine if contrast enhancement effect for speaker video is enabled. | |
| (ZoomSDKError) | - enableSpeakerContrastEnhance: |
| Enable or disable contrast enhancement effect for speaker video. | |
| (ZoomSDKUserInfo *_Nullable) | - getCompanionParentUser: |
| Get the information about the user's parent user. | |
| (NSArray< NSNumber * > *_Nullable) | - getCompanionChildList: |
| Get the user's child list. | |
| (ZoomSDKError) | - assignCoHostWithAssetsPrivilege:infoList: |
| Assigns a user as co-host and grants privileges to manage assets after the meeting. | |
| (ZoomSDKError) | - makeHostWithAssetsPrivilege:infoList: |
| Assigns a user as host and grants privileges to manage assets after the meeting. | |
Protected Attributes | |
| id< ZoomSDKMeetingActionControllerDelegate > | _delegate |
Properties | |
| id< ZoomSDKMeetingActionControllerDelegate > | delegate |
| Set or get the delegate to receive meeting action events. | |
Interface for managing participant-related actions in a meeting, such as retrieving participant list, muting audio, or controlling roles.
Definition at line 887 of file ZoomSDKMeetingActionController.h.
| - (ZoomSDKError) actionMeetingWithCmd: | (ActionMeetingCmd) | cmd | |
| userID: | (unsigned int) | userID | |
| onScreen: | (ScreenType) | screen |
Commands in the meeting.
| cmd | The commands in the meeting. |
| userID | The 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. |
| screen | Specify the screen on which you want to do action. |
| - (ZoomSDKError) allowLocalRecord: | (BOOL) | allow | |
| UserID: | (unsigned int) | userid |
Allow or disallow the specified user to local recording.
| allow | YES means allow, NO means disallow. |
| userid | User ID of the user to be modified. |
| - (ZoomSDKError) allowParticipantsToChat: | (BOOL) | allow |
Allow participants to chat.
| allow | YES means allow participants to chat,otherwise not. |
| - (ZoomSDKError) allowParticipantsToRename: | (BOOL) | allow |
Allow participants to rename.
| allow | YES means allow participants to rename,otherwise not. |
| - (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.
| allow | Yes indicates that participants are allowed to send cloud recording privilege requests. |
| - (ZoomSDKError) allowParticipantsToRequestLocalRecording: | (BOOL) | bAllow |
Allow participant to request local recording. It can only be used in regular meetings, not in webinar or breakout room.
| bAllow | YES indicates Allowing the regular attendees to send local recording privilege request. |
| - (ZoomSDKError) allowParticipantsToShare: | (BOOL) | allow |
Allow participants to share screen.
| allow | YES means allow participants use share screen,otherwise not. |
| - (ZoomSDKError) allowParticipantsToShareWhiteBoard: | (BOOL) | bAllow |
Allowing the regular attendees to share whiteboard, it can only be used in regular meeetings(no bo).
| bAllow | YES indicates Allowing the regular attendees to share whiteboard. |
| - (ZoomSDKError) allowParticipantsToStartVideo: | (BOOL) | bAllow |
Allowing the regular attendees to start video, it can only be used in regular meeetings(no bo).
| bAllow | YES indicates Allowing the regular attendees to start video. |
| - (ZoomSDKError) assignCoHost: | (unsigned int) | userid |
Assign a user as co-host in meeting.
| userid | The ID of user to be a co-host. |
ZoomSDKError_Success, otherwise not. | - (ZoomSDKError) assignCoHostWithAssetsPrivilege: | (unsigned int) | userid | |
| infoList: | (NSArray< ZoomSDKGrantCoOwnerAssetsInfo * > *) | infoList |
Assigns a user as co-host and grants privileges to manage assets after the meeting.
| userid | The user ID of the user to be assigned as co-host. |
| infoList | An array of ZoomSDKGrantCoOwnerAssetsInfo objects representing the assets and privileges to grant. |
ZoomSDKError_Success. Otherwise the function fails. For more information, see ZoomSDKError.| - (ZoomSDKError) autoAllowLocalRecordingRequest: | (BOOL) | bAllow |
Allow participants to request local recording. It can only be used in regular meetings (not webinar or breakout room).
| bAllow | YES indicates Auto grant or deny the regular attendee's local recording privilege request. |
| - (BOOL) canEnableAlphaChannelMode |
Determine if alpha channel mode can be enabled.
| - (BOOL) canEnableMuteOnEntry |
Check if the host or cohost can enable mute on entry.
| - (BOOL) canEnableParticipantRequestCloudRecording |
Determine if the current user can enable participant request clould recording.
| - (ZoomSDKError) canHideParticipantProfilePictures |
Query if the current user can hide participant profile pictures.
ZoomSDKError_Success, otherwise not. | - (ZoomSDKError) canPinToFirstView: | (unsigned int) | userID | |
| result: | (ZoomSDKPinResult *) | result |
Determine if user can pin someone to first view.
| userID | The user id of the user you want to pin. |
| result | A point to enum ZoomSDKPinResult, if the function call successfully, the value of 'result' means whether the user can be pined. |
| - (ZoomSDKError) canPinToSecondView: | (unsigned int) | userID | |
| result: | (ZoomSDKPinResult *) | result |
Determine if user can pin someone to second view.
| userID | The user id of the user you want to pin. |
| result | A point to enum ZoomSDKPinResult, if the function call successfully, the value of 'result' means whether the user can be pined. |
| - (BOOL) canReclaimHost |
Query if user can claim host(be host) or not.
| - (BOOL) canSetMeetingTopic |
Determine if the current user can change the meeting topic.
| - (ZoomSDKError) canSpotlight: | (unsigned int) | userID | |
| result: | (ZoomSDKSpotlightResult *) | result |
Determine if user can spotlight someone.
| userID | The user id of the user you want to spotlight. |
| result | A point to enum ZoomSDKSpotlightResult, if the function call successfully, the value of 'result' means whether the user can be spotlighted. |
| - (BOOL) canSuspendParticipantsActivities |
Determine whether suspend all participants activities.
| - (BOOL) canSwapBetweenShareViewOrVideo |
Determine if the user can swap between show sharing screen or video now.
| - (ZoomSDKError) canUnSpotlight: | (unsigned int) | userID | |
| result: | (ZoomSDKSpotlightResult *) | result |
Determine if user can unspotlight someone.
| userID | The user id of the user you want to unspotlight. |
| result | A point to enum ZoomSDKSpotlightResult, if the function call successfully, the value of 'result' means whether the user can be unspotlighted. |
| - (ZoomSDKError) changeUserName: | (unsigned int) | userID | |
| newName: | (NSString *) | name |
Change user's screen name in the meeting.
| userID | The 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. |
| name | The new screen name. |
| - (ZoomSDKError) claimHostByKey: | (NSString *) | hostKey |
Normal participant claims host by host-key.
| hostKey | Host key. |
| - (ZoomSDKError) deleteChatMessage: | (NSString *) | msgID |
Delete chat message by message id.
| msgID | the message id. |
| - (ZoomSDKError) enableAlphaChannelMode: | (BOOL) | enabled |
Enable or disable alpha channel mode.
| enabled | YES indicates to enable alpha channel mode. Otherwise, disable it. |
| - (ZoomSDKError) enableFollowHostVideoOrder: | (BOOL) | enable |
Enable of disable following host's video order.
| enable | YES means enable, otherwise not. |
| - (ZoomSDKError) enableMeetingQAFeature: | (BOOL) | enable |
Set to enable/disable meeting QA.
| enable | YES means enabled, NO disabled. |
| - (ZoomSDKError) enablePlayMeetingAudio: | (BOOL) | bEnabled |
Enable or disable SDK to play meeting audio.
| bEnabled | YES means that SDK will play meeting audio, NO means that SDK will not play meeting audio. |
| - (ZoomSDKError) enableSpeakerContrastEnhance: | (BOOL) | bEnabled |
Enable or disable contrast enhancement effect for speaker video.
| bEnabled | YES indicates to enable contrast enhancement effect. Otherwise, disable it. |
| - (ZoomSDKError) enableUseOriginalSound: | (BOOL) | enable |
Set to output original sound of mic in meeting.
| enable | YES means using original sound, No disabling. |
| - (ZoomSDKError) enableVirtualNameTag: | (BOOL) | bEnabled |
Enable the virtual name tag feature for the account.
| bEnabled | YES means the feature is enabled. Otherwise is isn't. |
| - (ZoomSDKError) expelUser: | (unsigned int) | userid |
Remove the specified user from meeting.
| userid | User ID of the user to be modified. |
| - (NSArray< NSString * > *_Nullable) getAllChatMessageID |
Get all chat message id.
| - (NSArray< NSNumber * > *_Nullable) getAuthorizedBotListByUserID: | (unsigned int) | userId |
Get the authorizer's bot list.
| userId | Specify the user ID for which to get the information. |
| - (ZoomSDKUserInfo *_Nullable) getBotAuthorizedUserInfoByUserID: | (unsigned int) | userId |
Get the information about the bot's authorized user.
| userId | Specify the user ID for which to get the information. |
| - (NSString *) getChatLegalNoticesExplained |
Get the chat legal notices explained.
| - (NSString *) getChatLegalNoticesPrompt |
Get the chat legal notices prompt.
| - (ZoomSDKChatStatus *_Nullable) getChatStatus |
Get the chat status of the current user.
| - (NSArray< NSNumber * > *_Nullable) getCompanionChildList: | (unsigned int) | userid |
Get the user's child list.
| userid | Specify the user ID for which to get the information. |
| - (ZoomSDKUserInfo *_Nullable) getCompanionParentUser: | (unsigned int) | userid |
Get the information about the user's parent user.
| userid | Specify the user ID for which to get the information. |
| - (ZoomSDKFocusModeShareType) getFocusModeShareType |
Get share focus mode type indicating who can see the shared content which is controlled by host or co-host.
| - (ZoomSDKUserInfo *_Nullable) getMyself |
Get the information of myself.
| - (NSArray *_Nullable) getParticipantsList |
Get the list of participants.
| - (NSArray *_Nullable) getPinnedUserListFromFirstView |
Get all users that has been pined in first view.
| - (NSArray *_Nullable) getPinnedUserListFromSecondView |
Get all users that has been pined in second view.
| - (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) getShareSettingType: | (ZoomSDKShareSettingType *) | type |
Get the sharing types for the host or co-host in meeting.
| type | The custom sharing type. |
| - (NSArray *_Nullable) getSpotlightedUserList |
Get all users that has been spotlighted.
| - (ZoomSDKUserInfo *_Nullable) getUserByUserID: | (unsigned int) | userID |
Get the information of the specified user.
| userID | The ID of the specified user. |
| - (NSArray< NSNumber * > *_Nullable) getVideoOrderList |
Get the video orde list.
| - (ZoomSDKError) hideParticipantProfilePictures: | (BOOL) | hide |
Hide/Show participant profile pictures.
| hide | YES means hide participant profile pictures, NO means show participant pictures. |
| - (BOOL) is3rdPartyTelephonyAudioOn |
Determine if the meeting has third party telephony audio enabled.
| - (BOOL) isAlphaChannelModeEnabled |
Determine if alpha channel mode is enabled.
| - (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).
| - (BOOL) isChatMessageCanBeDeleted: | (NSString *) | msgID |
Determine whether the message can be deleted.
| msgID | the message id. |
| - (ZoomSDKError) isDisplayingShareViewOrVideo: | (BOOL *) | isShowingShareView |
Determine if the meeting is displaying the sharing screen now.
| isShowingShareView | YES means is showing sharing screen, NO means is showing video. |
| - (BOOL) isFocusModeEnabled |
Get the focus mode enabled or not by web portal.
| - (BOOL) isFocusModeOn |
Get the focus mode on or off.
| - (BOOL) isFollowHostVideoOrderOn |
Determine whether the option of following host's video order is on of off.
| - (BOOL) isIncomingAudioStopped |
Determine if the incoming audio is stopped.
| - (BOOL) isIncomingVideoStopped |
Determine whether the coming video is stopedd.
| - (BOOL) isMeetingChatLegalNoticeAvailable |
Determine whether the legal notice for chat is available.
| - (BOOL) isMeetingQAFeatureOn |
Query if meeting QA is enabled in current meeting.
| - (BOOL) isMuteOnEntryEnabled |
Determine if mute on entry is enabled.
| - (BOOL) isParticipantProfilePicturesHidden |
Query if the current meeting hides participant pictures.
| - (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).
| - (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.
| - (BOOL) isParticipantsChatAllowed |
Determine if the chat is allowed.
| - (BOOL) isParticipantsRenameAllowed |
Determine if the participant rename is disabled.
| - (BOOL) isParticipantsShareAllowed |
Determine if the share screen is allowed.
| - (BOOL) isParticipantsShareWhiteBoardAllowed |
Check whether the current meeting allows participants to share whiteboard, 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).
| - (BOOL) isParticipantsUnmuteSelfAllowed |
Determine if participants can unmute themselves.
| - (BOOL) isPlayMeetingAudioEnabled |
Determine if play meeting audio is enabled or not.
| - (BOOL) isSelfOriginalHost |
Query whether the current user is the original host.
| - (BOOL) isShareMeetingChatLegalNoticeAvailable |
Determine whether the legal notice for sharing in meeting chat is available.
| - (BOOL) isShowAvatar |
Determine if the meeting is showing the avatar.
| - (BOOL) isSpeakerContrastEnhanceEnabled |
Determine if contrast enhancement effect for speaker video is enabled.
| - (BOOL) isSupportFollowHostVideoOrder |
Determine whether this meeting support following host's video orde.
| - (BOOL) isSupportUseOriginalSound |
Determine if the meeting supports user's original sound.
| - (BOOL) isSupportVirtualNameTag |
Determine if there is support for the virtual name tag feature.
| - (BOOL) isUseOriginalSoundOn |
Determine if user's original sound is enabled.
| - (ZoomSDKError) lowerAllHands: | (BOOL) | forWebinarAttendees |
Lower all hands raised.
| forWebinarAttendees | YES means to lower all hands for webinar attendee. |
ZoomSDKError_Success, otherwise not. | - (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.
| userID | User ID of new host. Zero(0) means that the original host takes back the privilege. |
| - (ZoomSDKError) makeHostWithAssetsPrivilege: | (unsigned int) | userid | |
| infoList: | (NSArray< ZoomSDKGrantCoOwnerAssetsInfo * > *) | infoList |
Assigns a user as host and grants privileges to manage assets after the meeting.
| userid | The user ID of the user to be assigned as host. |
| infoList | An array of ZoomSDKGrantCoOwnerAssetsInfo objects representing the assets and privileges to grant. |
ZoomSDKError_Success. Otherwise, the function fails.| - (ZoomSDKError) pinVideoToFirstView: | (unsigned int) | userID |
Pin user's video to first view.
| userID | The user id of the user you want to pin. |
| - (ZoomSDKError) pinVideoToSecondView: | (unsigned int) | userID |
Pin user's video to second view.
| userID | The user id of the user you want to pin. |
| - (ZoomSDKError) raiseHand: | (BOOL) | raise | |
| UserID: | (unsigned int) | userid |
Make the specified user to raise hand or lower hand.
| raise | YES means to raise hand, NO means lower hand for this specified user. |
| userid | User ID of the user to be modified. |
| - (ZoomSDKError) reclaimHost |
Reclaim the role of the host.
| - (ZoomSDKError) revokeCoHost: | (unsigned int) | userid |
Revoke co-host role of another user in meeting.
| userid | The ID of co-host who will loose the co-host privilege. |
ZoomSDKError_Success, otherwise not. | - (ZoomSDKError) setFocusModeShareType: | (ZoomSDKFocusModeShareType) | shareType |
Set the focus mode type indicating who can see the shared content which is controlled by host or co-host.
| shareType | The type of focus mode share type. |
| - (ZoomSDKError) setMeetingTopic: | (NSString *) | topic |
Change the meeting topic.
| topic | The new meeting topic. |
| - (ZoomSDKError) setMeetingTopicOnMeetingInfo: | (NSString *) | topic |
Set the meeting topic on meeting info.
| topic | The meeting topic. |
ZoomSDKError_Success, otherwise not. | - (ZoomSDKError) setParticipantsChatPrivilege: | (ZoomSDKChatPrivilegeType) | privilege |
Set participants chat privilege.
| privilege | The chat privilege type to assign to participants. |
| - (ZoomSDKError) setShareSettingType: | (ZoomSDKShareSettingType) | shareType |
Set sharing types for the host or co-host in meeting.
| shareType | The custom sharing type. |
| - (ZoomSDKError) setVideoOrder: | (NSArray< NSNumber * > *) | orderList |
Set the video order.
| orderList | The array contains the listed user id. |
| - (ZoomSDKError) showAvatar: | (BOOL) | show |
Determine if show the last used avatar in the meeting.
| show | YES indicates to show the last used avatar. |
| - (ZoomSDKError) spotlightVideo: | (unsigned int) | userID |
Spotlight someone's video.
| userID | The user id of the user you want to spotlight. |
| - (ZoomSDKError) stopIncomingAudio: | (BOOL) | stop |
Stop the incoming audio.
| stop | YES means stop, otherwise not. |
| - (ZoomSDKError) stopIncomingVideo: | (BOOL) | stop |
Stop in coming video.
| stop | YES means stop in coming video. NO is start coming video. |
| - (ZoomSDKError) suspendParticipantsActivities |
Suspend all participants activities.
| - (ZoomSDKError) swapToShowShareViewOrVideo: | (BOOL) | share |
Swap to show sharing screen or video.
| share | YES means swap to sharing screen, NO means swap to video. |
| - (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.
| on | Yes means to turn on. No means to turn off. |
| - (ZoomSDKError) unPinAllVideosFromFirstView |
Unpin all videos to first view.
| - (ZoomSDKError) unPinVideoFromFirstView: | (unsigned int) | userID |
Unpin user's video to first view.
| userID | The user id of the user you want to unpin. |
| - (ZoomSDKError) unPinVideoFromSecondView: | (unsigned int) | userID |
Unpin user's video to second view.
| userID | The user id of the user you want to unpin. |
| - (ZoomSDKError) unSpotlightAllVideos |
Unspotlight all videos.
| - (ZoomSDKError) unSpotlightVideo: | (unsigned int) | userID |
Unspotlight someone's video.
| userID | The user id of the user you want to unspotlight. |
| - (ZoomSDKError) updateVirtualNameTagRosterInfo: | (NSArray< ZoomSDKVirtualNameTag * > *) | userRoster |
Update the virtual name tag roster infomation for the account.
| userRoster | The virtual name tag roster info list for the specified user. |
ZoomSDKError_Success.
|
protected |
Definition at line 889 of file ZoomSDKMeetingActionController.h.
|
readwritenonatomicassign |
Set or get the delegate to receive meeting action events.
Definition at line 894 of file ZoomSDKMeetingActionController.h.
1.12.0