- Generated by
1.16.1
|
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 |
| Gets the list of participants. | |
| (ZoomSDKError) | - actionMeetingWithCmd:userID:onScreen: |
| Commands in the meeting. | |
| (ZoomSDKUserInfo *_Nullable) | - getUserByUserID: |
| Gets the specified user's information. | |
| (ZoomSDKUserInfo *_Nullable) | - getMyself |
| Gets 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: |
| Removes 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 host's role. | |
| (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: |
| Sets sharing types for the host or co-host in meeting. | |
| (ZoomSDKError) | - getShareSettingType: |
| Gets the sharing types for the host or co-host in meeting. | |
| (BOOL) | - isUseOriginalSoundOn |
| Determines if user's original sound is enabled. | |
| (ZoomSDKError) | - enableUseOriginalSound: |
| Sets to output original sound of mic in meeting. | |
| (BOOL) | - isSupportUseOriginalSound |
| Determines if the meeting supports user's original sound. | |
| (ZoomSDKError) | - swapToShowShareViewOrVideo: |
| Swap to show sharing screen or video. | |
| (BOOL) | - canSwapBetweenShareViewOrVideo |
| Determines if the user can swap between show sharing screen or video now. | |
| (ZoomSDKError) | - isDisplayingShareViewOrVideo: |
| Determines if the meeting is displaying the sharing screen now. | |
| (ZoomSDKError) | - setMeetingTopicOnMeetingInfo: |
| Sets the meeting topic on meeting info. | |
| (BOOL) | - canSetMeetingTopic |
| Determines if the current user can change the meeting topic. | |
| (ZoomSDKError) | - setMeetingTopic: |
| Change the meeting topic. | |
| (BOOL) | - canEnableMuteOnEntry |
| Checks if the host or cohost can enable mute on entry. | |
| (BOOL) | - isMuteOnEntryEnabled |
| Determines if mute on entry is enabled. | |
| (BOOL) | - isParticipantsShareAllowed |
| Determines if the share screen is allowed. | |
| (ZoomSDKError) | - allowParticipantsToShare: |
| Allow participants to share screen. | |
| (BOOL) | - isParticipantsChatAllowed |
| Determines if the chat is allowed. | |
| (ZoomSDKError) | - allowParticipantsToChat: |
| Allow participants to chat. | |
| (BOOL) | - isParticipantsRenameAllowed |
| Determines if the participant rename is disabled. | |
| (ZoomSDKError) | - allowParticipantsToRename: |
| Allow participants to rename. | |
| (ZoomSDKError) | - canSpotlight:result: |
| Determines if user can spotlight someone. | |
| (ZoomSDKError) | - canUnSpotlight:result: |
| Determines 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 |
| Gets all users that has been spotlighted. | |
| (ZoomSDKError) | - canPinToFirstView:result: |
| Determines 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 |
| Gets all users that has been pined in first view. | |
| (ZoomSDKError) | - canPinToSecondView:result: |
| Determines 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 |
| Gets all users that has been pined in second view. | |
| (BOOL) | - isParticipantsUnmuteSelfAllowed |
| Determines if participants can unmute themselves. | |
| (BOOL) | - isMeetingChatLegalNoticeAvailable |
| Determines whether the legal notice for chat is available. | |
| (NSString *) | - getChatLegalNoticesPrompt |
| Gets the chat legal notices prompt. | |
| (NSString *) | - getChatLegalNoticesExplained |
| Gets the chat legal notices explained. | |
| (ZoomSDKError) | - enableFollowHostVideoOrder: |
| Enables of disable following host's video order. | |
| (ZoomSDKError) | - setVideoOrder: |
| Sets the video order. | |
| (BOOL) | - isFollowHostVideoOrderOn |
| Determines whether the option of following host's video order is on of off. | |
| (BOOL) | - isSupportFollowHostVideoOrder |
| Determines whether this meeting support following host's video orde. | |
| (NSArray< NSNumber * > *_Nullable) | - getVideoOrderList |
| Gets the video orde list. | |
| (ZoomSDKError) | - lowerAllHands: |
| Lower all hands raised. | |
| (BOOL) | - isChatMessageCanBeDeleted: |
| Determines whether the message can be deleted. | |
| (ZoomSDKError) | - deleteChatMessage: |
| Deletes chat message by message ID. | |
| (NSArray< NSString * > *_Nullable) | - getAllChatMessageID |
| Gets all chat message ID. | |
| (ZoomSDKError) | - setParticipantsChatPrivilege: |
| Sets participants chat privilege. | |
| (ZoomSDKChatStatus *_Nullable) | - getChatStatus |
| Gets the current's chat status user. | |
| (BOOL) | - isShareMeetingChatLegalNoticeAvailable |
| Determines whether the legal notice for sharing in meeting chat is available. | |
| (NSString *) | - getShareMeetingChatStartedLegalNoticeContent |
| Gets the sharing in meeting chat started legal notices content. | |
| (NSString *) | - getShareMeetingChatStoppedLegalNoticeContent |
| Gets the sharing in meeting chat stopped legal notices content. | |
| (ZoomSDKError) | - stopIncomingAudio: |
| Stops the incoming audio. | |
| (BOOL) | - isIncomingAudioStopped |
| Determines if the incoming audio is stopped. | |
| (ZoomSDKError) | - stopIncomingVideo: |
| Stops in coming video. | |
| (BOOL) | - isIncomingVideoStopped |
| Determines whether the coming video is stopedd. | |
| (ZoomSDKError) | - showAvatar: |
| Determines if show the last used avatar in the meeting. | |
| (BOOL) | - isShowAvatar |
| Determines 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 |
| Checks 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 |
| Checks whether the current meeting allows participants to share whiteboard, it can only be used in regular meeetings(no bo). | |
| (BOOL) | - isParticipantRequestLocalRecordingAllowed |
| Checks 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 |
| Checks 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 |
| Determines 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: |
| Hides or show participant profile pictures. | |
| (BOOL) | - canEnableAlphaChannelMode |
| Determines if alpha channel mode can be enabled. | |
| (ZoomSDKError) | - enableAlphaChannelMode: |
| Enables or disable alpha channel mode. | |
| (BOOL) | - isAlphaChannelModeEnabled |
| Determines if alpha channel mode is enabled. | |
| (BOOL) | - isFocusModeEnabled |
| Gets the focus mode enabled or not by web portal. | |
| (ZoomSDKError) | - turnFocusModeOn: |
| Turn focus mode on or off. Focus mode on means Participants onlies be able to see hosts' videos and shared content, and videos of spotlighted participants. | |
| (BOOL) | - isFocusModeOn |
| Gets the focus mode on or off. | |
| (ZoomSDKFocusModeShareType) | - getFocusModeShareType |
| Gets share focus mode type indicating who can see the shared content which is controlled by host or co-host. | |
| (ZoomSDKError) | - setFocusModeShareType: |
| Sets the focus mode type indicating who can see the shared content which is controlled by host or co-host. | |
| (ZoomSDKError) | - enableMeetingQAFeature: |
| Sets to enable or disable meeting QA. | |
| (BOOL) | - isMeetingQAFeatureOn |
| Query if meeting QA is enabled in current meeting. | |
| (BOOL) | - canEnableParticipantRequestCloudRecording |
| Determines if the current user can enable participant request clould recording. | |
| (BOOL) | - isParticipantRequestCloudRecordingAllowed |
| Checks 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 |
| Determines if the meeting has third party telephony audio enabled. | |
| (ZoomSDKUserInfo *_Nullable) | - getBotAuthorizedUserInfoByUserID: |
| Gets the information about the bot's authorized user. | |
| (NSArray< NSNumber * > *_Nullable) | - getAuthorizedBotListByUserID: |
| Gets the authorizer's bot list. | |
| (BOOL) | - isSupportVirtualNameTag |
| Determines if there is support for the virtual name tag feature. | |
| (ZoomSDKError) | - enableVirtualNameTag: |
| Enables the virtual name tag feature for the account. | |
| (ZoomSDKError) | - updateVirtualNameTagRosterInfo: |
| Updates the virtual name tag roster infomation for the account. | |
| (BOOL) | - isPlayMeetingAudioEnabled |
| Determines if play meeting audio is enabled or not. | |
| (ZoomSDKError) | - enablePlayMeetingAudio: |
| Enables or disable SDK to play meeting audio. | |
| (BOOL) | - isSpeakerContrastEnhanceEnabled |
| Determines if contrast enhancement effect for speaker video is enabled. | |
| (ZoomSDKError) | - enableSpeakerContrastEnhance: |
| Enables or disable contrast enhancement effect for speaker video. | |
| (ZoomSDKUserInfo *_Nullable) | - getCompanionParentUser: |
| Gets the information about the parent user. | |
| (NSArray< NSNumber * > *_Nullable) | - getCompanionChildList: |
| Gets the 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 |
| Sets 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 893 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 returns 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 to allow, NO to disallow. |
| userid | User ID of the user to be modified. |
| - (ZoomSDKError) allowParticipantsToChat: | (BOOL) | allow |
Allow participants to chat.
| allow | YES to allow participants to chat, NO otherwise. |
| - (ZoomSDKError) allowParticipantsToRename: | (BOOL) | allow |
Allow participants to rename.
| allow | YES to allow participants to rename, NO otherwise. |
| - (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, NO otherwise. |
| - (ZoomSDKError) allowParticipantsToShare: | (BOOL) | allow |
Allow participants to share screen.
| allow | YES to allow participants to share screen, NO otherwise. |
| - (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, NO otherwise. |
| - (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, NO otherwise. |
| - (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, this function returns an error. | - (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's user ID to be assigned as co-host. |
| infoList | An array of ZoomSDKGrantCoOwnerAssetsInfo objects representing the assets and privileges to grant. |
ZoomSDKError_Success. Otherwise, this function returns an error.| - (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, NO otherwise. |
| - (BOOL) canEnableAlphaChannelMode |
Determines if alpha channel mode can be enabled.
References canEnableAlphaChannelMode.
Referenced by canEnableAlphaChannelMode.
| - (BOOL) canEnableMuteOnEntry |
Checks if the host or cohost can enable mute on entry.
References canEnableMuteOnEntry.
Referenced by canEnableMuteOnEntry.
| - (BOOL) canEnableParticipantRequestCloudRecording |
Determines if the current user can enable participant request clould recording.
References canEnableParticipantRequestCloudRecording.
Referenced by canEnableParticipantRequestCloudRecording.
| - (ZoomSDKError) canHideParticipantProfilePictures |
Query if the current user can hide participant profile pictures.
ZoomSDKError_Success. Otherwise, this function returns an error. References canHideParticipantProfilePictures.
Referenced by canHideParticipantProfilePictures.
| - (ZoomSDKError) canPinToFirstView: | (unsigned int) | userID | |
| result: | (ZoomSDKPinResult *) | result |
Determines if user can pin someone to first view.
| userID | The user's user ID 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 |
Determines if user can pin someone to second view.
| userID | The user's user ID 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.
References canReclaimHost.
Referenced by canReclaimHost.
| - (BOOL) canSetMeetingTopic |
Determines if the current user can change the meeting topic.
References canSetMeetingTopic.
Referenced by canSetMeetingTopic.
| - (ZoomSDKError) canSpotlight: | (unsigned int) | userID | |
| result: | (ZoomSDKSpotlightResult *) | result |
Determines if user can spotlight someone.
| userID | The user's user ID 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 |
Determines whether suspend all participants activities.
References canSuspendParticipantsActivities.
Referenced by canSuspendParticipantsActivities.
| - (BOOL) canSwapBetweenShareViewOrVideo |
Determines if the user can swap between show sharing screen or video now.
References canSwapBetweenShareViewOrVideo.
Referenced by canSwapBetweenShareViewOrVideo.
| - (ZoomSDKError) canUnSpotlight: | (unsigned int) | userID | |
| result: | (ZoomSDKSpotlightResult *) | result |
Determines if user can unspotlight someone.
| userID | The user's user ID 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 or 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 |
Deletes chat message by message ID.
| msgID | The message ID. |
| - (ZoomSDKError) enableAlphaChannelMode: | (BOOL) | enabled |
Enables or disable alpha channel mode.
| enabled | YES indicates to enable alpha channel mode, disable it, NO to disable. |
| - (ZoomSDKError) enableFollowHostVideoOrder: | (BOOL) | enable |
Enables of disable following host's video order.
| enable | YES to enable, NO otherwise. |
| - (ZoomSDKError) enableMeetingQAFeature: | (BOOL) | enable |
Sets to enable or disable meeting QA.
| enable | YES if enabled, NO if disabled. |
| - (ZoomSDKError) enablePlayMeetingAudio: | (BOOL) | bEnabled |
Enables or disable SDK to play meeting audio.
| bEnabled | YES if SDK will play meeting audio, NO if SDK will not play meeting audio. |
| - (ZoomSDKError) enableSpeakerContrastEnhance: | (BOOL) | bEnabled |
Enables or disable contrast enhancement effect for speaker video.
| bEnabled | YES indicates to enable contrast enhancement effect, disable it, NO to disable. |
| - (ZoomSDKError) enableUseOriginalSound: | (BOOL) | enable |
Sets to output original sound of mic in meeting.
| enable | YES if using original sound, No disabling, NO otherwise. |
| - (ZoomSDKError) enableVirtualNameTag: | (BOOL) | bEnabled |
Enables the virtual name tag feature for the account.
| bEnabled | YES if the feature is enabled, NO otherwise. |
| - (ZoomSDKError) expelUser: | (unsigned int) | userid |
Removes the specified user from meeting.
| userid | User ID of the user to be modified. |
| - (NSArray< NSString * > *_Nullable) getAllChatMessageID |
Gets all chat message ID.
References getAllChatMessageID.
Referenced by getAllChatMessageID.
| - (NSArray< NSNumber * > *_Nullable) getAuthorizedBotListByUserID: | (unsigned int) | userId |
Gets the authorizer's bot list.
| userId | Specify the user ID for which to get the information. |
| - (ZoomSDKUserInfo *_Nullable) getBotAuthorizedUserInfoByUserID: | (unsigned int) | userId |
Gets the information about the bot's authorized user.
| userId | Specify the user ID for which to get the information. |
| - (NSString *) getChatLegalNoticesExplained |
Gets the chat legal notices explained.
References getChatLegalNoticesExplained.
Referenced by getChatLegalNoticesExplained.
| - (NSString *) getChatLegalNoticesPrompt |
Gets the chat legal notices prompt.
References getChatLegalNoticesPrompt.
Referenced by getChatLegalNoticesPrompt.
| - (ZoomSDKChatStatus *_Nullable) getChatStatus |
Gets the current's chat status user.
References getChatStatus.
Referenced by getChatStatus.
| - (NSArray< NSNumber * > *_Nullable) getCompanionChildList: | (unsigned int) | userid |
Gets the child list.
| userid | Specify the user ID for which to get the information. |
| - (ZoomSDKUserInfo *_Nullable) getCompanionParentUser: | (unsigned int) | userid |
Gets the information about the parent user.
| userid | Specify the user ID for which to get the information. |
| - (ZoomSDKFocusModeShareType) getFocusModeShareType |
Gets share focus mode type indicating who can see the shared content which is controlled by host or co-host.
References getFocusModeShareType.
Referenced by getFocusModeShareType.
| - (ZoomSDKUserInfo *_Nullable) getMyself |
Gets the information of myself.
References getMyself.
Referenced by getMyself.
| - (NSArray *_Nullable) getParticipantsList |
Gets the list of participants.
References getParticipantsList.
Referenced by getParticipantsList.
| - (NSArray *_Nullable) getPinnedUserListFromFirstView |
Gets all users that has been pined in first view.
References getPinnedUserListFromFirstView.
Referenced by getPinnedUserListFromFirstView.
| - (NSArray *_Nullable) getPinnedUserListFromSecondView |
Gets all users that has been pined in second view.
References getPinnedUserListFromSecondView.
Referenced by getPinnedUserListFromSecondView.
| - (NSString *) getShareMeetingChatStartedLegalNoticeContent |
Gets the sharing in meeting chat started legal notices content.
References getShareMeetingChatStartedLegalNoticeContent.
Referenced by getShareMeetingChatStartedLegalNoticeContent.
| - (NSString *) getShareMeetingChatStoppedLegalNoticeContent |
Gets the sharing in meeting chat stopped legal notices content.
References getShareMeetingChatStoppedLegalNoticeContent.
Referenced by getShareMeetingChatStoppedLegalNoticeContent.
| - (ZoomSDKError) getShareSettingType: | (ZoomSDKShareSettingType *) | type |
Gets the sharing types for the host or co-host in meeting.
| type | The custom sharing type. |
| - (NSArray *_Nullable) getSpotlightedUserList |
Gets all users that has been spotlighted.
References getSpotlightedUserList.
Referenced by getSpotlightedUserList.
| - (ZoomSDKUserInfo *_Nullable) getUserByUserID: | (unsigned int) | userID |
Gets the specified user's information.
| userID | The specified user's ID. |
| - (NSArray< NSNumber * > *_Nullable) getVideoOrderList |
Gets the video orde list.
References getVideoOrderList.
Referenced by getVideoOrderList.
| - (ZoomSDKError) hideParticipantProfilePictures: | (BOOL) | hide |
Hides or show participant profile pictures.
| hide | YES to hide participant profile pictures, NO to show participant pictures. |
| - (BOOL) is3rdPartyTelephonyAudioOn |
Determines if the meeting has third party telephony audio enabled.
References is3rdPartyTelephonyAudioOn.
Referenced by is3rdPartyTelephonyAudioOn.
| - (BOOL) isAlphaChannelModeEnabled |
Determines if alpha channel mode is enabled.
References isAlphaChannelModeEnabled.
Referenced by isAlphaChannelModeEnabled.
| - (BOOL) isAutoAllowLocalRecordingRequest |
Checks whether the current meeting auto-grants participants’ local recording privilege requests. It can only be used in regular meetings (not webinar or breakout room).
References isAutoAllowLocalRecordingRequest.
Referenced by isAutoAllowLocalRecordingRequest.
| - (BOOL) isChatMessageCanBeDeleted: | (NSString *) | msgID |
Determines whether the message can be deleted.
| msgID | The message ID. |
| - (ZoomSDKError) isDisplayingShareViewOrVideo: | (BOOL *) | isShowingShareView |
Determines if the meeting is displaying the sharing screen now.
| isShowingShareView | YES if showing share screen, NO if showing video. |
| - (BOOL) isFocusModeEnabled |
Gets the focus mode enabled or not by web portal.
References isFocusModeEnabled.
Referenced by isFocusModeEnabled.
| - (BOOL) isFocusModeOn |
Gets the focus mode on or off.
References isFocusModeOn.
Referenced by isFocusModeOn.
| - (BOOL) isFollowHostVideoOrderOn |
Determines whether the option of following host's video order is on of off.
References isFollowHostVideoOrderOn.
Referenced by isFollowHostVideoOrderOn.
| - (BOOL) isIncomingAudioStopped |
Determines if the incoming audio is stopped.
References isIncomingAudioStopped.
Referenced by isIncomingAudioStopped.
| - (BOOL) isIncomingVideoStopped |
Determines whether the coming video is stopedd.
References isIncomingVideoStopped.
Referenced by isIncomingVideoStopped.
| - (BOOL) isMeetingChatLegalNoticeAvailable |
Determines whether the legal notice for chat is available.
References isMeetingChatLegalNoticeAvailable.
Referenced by isMeetingChatLegalNoticeAvailable.
| - (BOOL) isMeetingQAFeatureOn |
Query if meeting QA is enabled in current meeting.
References isMeetingQAFeatureOn.
Referenced by isMeetingQAFeatureOn.
| - (BOOL) isMuteOnEntryEnabled |
Determines if mute on entry is enabled.
References isMuteOnEntryEnabled.
Referenced by isMuteOnEntryEnabled.
| - (BOOL) isParticipantProfilePicturesHidden |
Query if the current meeting hides participant pictures.
References isParticipantProfilePicturesHidden.
Referenced by isParticipantProfilePicturesHidden.
| - (BOOL) isParticipantRequestCloudRecordingAllowed |
Checks whether the current meeting allows participants to send cloud recording privilege request, it can be used in regular meeetings and webinar (no bo).
References isParticipantRequestCloudRecordingAllowed.
Referenced by isParticipantRequestCloudRecordingAllowed.
| - (BOOL) isParticipantRequestLocalRecordingAllowed |
Checks 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.
References isParticipantRequestLocalRecordingAllowed.
Referenced by isParticipantRequestLocalRecordingAllowed.
| - (BOOL) isParticipantsChatAllowed |
Determines if the chat is allowed.
References isParticipantsChatAllowed.
Referenced by isParticipantsChatAllowed.
| - (BOOL) isParticipantsRenameAllowed |
Determines if the participant rename is disabled.
References isParticipantsRenameAllowed.
Referenced by isParticipantsRenameAllowed.
| - (BOOL) isParticipantsShareAllowed |
Determines if the share screen is allowed.
References isParticipantsShareAllowed.
Referenced by isParticipantsShareAllowed.
| - (BOOL) isParticipantsShareWhiteBoardAllowed |
Checks whether the current meeting allows participants to share whiteboard, it can only be used in regular meeetings(no bo).
References isParticipantsShareWhiteBoardAllowed.
Referenced by isParticipantsShareWhiteBoardAllowed.
| - (BOOL) isParticipantsStartVideoAllowed |
Checks whether the current meeting allows participants to start video, it can only be used in regular meeetings(no bo).
References isParticipantsStartVideoAllowed.
Referenced by isParticipantsStartVideoAllowed.
| - (BOOL) isParticipantsUnmuteSelfAllowed |
Determines if participants can unmute themselves.
References isParticipantsUnmuteSelfAllowed.
Referenced by isParticipantsUnmuteSelfAllowed.
| - (BOOL) isPlayMeetingAudioEnabled |
Determines if play meeting audio is enabled or not.
References isPlayMeetingAudioEnabled.
Referenced by isPlayMeetingAudioEnabled.
| - (BOOL) isSelfOriginalHost |
Query whether the current user is the original host.
References isSelfOriginalHost.
Referenced by isSelfOriginalHost.
| - (BOOL) isShareMeetingChatLegalNoticeAvailable |
Determines whether the legal notice for sharing in meeting chat is available.
References isShareMeetingChatLegalNoticeAvailable.
Referenced by isShareMeetingChatLegalNoticeAvailable.
| - (BOOL) isShowAvatar |
Determines if the meeting is showing the avatar.
References isShowAvatar.
Referenced by isShowAvatar.
| - (BOOL) isSpeakerContrastEnhanceEnabled |
Determines if contrast enhancement effect for speaker video is enabled.
References isSpeakerContrastEnhanceEnabled.
Referenced by isSpeakerContrastEnhanceEnabled.
| - (BOOL) isSupportFollowHostVideoOrder |
Determines whether this meeting support following host's video orde.
References isSupportFollowHostVideoOrder.
Referenced by isSupportFollowHostVideoOrder.
| - (BOOL) isSupportUseOriginalSound |
Determines if the meeting supports user's original sound.
References isSupportUseOriginalSound.
Referenced by isSupportUseOriginalSound.
| - (BOOL) isSupportVirtualNameTag |
Determines if there is support for the virtual name tag feature.
References isSupportVirtualNameTag.
Referenced by isSupportVirtualNameTag.
| - (BOOL) isUseOriginalSoundOn |
Determines if user's original sound is enabled.
References isUseOriginalSoundOn.
Referenced by isUseOriginalSoundOn.
| - (ZoomSDKError) lowerAllHands: | (BOOL) | forWebinarAttendees |
Lower all hands raised.
| forWebinarAttendees | YES to lower all hands for webinar attendee, NO otherwise. |
ZoomSDKError_Success. Otherwise, this function returns an error. | - (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's user ID to be assigned as host. |
| infoList | An array of ZoomSDKGrantCoOwnerAssetsInfo objects representing the assets and privileges to grant. |
ZoomSDKError_Success. Otherwise, this function returns an error.| - (ZoomSDKError) pinVideoToFirstView: | (unsigned int) | userID |
Pin user's video to first view.
| userID | The user's user ID you want to pin. |
| - (ZoomSDKError) pinVideoToSecondView: | (unsigned int) | userID |
Pin user's video to second view.
| userID | The user's user ID you want to pin. |
| - (ZoomSDKError) raiseHand: | (BOOL) | raise | |
| UserID: | (unsigned int) | userid |
Make the specified user to raise hand or lower hand.
| raise | YES to raise hand, NO to lower hand for this specified user. |
| userid | User ID of the user to be modified. |
| - (ZoomSDKError) reclaimHost |
Reclaim the host's role.
References reclaimHost.
Referenced by reclaimHost.
| - (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, this function returns an error. | - (ZoomSDKError) setFocusModeShareType: | (ZoomSDKFocusModeShareType) | shareType |
Sets 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 |
Sets the meeting topic on meeting info.
| topic | The meeting topic. |
ZoomSDKError_Success. Otherwise, this function returns an error. | - (ZoomSDKError) setParticipantsChatPrivilege: | (ZoomSDKChatPrivilegeType) | privilege |
Sets participants chat privilege.
| privilege | The chat privilege type to assign to participants. |
| - (ZoomSDKError) setShareSettingType: | (ZoomSDKShareSettingType) | shareType |
Sets sharing types for the host or co-host in meeting.
| shareType | The custom sharing type. |
| - (ZoomSDKError) setVideoOrder: | (NSArray< NSNumber * > *) | orderList |
Sets the video order.
| orderList | The array contains the listed user ID. |
| - (ZoomSDKError) showAvatar: | (BOOL) | show |
Determines if show the last used avatar in the meeting.
| show | YES indicates to show the last used avatar, NO otherwise. |
| - (ZoomSDKError) spotlightVideo: | (unsigned int) | userID |
Spotlight someone's video.
| userID | The user's user ID you want to spotlight. |
| - (ZoomSDKError) stopIncomingAudio: | (BOOL) | stop |
Stops the incoming audio.
| stop | YES to stop, NO otherwise. |
| - (ZoomSDKError) stopIncomingVideo: | (BOOL) | stop |
Stops in coming video.
| stop | YES to stop in coming video, NO is start coming video. |
| - (ZoomSDKError) suspendParticipantsActivities |
Suspend all participants activities.
References suspendParticipantsActivities.
Referenced by suspendParticipantsActivities.
| - (ZoomSDKError) swapToShowShareViewOrVideo: | (BOOL) | share |
Swap to show sharing screen or video.
| share | YES to swap to sharing screen, NO to swap to video. |
| - (ZoomSDKError) turnFocusModeOn: | (BOOL) | on |
Turn focus mode on or off. Focus mode on means Participants onlies 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.
References unPinAllVideosFromFirstView.
Referenced by unPinAllVideosFromFirstView.
| - (ZoomSDKError) unPinVideoFromFirstView: | (unsigned int) | userID |
Unpin user's video to first view.
| userID | The user's user ID you want to unpin. |
| - (ZoomSDKError) unPinVideoFromSecondView: | (unsigned int) | userID |
Unpin user's video to second view.
| userID | The user's user ID you want to unpin. |
| - (ZoomSDKError) unSpotlightAllVideos |
Unspotlight all videos.
References unSpotlightAllVideos.
Referenced by unSpotlightAllVideos.
| - (ZoomSDKError) unSpotlightVideo: | (unsigned int) | userID |
Unspotlight someone's video.
| userID | The user's user ID you want to unspotlight. |
| - (ZoomSDKError) updateVirtualNameTagRosterInfo: | (NSArray< ZoomSDKVirtualNameTag * > *) | userRoster |
Updates the virtual name tag roster infomation for the account.
| userRoster | The virtual name tag roster info list for the specified user. |
ZoomSDKError_Success. Otherwise, this function returns an error.
|
protected |
Definition at line 895 of file ZoomSDKMeetingActionController.h.
|
readwritenonatomicassign |
Sets or get the delegate to receive meeting action events.
Definition at line 900 of file ZoomSDKMeetingActionController.h.
1.16.1