ZoomSDKMeetingActionController.h

Go to the documentation of this file.

 
#import <ZoomSDK/ZoomSDKErrors.h>
#import <ZoomSDK/ZoomSDKMeetingChatController.h>
NS_ASSUME_NONNULL_BEGIN
 
@interface ZoomSDKGrantCoOwnerAssetsInfo : NSObject
@property (assign, nonatomic) BOOL isGranted;
@property (assign,nonatomic, readonly) ZoomSDKGrantCoOwnerAssetsType assetType;
@property (assign,nonatomic, readonly) BOOL isAssetsLocked;
@end
 
@interface ZoomSDKMultiToSingleShareConfirmHandler : NSObject
- (ZoomSDKError)cancelSwitch;
- (ZoomSDKError)confirmSwitch;
@end
 
@interface ZoomSDKChatInfo : NSObject
{
    unsigned int                      _sendID;
    unsigned int                      _receiverID;
    NSString*                         _sendName;
    NSString*                         _receiverName;
    NSString*                         _content;
    time_t                            _timestamp;
    BOOL                              _isChatToWaitingRoom;
    ZoomSDKChatMessageType            _chatMessageType;
}
- (unsigned int)getSenderUserID;
- (NSString*)getSenderDisplayName;
- (unsigned int)getReceiverUserID;
- (NSString*)getReceiverDisplayName;
- (NSString*)getMsgContent;
- (time_t)getTimeStamp;
- (BOOL)isChatToWaitingRoom;
- (ZoomSDKChatMessageType)getChatMessageType;
- (NSString*)getMessageID;
 
- (BOOL)isComment;
 
- (BOOL)isThread;
 
- (NSArray<ZoomSDKRichTextStyleItem *> *_Nullable)getTextStyleItemList DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (NSArray<ZoomSDKChatMsgSegmentDetails *> *_Nullable)getSegmentDetails;
 
- (NSString*)getThreadID;
@end
 
@interface ZoomSDKNormalMeetingChatPrivilege : NSObject
@property (assign,nonatomic,readonly) BOOL canChat;
@property (assign,nonatomic,readonly) BOOL canChatToAll;
@property (assign,nonatomic,readonly) BOOL canChatToIndividual;
@property (assign,nonatomic,readonly) BOOL isOnlyCanChatToHost;
@end
 
@interface ZoomSDKWebinarAttendeeChatPrivilege : NSObject
@property (assign,nonatomic,readonly) BOOL canChat;
@property (assign,nonatomic,readonly) BOOL canChatToAllPanellistAndAttendee;
@property (assign,nonatomic,readonly) BOOL canChatToAllPanellist;
@end
 
@interface ZoomSDKWebinarPanelistChatPrivilege : NSObject
@property (assign,nonatomic,readonly) BOOL canChatToAllPanellist;
@property (assign,nonatomic,readonly) BOOL canChatToAllPanellistAndAttendee;
@property (assign,nonatomic,readonly) BOOL canChatToIndividual;
@end
 
@interface ZoomSDKChatStatus : NSObject
- (ZoomSDKNormalMeetingChatPrivilege *)getNormalMeetingPrivilege;
- (ZoomSDKWebinarAttendeeChatPrivilege *)getWebinarAttendeePrivilege;
- (ZoomSDKWebinarPanelistChatPrivilege *)getWebinarPanelistPrivilege;
- (BOOL)isSupportChat;
- (BOOL)isWebinarAttendee;
- (BOOL)isWebinarMeeting;
@end
 
@interface ZoomSDKUserAudioStatus : NSObject
{
    unsigned int _userID;
    ZoomSDKAudioStatus _status;
    ZoomSDKAudioType _type;
}
- (unsigned int)getUserID;
- (ZoomSDKAudioStatus)getStatus;
- (ZoomSDKAudioType)getType;
@end
 
 
@interface ZoomSDKWebinarAttendeeStatus : NSObject
{
    BOOL _isAttendeeCanTalk;
}
@property(nonatomic, assign)BOOL  isAttendeeCanTalk;
@end
 
 
@interface ZoomSDKVirtualNameTag : NSObject
@property (nonatomic, assign) int tagID;
 
@property (nonatomic, copy, nullable) NSString *tagName;
@end
 
 
@interface ZoomSDKUserInfo :NSObject
{
    unsigned int _userID;
}
- (BOOL)isMySelf;
- (NSString*_Nullable)getUserName;
- (unsigned int)getUserID;
 
