macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingActionController.h
Go to the documentation of this file.
2#import "ZoomSDKErrors.h"
3
15@end
16
20@interface ZoomSDKChatInfo : NSObject
21{
22 unsigned int _sendID;
23 unsigned int _receiverID;
24 NSString* _sendName;
25 NSString* _receiverName;
26 NSString* _content;
27 time_t _timestamp;
30}
35- (unsigned int)getSenderUserID;
40- (NSString*)getSenderDisplayName;
45- (unsigned int)getReceiverUserID;
50- (NSString*)getReceiverDisplayName;
55- (NSString*)getMsgContent;
60- (time_t)getTimeStamp;
65-(BOOL)isChatToWaitingRoom;
70-(ZoomSDKChatMessageType)getChatMessageType;
75- (NSString*)getMessageID;
76@end
77
85@property (assign,nonatomic,readonly) BOOL canChat;
89@property (assign,nonatomic,readonly) BOOL canChatToAll;
93@property (assign,nonatomic,readonly) BOOL canChatToIndividual;
97@property (assign,nonatomic,readonly) BOOL isOnlyCanChatToHost;
98@end
99
107@property (assign,nonatomic,readonly) BOOL canChat;
111@property (assign,nonatomic,readonly) BOOL canChatToAllPanellistAndAttendee;
115@property (assign,nonatomic,readonly) BOOL canChatToAllPanellist;
116@end
117
125@property (assign,nonatomic,readonly) BOOL canChatToAllPanellist;
129@property (assign,nonatomic,readonly) BOOL canChatToAllPanellistAndAttendee;
133@property (assign,nonatomic,readonly) BOOL canChatToIndividual;
134@end
135
139@interface ZoomSDKChatStatus : NSObject
144- (ZoomSDKNormalMeetingChatPrivilege *)getNormalMeetingPrivilege;
149- (ZoomSDKWebinarAttendeeChatPrivilege *)getWebinarAttendeePrivilege;
154- (ZoomSDKWebinarPanelistChatPrivilege *)getWebinarPanelistPrivilege;
159- (BOOL)isSupportChat;
164- (BOOL)isWebinarAttendee;
169- (BOOL)isWebinarMeeting;
170@end
171
175@interface ZoomSDKUserAudioStatus : NSObject
176{
177 unsigned int _userID;
180}
185- (unsigned int)getUserID;
190- (ZoomSDKAudioStatus)getStatus;
195- (ZoomSDKAudioType)getType;
196@end
200@interface ZoomSDKWebinarAttendeeStatus : NSObject
201{
203}
204@property(nonatomic, assign)BOOL isAttendeeCanTalk;
205@end
209@interface ZoomSDKUserInfo :NSObject
210{
211 unsigned int _userID;
212}
217- (BOOL)isMySelf;
222- (NSString*)getUserName;
227- (unsigned int)getUserID;
232- (BOOL)isHost;
237- (BOOL)isVideoOn;
238
243- (ZoomSDKAudioStatus)getAudioStatus;
248- (ZoomSDKAudioType)getAudioType;
253- (UserRole)getUserRole;
258- (BOOL)isPurePhoneUser;
263- (BOOL)isH323User;
268- (BOOL)canBeCoHost;
273- (ZoomSDKWebinarAttendeeStatus*)GetWebinarAttendeeStatus;
274
279- (BOOL)isTalking;
280
285- (NSString *)getCustomerKey;
286
291- (BOOL)isInterpreter;
292
297- (BOOL)isSignLanguageInterpreter;
298
303- (NSString *)getInterpreterActiveLanguage;
304
309- (BOOL)isRaisingHand;
310
315- (ZoomSDKRecordingStatus)getLocalRecordingStatus;
316
321- (NSString *)getPersistentId;
322
327- (BOOL)isRawLiveStreaming;
328
333- (BOOL)hasRawLiveStreamPrivilege;
334@end
338@interface ZoomSDKJoinMeetingHelper :NSObject
339{
341}
346-(JoinMeetingReqInfoType)getReqInfoType;
352-(ZoomSDKError)inputPassword:(NSString*)password;
357-(ZoomSDKError)cancel;
358@end
359
360
361@protocol ZoomSDKMeetingActionControllerDelegate <NSObject>
362
367- (void)onUserAudioStatusChange:(NSArray*)userAudioStatusArray;
368
373- (void)onChatMessageNotification:(ZoomSDKChatInfo*)chatInfo;
374
380- (void)onUserJoin:(NSArray*)array;
381
386- (void)onUserLeft:(NSArray*)array;
387
392- (void)onUserInfoUpdate:(unsigned int)userID;
393
399- (void)onHostChange:(unsigned int)userID;
400
406- (void)onMeetingCoHostChanged:(unsigned int)userID isCoHost:(BOOL)isCoHost;
407
412- (void)onSpotlightVideoUserChange:(NSArray*)spotlightedUserList;
413
420- (void)onVideoStatusChange:(ZoomSDKVideoStatus)videoStatus UserID:(unsigned int)userID;
426- (void)onLowOrRaiseHandStatusChange:(BOOL)raise UserID:(unsigned int)userID;
427
432- (void)onJoinMeetingResponse:(ZoomSDKJoinMeetingHelper*)joinMeetingHelper;
433
438- (void)onMultiToSingleShareNeedConfirm:(ZoomSDKMultiToSingleShareConfirmHandler*)confirmHandle;
443- (void)onActiveVideoUserChanged:(unsigned int)userID;
448- (void)onActiveSpeakerVideoUserChanged:(unsigned int)userID;
452- (void)onHostAskUnmute;
456- (void)onHostAskStartVideo;
461- (void)onUserActiveAudioChange:(NSArray *)useridArray;
462
468- (void)onUserNamesChanged:(NSArray<NSNumber*>*)userList;
469
473- (void)onInvalidReclaimHostKey;
474
479- (void)onHostVideoOrderUpdated:(NSArray*)orderList;
480
485- (void)onLocalVideoOrderUpdated:(NSArray*)localOrderList;
486
491- (void)onFollowHostVideoOrderChanged:(BOOL)follow;
492
496- (void)onAllHandsLowered;
497
503- (void)onUserVideoQualityChanged:(ZoomSDKVideoQuality)quality userID:(unsigned int)userID;
504
510- (void)onChatMsgDeleteNotification:(NSString*)msgID messageDeleteType:(ZoomSDKChatMessageDeleteType)deleteBy;
511
516- (void)onChatStatusChangedNotification:(ZoomSDKChatStatus *)chatStatus;
517
522- (void)onShareMeetingChatStatusChanged:(BOOL)isStart;
523@end
524
526{
527 id<ZoomSDKMeetingActionControllerDelegate> _delegate;
528// NSMutableArray* _participantsArray;
529}
530@property(nonatomic, assign) id<ZoomSDKMeetingActionControllerDelegate> delegate;
531
536- (NSArray*)getParticipantsList;
544- (ZoomSDKError)actionMeetingWithCmd:(ActionMeetingCmd)cmd userID:(unsigned int)userID onScreen:(ScreenType)screen;
545
552- (ZoomSDKError)sendChat:(NSString*)content toUser:(unsigned int)userID chatType:(ZoomSDKChatMessageType)type;
553
559- (ZoomSDKUserInfo*)getUserByUserID:(unsigned int)userID;
560
565- (ZoomSDKUserInfo*)getMyself;
566
573- (ZoomSDKError)changeUserName:(unsigned int)userID newName:(NSString*)name;
574
580- (ZoomSDKError)makeHost:(unsigned int)userID;
581
588- (ZoomSDKError)raiseHand:(BOOL)raise UserID:(unsigned int)userid;
589
595- (ZoomSDKError)expelUser:(unsigned int)userid;
596
602- (ZoomSDKError)startCMR:(BOOL)start DEPRECATED_MSG_ATTRIBUTE("Use -startCloudRecording: instead");
603
611- (ZoomSDKError)getMeetingUIType:(ScreenType)type isFullScreen:(BOOL*)bFullScreen meetingUIType:(MeetingUIType*)meetingUIType DEPRECATED_ATTRIBUTE;
612
619- (ZoomSDKError)allowLocalRecord:(BOOL)allow UserID:(unsigned int)userid;
620
625- (BOOL)canReclaimHost;
626
631- (ZoomSDKError)reclaimHost;
637- (ZoomSDKError)claimHostByKey:(NSString*)hostKey;
644-(ZoomSDKError)assignCoHost:(unsigned int)userid;
645
652-(ZoomSDKError)revokeCoHost:(unsigned int)userid;
653
659-(ZoomSDKError)setShareSettingType:(ZoomSDKShareSettingType)shareType;
660
666- (ZoomSDKError)getShareSettingType:(ZoomSDKShareSettingType*)type;
667
672- (BOOL)isUseOriginalSoundOn;
673
679- (ZoomSDKError)enableUseOriginalSound:(BOOL)enable;
680
685- (BOOL)isSupportUseOriginalSound;
686
693- (ZoomSDKError)swapToShowShareViewOrVideo:(BOOL)share;
694
699- (BOOL)canSwapBetweenShareViewOrVideo;
700
706- (ZoomSDKError)isDisplayingShareViewOrVideo:(BOOL*)isShowingShareView;
707
713- (ZoomSDKError)setMeetingTopicOnMeetingInfo:(NSString *)topic;
714
719-(BOOL)isParticipantsShareAllowed;
720
726- (ZoomSDKError)allowParticipantsToShare:(BOOL)allow;
727
732-(BOOL)isParticipantsChatAllowed;
733
739- (ZoomSDKError)allowParticipantsToChat:(BOOL)allow;
740
745-(BOOL)isParticipantsRenameAllowed;
746
752- (ZoomSDKError)allowParticipantsToRename:(BOOL)allow;
753
760- (ZoomSDKError)canSpotlight:(unsigned int)userID result:(ZoomSDKSpotlightResult*)result;
761
768- (ZoomSDKError)canUnSpotlight:(unsigned int)userID result:(ZoomSDKSpotlightResult*)result;
769
775- (ZoomSDKError)spotlightVideo:(unsigned int)userID;
776
782- (ZoomSDKError)unSpotlightVideo:(unsigned int)userID;
783
788- (ZoomSDKError)unSpotlightAllVideos;
789
794- (NSArray*)getSpotlightedUserList;
795
802- (ZoomSDKError)canPinToFirstView:(unsigned int)userID result:(ZoomSDKPinResult*)result;
803
809- (ZoomSDKError)pinVideoToFirstView:(unsigned int)userID;
810
816- (ZoomSDKError)unPinVideoFromFirstView:(unsigned int)userID;
817
822- (ZoomSDKError)unPinAllVideosFromFirstView;
823
828- (NSArray*)getPinnedUserListFromFirstView;
829
836- (ZoomSDKError)canPinToSecondView:(unsigned int)userID result:(ZoomSDKPinResult*)result;
837
843- (ZoomSDKError)pinVideoToSecondView:(unsigned int)userID;
844
850- (ZoomSDKError)unPinVideoFromSecondView:(unsigned int)userID;
851
856- (NSArray*)getPinnedUserListFromSecondView;
857
862- (BOOL)isParticipantsUnmuteSelfAllowed;
863
868- (BOOL)isMeetingChatLegalNoticeAvailable;
869
874- (NSString *)getChatLegalNoticesPrompt;
875
880- (NSString *)getChatLegalNoticesExplained;
881
886- (ZoomSDKError)enableFollowHostVideoOrder:(BOOL)enable;
887
893- (ZoomSDKError)setVideoOrder:(NSArray<NSNumber*>*)orderList;
894
899- (BOOL)isFollowHostVideoOrderOn;
900
905- (BOOL)isSupportFollowHostVideoOrder;
906
911- (NSArray<NSNumber*>*)getVideoOrderList;
912
920- (ZoomSDKError)lowerAllHands:(BOOL)forWebinarAttendees;
921
927- (BOOL)isChatMessageCanBeDeleted:(NSString*)msgID;
928
934- (ZoomSDKError)deleteChatMessage:(NSString*)msgID;
935
940- (NSArray<NSString*>*)getAllChatMessageID;
941
946-(ZoomSDKError)setParticipantsChatPriviledge:(ZoomSDKChatPriviledgeType)priviledge;
947
952-(ZoomSDKChatStatus *)getChatStatus;
953
958-(BOOL)isShareMeetingChatLegalNoticeAvailable;
959
964-(NSString*)getShareMeetingChatStartedLegalNoticeContent;
965
970-(NSString*)getShareMeetingChatStoppedLegalNoticeContent;
971
977-(ZoomSDKError)stopIncomingAudio:(BOOL)stop;
978
983-(BOOL)isIncomingAudioStopped;
984
990-(ZoomSDKError)stopIncomingVideo:(BOOL)stop;
991
996-(BOOL)isIncomingVideoStopped;
997
1003-(ZoomSDKError)showAvatar:(BOOL)show;
1004
1009-(BOOL)isShowAvatar;
1010
1016-(ZoomSDKError)allowParticipantsToStartVideo:(BOOL)bAllow;
1017
1022-(BOOL)isParticipantsStartVideoAllowed;
1023
1029-(ZoomSDKError)allowParticipantsToShareWhiteBoard:(BOOL)bAllow;
1030
1035-(BOOL)isParticipantsShareWhiteBoardAllowed;
1036@end
UserRole
Enumeration of user roles.
ZoomSDKAudioStatus
Enumeration of Audio status.
ZoomSDKChatMessageDeleteType
Enumerations of the chat message delete type.
ZoomSDKVideoStatus
ZoomSDKRecordingStatus
Enumeration of Recording status.
ZoomSDKSpotlightResult
ZoomSDKPinResult
JoinMeetingReqInfoType
Join meeting with required information.
MeetingUIType
Enumeration of video UI types in the meeting.
ZoomSDKAudioType
ScreenType
Enumeration of screen types for multi-sharing.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKChatMessageType
Enumerations of the type for chat message.
ZoomSDKVideoQuality
Enumeration of video quality.
ZoomSDKShareSettingType
Enumerations of sharing types.
ActionMeetingCmd
An enumeration of all the commands in the meeting.
Definition: ZoomSDKErrors.h:43
ZoomSDKChatPriviledgeType
Enumerations of the priviledge for attendee chat.
ZOOM SDK chat information.
ZoomSDKChatMessageType _chatMessageType
ZOOM SDK chat privilege info.
id< ZoomSDKMeetingActionControllerDelegate > _delegate
ZoomSDKError confirmSwitch()
Confirm to switch to single share from multi-share. All the shares are stopped.
ZoomSDKError cancelSwitch()
Cancel to switch to single share from multi-share. All the shares are remained.
ZOOM SDK normal meeting chat privilege info.
ZOOM SDK audio information.
ZOOM SDK user information.
ZOOM SDK webinar attendee chat privilege info.
ZOOM SDK Attendee's status in the webinar.
ZOOM SDK webinar panelist chat privilege info.