macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingService.h
Go to the documentation of this file.
1
2#import <Foundation/Foundation.h>
3#import "ZoomSDKErrors.h"
25
26
27@interface ZoomSDKSecuritySessionKey : NSObject
28{
30 NSData* _sessionKey;
31 NSData* _iv;
32}
33@property(nonatomic, assign) SecuritySessionComponet component;
34@property(nonatomic, retain) NSData* iv;
35@property(nonatomic, retain) NSData* sessionKey;
36
37@end
38
39@interface ZoomSDKMeetingParameter : NSObject
43@property (assign,nonatomic) MeetingType meetingType;
47@property (assign,nonatomic) BOOL isViewOnly;
51@property (assign,nonatomic) BOOL isAutoRecordingLocal;
55@property (assign,nonatomic) BOOL isAutoRecordingCloud;
59@property (assign,nonatomic) long long meetingNumber;
63@property (copy,nonatomic) NSString *meetingTopic;
67@property (copy,nonatomic) NSString *meetingHost;
68@end
69
70@interface ZoomSDKStartMeetingElements : NSObject
74@property(nonatomic, copy)NSString* vanityID;
78@property(nonatomic, assign)ZoomSDKUserType userType;
82@property(nonatomic, assign)long long meetingNumber;
86@property(nonatomic, assign)BOOL isDirectShare;
90@property(nonatomic, assign)CGDirectDisplayID displayID;
94@property(nonatomic, assign)BOOL isNoVideo;
98@property(nonatomic, assign)BOOL isNoAuido;
102@property(nonatomic, copy)NSString* customerKey;
103@end
104
109@property(nonatomic, copy)NSString* zak;
113@property(nonatomic, copy)NSString* displayName;
117@property(nonatomic, copy)NSString* vanityID;
121@property(nonatomic, assign)SDKUserType userType;
125@property(nonatomic, assign)long long meetingNumber;
129@property(nonatomic, assign)BOOL isDirectShare;
133@property(nonatomic, assign)CGDirectDisplayID displayID;
137@property(nonatomic, assign)BOOL isNoVideo;
141@property(nonatomic, assign)BOOL isNoAuido;
145@property(nonatomic, copy)NSString* customerKey;
146@end
147
148@interface ZoomSDKJoinMeetingElements : NSObject
152@property(nonatomic, copy)NSString* zak;
156@property(nonatomic, copy)NSString* webinarToken;
160@property(nonatomic, copy)NSString* displayName;
164@property(nonatomic, copy)NSString* vanityID;
168@property(nonatomic, assign)ZoomSDKUserType userType;
172@property(nonatomic, copy)NSString* customerKey;
176@property(nonatomic, assign)long long meetingNumber;
180@property(nonatomic, assign)BOOL isDirectShare;
184@property(nonatomic, assign)CGDirectDisplayID displayID;
188@property(nonatomic, assign)BOOL isNoVideo;
192@property(nonatomic, assign)BOOL isNoAuido;
196@property(nonatomic, copy)NSString *password;
200@property(nonatomic, copy)NSString *appPrivilegeToken;
204@property(nonatomic, copy)NSString *join_token;
205@end
206
207@protocol ZoomSDKMeetingServiceDelegate <NSObject>
208
209@optional
210
217- (void)onMeetingStatusChange:(ZoomSDKMeetingStatus)state meetingError:(ZoomSDKMeetingError)error EndReason:(EndMeetingReason)reason;
218
223- (void)onWaitMeetingSessionKey:(NSData*)key;
224
229- (void)onMeetingStatisticWarning:(StatisticWarningType)type;
230
236- (void)onFreeMeetingNeedToUpgrade:(FreeMeetingNeedUpgradeType)type giftUpgradeURL:(NSString*)giftURL;
237
241- (void)onFreeMeetingUpgradeToGiftFreeTrialStart;
242
246- (void)onFreeMeetingUpgradeToGiftFreeTrialStop;
247
251- (void)onFreeMeetingUpgradedToProMeeting;
252
256- (void)onFreeMeetingRemainTimeStopCountDown;
257
262- (void)onFreeMeetingRemainTime:(unsigned int)seconds;
267- (void)onMeetingParameterNotification:(ZoomSDKMeetingParameter *)meetingParameter;
268@end
269
274@interface ZoomSDKMeetingService : NSObject
275{
276 id<ZoomSDKMeetingServiceDelegate> _delegate;
285 //customized UI
299}
303@property (assign, nonatomic) id<ZoomSDKMeetingServiceDelegate> delegate;
304
309- (ZoomSDKMeetingUIController*)getMeetingUIController;
310
315- (ZoomSDKMeetingConfiguration*)getMeetingConfiguration;
316
321- (ZoomSDKH323Helper*)getH323Helper;
322
327- (ZoomSDKWaitingRoomController*)getWaitingRoomController;
328
333- (ZoomSDKASController*)getASController;
334
339- (ZoomSDKPhoneHelper*)getPhoneHelper;
340
345- (ZoomSDKMeetingActionController*)getMeetingActionController;
346
351- (ZoomSDKLiveStreamHelper*)getLiveStreamHelper;
352
357- (ZoomSDKVideoContainer*)getVideoContainer;
358
363- (ZoomSDKMeetingRecordController*)getRecordController;
368- (ZoomSDKWebinarController*)getWebinarController;
369
374- (ZoomSDKCloseCaptionController*)getCloseCaptionController;
375
380-(ZoomSDKRealNameAuthenticationController *)getRealNameController;
381
386-(ZoomSDKQAController *)getQAController;
387
392-(ZoomSDKNewBreakoutRoomController *)getNewBreakoutRoomController;
393
398-(ZoomSDKInterpretationController*)getInterpretationController;
399
404-(ZoomSDKSignInterpretationController*)getSignInterpretationController;
409-(ZoomSDKReactionController*)getReactionController;
410
415-(ZoomSDKAppSignalController*)getAppSignalController;
416
421-(ZoomSDKRawArchivingController*)getRawArchivingController;
422
423
428-(ZoomSDKCustomImmersiveController*)getMeetingImmersiveController;
429
435-(ZoomSDKError)startMeeting:(ZoomSDKStartMeetingElements *)context;
442-(ZoomSDKError)startMeetingWithZAK:(ZoomSDKStartMeetingUseZakElements *)context;
449-(ZoomSDKError)joinMeeting:(ZoomSDKJoinMeetingElements *)context;
454- (void)leaveMeetingWithCmd:(LeaveMeetingCmd)cmd;
455
460- (ZoomSDKMeetingStatus)getMeetingStatus;
461
467- (NSString*)getMeetingProperty:(MeetingPropertyCmd)command;
468
473- (int)getSupportedMeetingAudioType;
474
481- (ZoomSDKConnectionQuality)getConnectionQuality:(ConnectionComponent)component Sending:(BOOL)sending;
486- (MeetingType)getMeetingType;
487
493-(BOOL)isFailoverMeeting;
494
500- (ZoomSDKError)handleZoomWebUrlAction:(NSString*)urlAction;
501@end
502
503
504
505
506
StatisticWarningType
Enumeration of warning types.
MeetingPropertyCmd
Get default information of meeting.
Definition: ZoomSDKErrors.h:84
SDKUserType
Definition: ZoomSDKErrors.h:16
FreeMeetingNeedUpgradeType
MeetingType
Enumeration of meeting types.
ConnectionComponent
Enumeration of component types.
ZoomSDKError
Enumeration of common errors of SDK.
LeaveMeetingCmd
An enumeration of commands for leaving meeting.
Definition: ZoomSDKErrors.h:33
SecuritySessionComponet
Enumeration of security session types.
ZoomSDKUserType
An enumeration of user types.
Definition: ZoomSDKErrors.h:7
ZoomSDKMeetingError
Enumeration of errors to start/join meeting.
EndMeetingReason
Enumeration of ending meeting errors.
ZoomSDKMeetingStatus
Enumeration of meeting status.
ZoomSDKConnectionQuality
Enumeration of connection quality.
ZOOM share controller.
Meeting immersive controller interface. For more details on this feature, see https://support....
NSString * meetingTopic
meetingTopic topic of the meeting.
NSString * meetingHost
meetingHost host of the meeting.
long long meetingNumber
meetingNumber unique number of the meeting.
MeetingType meetingType
meetingType type of the meeting.
BOOL isAutoRecordingLocal
isAutoRecordingLocal Auto local recording or not. YES indicates to auto local recording.
BOOL isViewOnly
isViewOnly YES indicates to view only meeting,otherwise not.
BOOL isAutoRecordingCloud
isAutoRecordingCloud Auto cloud recording or not. YES indicates to auto cloud recording.
It is an implementation for client to start/join a Meeting.
ZoomSDKMeetingConfiguration * _meetingConfiguration
ZoomSDKH323Helper * _h323Helper
ZoomSDKWebinarController * _webinarController
ZoomSDKRawArchivingController * _rawArchivingController
ZoomSDKCustomImmersiveController * _customImmersiveController
ZoomSDKReactionController * _reactionController
ZoomSDKNewBreakoutRoomController * _newBOController
ZoomSDKAppSignalController * _appSignalController
id< ZoomSDKMeetingServiceDelegate > _delegate
ZoomSDKPhoneHelper * _phoneHelper
ZoomSDKInterpretationController * _InterpretationController
ZoomSDKWaitingRoomController * _waitingRoomController
ZoomSDKVideoContainer * _videoContainer
ZoomSDKMeetingRecordController * _recordController
ZoomSDKLiveStreamHelper * _liveStreamHelper
ZoomSDKCloseCaptionController * _closeCaptionController
ZoomSDKRealNameAuthenticationController * _realNameController
ZoomSDKMeetingUIController * _meetingUIController
ZoomSDKSignInterpretationController * _signInterpretationController
ZoomSDKASController * _asController
ZoomSDKMeetingActionController * _actionController
ZoomSDKQAController * _QAController
SecuritySessionComponet _component
Webinar controller interface.