- (NSString*_Nullable)getAvatarPath;
 
- (BOOL)isHost;
- (BOOL)isVideoOn;
 
- (ZoomSDKAudioStatus)getAudioStatus;
- (ZoomSDKAudioType)getAudioType;
- (UserRole)getUserRole;
- (BOOL)isPurePhoneUser;
- (BOOL)isH323User;
- (BOOL)canBeCoHost;
 
- (BOOL)canBeCoOwner;
 
- (ZoomSDKWebinarAttendeeStatus*_Nullable)GetWebinarAttendeeStatus;
 
- (BOOL)isTalking;
 
- (NSString *_Nullable)getCustomerKey;
 
- (BOOL)isInterpreter;
 
- (BOOL)isSignLanguageInterpreter;
 
- (NSString *_Nullable)getInterpreterActiveLanguage;
 
- (BOOL)isRaisingHand;
 
- (ZoomSDKRecordingStatus)getLocalRecordingStatus;
 
- (NSString *_Nullable)getPersistentId;
 
- (BOOL)isRawLiveStreaming;
 
- (BOOL)hasRawLiveStreamPrivilege;
 
- (ZoomSDKEmojiFeedbackType)getEmojiFeedbackType;
 
- (BOOL)hasCamera;
 
- (BOOL)isInWaitingRoom;
 
- (BOOL)isInWebinarBackstage;
 
- (BOOL)isClosedCaptionSender;
 
- (BOOL)isProductionStudioUser;
 
- (unsigned int)getProductionStudioParent;
 
- (BOOL)isBotUser;
 
- (NSString * _Nullable)getBotAppName;
 
- (BOOL)isVirtualNameTagEnabled;
 
- (nullable NSArray<ZoomSDKVirtualNameTag*> *)getVirtualNameTagArray;
 
- (BOOL)isCompanionModeUser;
 
- (NSArray <ZoomSDKGrantCoOwnerAssetsInfo *>* _Nullable)getGrantCoOwnerAssetsInfo;
@end
 
 
 
@interface ZoomSDKJoinMeetingHelper :NSObject
{
    JoinMeetingReqInfoType   _reqInfoType;
}
- (JoinMeetingReqInfoType)getReqInfoType;
- (ZoomSDKError)inputPassword:(NSString*)password;
 
- (ZoomSDKError)inputMeetingScreenName:(NSString*)screenName;
 
- (ZoomSDKError)cancel;
@end
 
 
@protocol ZoomSDKMeetingActionControllerDelegate <NSObject>
 
- (void)onUserAudioStatusChange:(NSArray*)userAudioStatusArray;
 
- (void)onUserJoin:(NSArray*)array;
 
- (void)onUserLeft:(NSArray*)array;
 
- (void)onUserInfoUpdate:(unsigned int)userID DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (void)onVirtualNameTagStatusChanged:(BOOL)bOn userID:(unsigned int)userID;
 
- (void)onVirtualNameTagRosterInfoUpdated:(unsigned int)userID;
 
- (void)onHostChange:(unsigned int)userID;
 
- (void)onMeetingCoHostChanged:(unsigned int)userID isCoHost:(BOOL)isCoHost;
 
- (void)onSpotlightVideoUserChange:(NSArray*_Nullable)spotlightedUserList;
 
- (void)onVideoStatusChange:(ZoomSDKVideoStatus)videoStatus UserID:(unsigned int)userID;
- (void)onLowOrRaiseHandStatusChange:(BOOL)raise UserID:(unsigned int)userID;
 
- (void)onJoinMeetingResponse:(ZoomSDKJoinMeetingHelper*_Nullable)joinMeetingHelper;
 
- (void)onMultiToSingleShareNeedConfirm:(ZoomSDKMultiToSingleShareConfirmHandler*_Nullable)confirmHandle;
- (void)onActiveVideoUserChanged:(unsigned int)userID;
- (void)onActiveSpeakerVideoUserChanged:(unsigned int)userID;
- (void)onHostAskUnmute;
- (void)onHostAskStartVideo;
- (void)onUserActiveAudioChange:(NSArray *)useridArray;
 
- (void)onUserNamesChanged:(NSArray<NSNumber*>*)userList;
 
- (void)onInvalidReclaimHostKey;
 
- (void)onHostVideoOrderUpdated:(NSArray*)orderList;
 
- (void)onLocalVideoOrderUpdated:(NSArray*)localOrderList;
 
- (void)onFollowHostVideoOrderChanged:(BOOL)follow;
 
- (void)onAllHandsLowered;
 
- (void)onUserVideoQualityChanged:(ZoomSDKVideoQuality)quality userID:(unsigned int)userID;
 
- (void)onChatMsgDeleteNotification:(NSString*)msgID messageDeleteType:(ZoomSDKChatMessageDeleteType)deleteBy;
 
- (void)onChatStatusChangedNotification:(ZoomSDKChatStatus *)chatStatus;
 
- (void)onShareMeetingChatStatusChanged:(BOOL)isStart;
 
- (void)onSuspendParticipantsActivities;
 
- (void)onAllowParticipantsStartVideoNotification:(BOOL)allow;
 
- (void)onAllowParticipantsRenameNotification:(BOOL)allow;
 
- (void)onAllowParticipantsUnmuteSelfNotification:(BOOL)allow;
 
- (void)onAllowParticipantsShareWhiteBoardNotification:(BOOL)allow;
 
- (void)onMeetingLockStatus:(BOOL)isLock;
 
- (void)onRequestLocalRecordingPrivilegeChanged:(ZoomSDKLocalRecordingRequestPrivilegeStatus)status;
 
- (void)onAllowParticipantsRequestCloudRecording:(BOOL)allow;
- (void)onInMeetingUserAvatarPathUpdated:(unsigned int)userID;
 
- (void)onAICompanionActiveChangeNotice:(BOOL)active;
 
- (void)onParticipantProfilePictureStatusChange:(BOOL)hidden;
 
- (void)onVideoAlphaChannelStatusChanged:(BOOL)isAlphaModeOn;
 
- (void)onFocusModeStateChanged:(BOOL)on;
 
- (void)onFocusModeShareTypeChanged:(ZoomSDKFocusModeShareType)shareType;
 
- (void)onMeetingQAStatusChanged:(BOOL)isMeetingQAFeatureOn;
 
 - (void)notifyToJoin3rdPartyTelephonyAudio:(NSString*)audioInfo;
 
- (void)onCameraControlRequestReceived:(unsigned int)userId requestType:(ZoomSDKCameraControlRequestType)requestType actionApprove:(nullable ZoomSDKError(^)(void))actionApprove actionDecline:(nullable ZoomSDKError(^)(void))actionDecline;
 
- (void)onCameraControlRequestResult:(unsigned int)userId resultType:(ZoomSDKCameraControlRequestResult)resultType;
 
- (void)onMuteOnEntryStatusChange:(BOOL)enable;
 
- (void)onMeetingTopicChanged:(NSString *)topic;
 
- (void)onBotAuthorizerRelationChanged:(unsigned int)authorizeUserID;
 
- (void)onCreateCompanionRelation:(unsigned int)parentUserID childUserID:(unsigned int)childUserID;
 
- (void)onRemoveCompanionRelation:(unsigned int)childUserID;
 
- (void)onGrantCoOwnerPrivilegeChanged:(BOOL)canGrantOther;
@end
 
 
@interface ZoomSDKMeetingActionController : NSObject
{
    id<ZoomSDKMeetingActionControllerDelegate> _delegate;
}
@property(nonatomic, assign, nullable) id<ZoomSDKMeetingActionControllerDelegate> delegate;
 
- (NSArray*_Nullable)getParticipantsList;
- (ZoomSDKError)actionMeetingWithCmd:(ActionMeetingCmd)cmd userID:(unsigned int)userID onScreen:(ScreenType)screen;
 
- (ZoomSDKUserInfo*_Nullable)getUserByUserID:(unsigned int)userID;
 
- (ZoomSDKUserInfo*_Nullable)getMyself;
 
- (ZoomSDKError)changeUserName:(unsigned int)userID newName:(NSString*)name;
 
- (ZoomSDKError)makeHost:(unsigned int)userID;
 
- (ZoomSDKError)raiseHand:(BOOL)raise UserID:(unsigned int)userid;
 
- (ZoomSDKError)expelUser:(unsigned int)userid;
 
- (ZoomSDKError)allowLocalRecord:(BOOL)allow UserID:(unsigned int)userid;
 
- (BOOL)isSelfOriginalHost;
 
- (BOOL)canReclaimHost;
 
- (ZoomSDKError)reclaimHost;
- (ZoomSDKError)claimHostByKey:(NSString*)hostKey;
- (ZoomSDKError)assignCoHost:(unsigned int)userid;
 
- (ZoomSDKError)revokeCoHost:(unsigned int)userid;
 
- (ZoomSDKError)setShareSettingType:(ZoomSDKShareSettingType)shareType;
 
- (ZoomSDKError)getShareSettingType:(ZoomSDKShareSettingType*)type;
 
- (BOOL)isUseOriginalSoundOn;
 
- (ZoomSDKError)enableUseOriginalSound:(BOOL)enable;
 
- (BOOL)isSupportUseOriginalSound;
 
- (ZoomSDKError)swapToShowShareViewOrVideo:(BOOL)share;
 
- (BOOL)canSwapBetweenShareViewOrVideo;
 
- (ZoomSDKError)isDisplayingShareViewOrVideo:(BOOL*)isShowingShareView;
 
- (ZoomSDKError)setMeetingTopicOnMeetingInfo:(NSString *)topic DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (BOOL)canSetMeetingTopic;
 
- (ZoomSDKError)setMeetingTopic:(NSString *)topic;
 
- (BOOL)canEnableMuteOnEntry;
 
- (BOOL)isMuteOnEntryEnabled;
 
- (BOOL)isParticipantsShareAllowed;
 
- (ZoomSDKError)allowParticipantsToShare:(BOOL)allow;
 
- (BOOL)isParticipantsChatAllowed;
 
- (ZoomSDKError)allowParticipantsToChat:(BOOL)allow;
 
- (BOOL)isParticipantsRenameAllowed;
 
- (ZoomSDKError)allowParticipantsToRename:(BOOL)allow;
 
- (ZoomSDKError)canSpotlight:(unsigned int)userID result:(ZoomSDKSpotlightResult*)result;
 
- (ZoomSDKError)canUnSpotlight:(unsigned int)userID result:(ZoomSDKSpotlightResult*)result;
 
- (ZoomSDKError)spotlightVideo:(unsigned int)userID;
 
- (ZoomSDKError)unSpotlightVideo:(unsigned int)userID;
 
- (ZoomSDKError)unSpotlightAllVideos;
 
- (NSArray*_Nullable)getSpotlightedUserList;
 
- (ZoomSDKError)canPinToFirstView:(unsigned int)userID result:(ZoomSDKPinResult*)result;
 
- (ZoomSDKError)pinVideoToFirstView:(unsigned int)userID;
 
- (ZoomSDKError)unPinVideoFromFirstView:(unsigned int)userID;
 
- (ZoomSDKError)unPinAllVideosFromFirstView;
 
- (NSArray*_Nullable)getPinnedUserListFromFirstView;
 
- (ZoomSDKError)canPinToSecondView:(unsigned int)userID result:(ZoomSDKPinResult*)result;
 
- (ZoomSDKError)pinVideoToSecondView:(unsigned int)userID;
 
- (ZoomSDKError)unPinVideoFromSecondView:(unsigned int)userID;
 
- (NSArray*_Nullable)getPinnedUserListFromSecondView;
 
- (BOOL)isParticipantsUnmuteSelfAllowed;
 
- (BOOL)isMeetingChatLegalNoticeAvailable;
 
- (NSString *)getChatLegalNoticesPrompt;
 
- (NSString *)getChatLegalNoticesExplained;
 
- (ZoomSDKError)enableFollowHostVideoOrder:(BOOL)enable;
 
- (ZoomSDKError)setVideoOrder:(NSArray<NSNumber*>*)orderList;
 
- (BOOL)isFollowHostVideoOrderOn;
 
- (BOOL)isSupportFollowHostVideoOrder;
 
- (NSArray<NSNumber*>*_Nullable)getVideoOrderList;
 
- (ZoomSDKError)lowerAllHands:(BOOL)forWebinarAttendees;
 
- (BOOL)isChatMessageCanBeDeleted:(NSString*)msgID;
 
- (ZoomSDKError)deleteChatMessage:(NSString*)msgID;
 
- (NSArray<NSString*>*_Nullable)getAllChatMessageID;
 
- (ZoomSDKError)setParticipantsChatPrivilege:(ZoomSDKChatPrivilegeType)privilege;
 
- (ZoomSDKChatStatus *_Nullable)getChatStatus;
 
- (BOOL)isShareMeetingChatLegalNoticeAvailable;
 
- (NSString*)getShareMeetingChatStartedLegalNoticeContent;
 
- (NSString*)getShareMeetingChatStoppedLegalNoticeContent;
 
- (ZoomSDKError)stopIncomingAudio:(BOOL)stop;
 
- (BOOL)isIncomingAudioStopped;
 
- (ZoomSDKError)stopIncomingVideo:(BOOL)stop;
 
- (BOOL)isIncomingVideoStopped;
 
- (ZoomSDKError)showAvatar:(BOOL)show;
 
- (BOOL)isShowAvatar;
 
- (ZoomSDKError)allowParticipantsToStartVideo:(BOOL)bAllow;
 
- (BOOL)isParticipantsStartVideoAllowed;
 
- (ZoomSDKError)allowParticipantsToShareWhiteBoard:(BOOL)bAllow;
 
- (BOOL)isParticipantsShareWhiteBoardAllowed;
 
- (BOOL)isParticipantRequestLocalRecordingAllowed;
 
- (ZoomSDKError)allowParticipantsToRequestLocalRecording:(BOOL)bAllow;
 
- (BOOL)isAutoAllowLocalRecordingRequest;
 
- (ZoomSDKError)autoAllowLocalRecordingRequest:(BOOL)bAllow;
 
- (BOOL)canSuspendParticipantsActivities;
 
- (ZoomSDKError)suspendParticipantsActivities;
 
- (ZoomSDKError)canHideParticipantProfilePictures;
 
- (BOOL)isParticipantProfilePicturesHidden;
 
- (ZoomSDKError)hideParticipantProfilePictures:(BOOL)hide;
 
- (BOOL)canEnableAlphaChannelMode;
 
- (ZoomSDKError)enableAlphaChannelMode:(BOOL)enabled;
 
- (BOOL)isAlphaChannelModeEnabled;
 
- (BOOL)isFocusModeEnabled;
 
- (ZoomSDKError)turnFocusModeOn:(BOOL)on;
 
- (BOOL)isFocusModeOn;
 
- (ZoomSDKFocusModeShareType)getFocusModeShareType;
 
- (ZoomSDKError)setFocusModeShareType:(ZoomSDKFocusModeShareType)shareType;
 
- (ZoomSDKError)enableMeetingQAFeature:(BOOL)enable;
 
- (BOOL)isMeetingQAFeatureOn;
- (BOOL)canEnableParticipantRequestCloudRecording;
 
- (BOOL)isParticipantRequestCloudRecordingAllowed;
 
- (ZoomSDKError)allowParticipantsToRequestCloudRecording:(BOOL)allow;
 
- (BOOL)is3rdPartyTelephonyAudioOn;
 
- (ZoomSDKUserInfo * _Nullable)getBotAuthorizedUserInfoByUserID:(unsigned int)userId;
 
- (NSArray<NSNumber*>* _Nullable)getAuthorizedBotListByUserID:(unsigned int)userId;
 
- (BOOL)isSupportVirtualNameTag;
 
- (ZoomSDKError)enableVirtualNameTag:(BOOL)bEnabled;
 
- (ZoomSDKError)updateVirtualNameTagRosterInfo:(NSArray<ZoomSDKVirtualNameTag*>*)userRoster;
 
- (BOOL)isPlayMeetingAudioEnabled;
 
- (ZoomSDKError)enablePlayMeetingAudio:(BOOL)bEnabled;
 
- (BOOL)isSpeakerContrastEnhanceEnabled;
 
- (ZoomSDKError)enableSpeakerContrastEnhance:(BOOL)bEnabled;
 
- (ZoomSDKUserInfo* _Nullable)getCompanionParentUser:(unsigned int)userid;
 
- (NSArray<NSNumber*>* _Nullable)getCompanionChildList:(unsigned int)userid;
 
- (ZoomSDKError)assignCoHostWithAssetsPrivilege:(unsigned int)userid infoList:(NSArray<ZoomSDKGrantCoOwnerAssetsInfo *>*)infoList;
 
- (ZoomSDKError)makeHostWithAssetsPrivilege:(unsigned int)userid infoList:(NSArray<ZoomSDKGrantCoOwnerAssetsInfo *>*)infoList;
@end
NS_ASSUME_NONNULL_END