Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingService.h
Go to the documentation of this file.
1
7#import <Foundation/Foundation.h>
8#import <ZoomSDK/ZoomSDKErrors.h>
9#import <ZoomSDK/ZoomSDKH323Helper.h>
10#import <ZoomSDK/ZoomSDKPhoneHelper.h>
11#import <ZoomSDK/ZoomSDKWaitingRoomController.h>
12#import <ZoomSDK/ZoomSDKMeetingUIController.h>
13#import <ZoomSDK/ZoomSDKMeetingConfiguration.h>
14#import <ZoomSDK/ZoomSDKASController.h>
15#import <ZoomSDK/ZoomSDKMeetingActionController.h>
16#import <ZoomSDK/ZoomSDKLiveStreamHelper.h>
17#import <ZoomSDK/ZoomSDKVideoContainer.h>
18#import <ZoomSDK/ZoomSDKMeetingRecordController.h>
19#import <ZoomSDK/ZoomSDKWebinarController.h>
20#import <ZoomSDK/ZoomSDKCloseCaptionController.h>
21#import <ZoomSDK/ZoomSDKRealNameAuthenticationController.h>
22#import <ZoomSDK/ZoomSDKQAController.h>
23#import <ZoomSDK/ZoomSDKNewBreakoutRoomController.h>
24#import <ZoomSDK/ZoomSDKInterpretationController.h>
25#import <ZoomSDK/ZoomSDKReactionController.h>
26#import <ZoomSDK/ZoomSDKAppSignalController.h>
27#import <ZoomSDK/ZoomSDKRawArchivingController.h>
28#import <ZoomSDK/ZoomSDKSignInterpretationController.h>
29#import <ZoomSDK/ZoomSDKCustomImmersiveController.h>
30#import <ZoomSDK/ZoomSDKMeetingChatController.h>
31#import <ZoomSDK/ZoomSDKMeetingWhiteboardController.h>
32#import <ZoomSDK/ZoomSDKMeetingEncryptionController.h>
33#import <ZoomSDK/ZoomSDKPollingController.h>
34#import <ZoomSDK/ZoomSDKMeetingRemoteSupportController.h>
35#import <ZoomSDK/ZoomSDKMeetingAICompanionController.h>
36#import <ZoomSDK/ZoomSDKCameraControlHelper.h>
37#import <ZoomSDK/ZoomSDKMeetingIndicatorController.h>
38#import <ZoomSDK/ZoomSDKMeetingProductionStudioController.h>
39#import <ZoomSDK/ZoomSDKMeetingDocsController.h>
40
41NS_ASSUME_NONNULL_BEGIN
42
47@interface ZoomSDKMeetingParameter : NSObject
51@property (assign,nonatomic) MeetingType meetingType;
55@property (assign,nonatomic) BOOL isViewOnly;
59@property (assign,nonatomic) BOOL isAutoRecordingLocal;
63@property (assign,nonatomic) BOOL isAutoRecordingCloud;
67@property (assign,nonatomic) long long meetingNumber;
71@property (copy,nonatomic, nullable) NSString *meetingTopic;
75@property (copy,nonatomic, nullable) NSString *meetingHost;
76@end
77
78
83@interface ZoomSDKStartMeetingElements : NSObject
87@property(nonatomic, copy, nullable)NSString* vanityID;
91@property(nonatomic, assign)ZoomSDKUserType userType;
95@property(nonatomic, assign)long long meetingNumber;
99@property(nonatomic, assign)BOOL isDirectShare;
103@property(nonatomic, assign)CGDirectDisplayID displayID;
107@property(nonatomic, assign)BOOL isNoVideo;
111@property(nonatomic, assign)BOOL isNoAudio;
115@property(nonatomic, copy, nullable)NSString* customerKey;
119@property(nonatomic, assign)BOOL isMyVoiceInMix;
123@property(nonatomic, copy, nullable)NSString *inviteContactID;
127@property(nonatomic, assign)BOOL isAudioRawDataStereo;
131@property(nonatomic, assign)ZoomSDKAudioRawdataSamplingRate audioRawdataSamplingRate;
135@property (assign,nonatomic)ZoomSDKVideoRawdataColorspace videoRawdataColorspace;
136
137@end
138
139
148@property(nonatomic, copy, nullable)NSString* zak;
152@property(nonatomic, copy, nullable)NSString* displayName;
156@property(nonatomic, copy, nullable)NSString* vanityID;
160@property(nonatomic, assign)SDKUserType userType;
164@property(nonatomic, assign)long long meetingNumber;
168@property(nonatomic, assign)BOOL isDirectShare;
172@property(nonatomic, assign)CGDirectDisplayID displayID;
176@property(nonatomic, assign)BOOL isNoVideo;
180@property(nonatomic, assign)BOOL isNoAudio;
184@property(nonatomic, copy, nullable)NSString* customerKey;
188@property(nonatomic, assign)BOOL isMyVoiceInMix;
192@property(nonatomic, copy, nullable)NSString *inviteContactID;
196@property(nonatomic, assign)BOOL isAudioRawDataStereo;
200@property(nonatomic, assign)ZoomSDKAudioRawdataSamplingRate audioRawdataSamplingRate;
204@property (assign,nonatomic)ZoomSDKVideoRawdataColorspace videoRawdataColorspace;
205
206@end
207
212@interface ZoomSDKJoinMeetingElements : NSObject
216@property(nonatomic, copy, nullable)NSString* zak;
220@property(nonatomic, copy, nullable)NSString* webinarToken;
224@property(nonatomic, copy, nullable)NSString* displayName;
228@property(nonatomic, copy, nullable)NSString* vanityID;
232@property(nonatomic, assign)ZoomSDKUserType userType;
236@property(nonatomic, copy, nullable)NSString* customerKey;
240@property(nonatomic, assign)long long meetingNumber;
244@property(nonatomic, assign)BOOL isDirectShare;
248@property(nonatomic, assign)CGDirectDisplayID displayID;
252@property(nonatomic, assign)BOOL isNoVideo;
256@property(nonatomic, assign)BOOL isNoAudio;
260@property(nonatomic, copy, nullable)NSString *password;
264@property(nonatomic, copy, nullable)NSString *appPrivilegeToken;
268@property(nonatomic, copy, nullable)NSString *join_token;
272@property(nonatomic, assign)BOOL isMyVoiceInMix;
276@property(nonatomic, assign)BOOL isAudioRawDataStereo;
280@property(nonatomic, assign)ZoomSDKAudioRawdataSamplingRate audioRawdataSamplingRate;
284@property(nonatomic, copy, nullable)NSString* onBehalfToken;
288@property (assign,nonatomic)ZoomSDKVideoRawdataColorspace videoRawdataColorspace;
289
290@end
291
292
298
302@property(nonatomic, copy, readonly, nullable)NSString *defaultDisplayName;
303
307@property(nonatomic, assign, readonly)BOOL canModifyDefaultDisplayName;
308
315- (BOOL)isValidEmail:(NSString *)email;
316
323- (ZoomSDKError)inputUserInfo:(NSString *)name email:(NSString *)email;
324
328- (void)cancel;
329@end
330
339@property(nonatomic, copy, readonly, nullable)NSString* archiveConfirmContent;
340
346- (ZoomSDKError)joinWithArchive:(BOOL)startArchive;
347@end
348
353@interface ZoomSDKRecoverMeetingHandler : NSObject
357@property(nonatomic, copy, readonly, nullable)NSString* recoverMeetingContent;
358
364- (ZoomSDKError)recoverMeeting:(BOOL)toRecover;
365@end
366
367
372@protocol ZoomSDKMeetingServiceDelegate <NSObject>
373
374@optional
375
382- (void)onMeetingStatusChange:(ZoomSDKMeetingStatus)state meetingError:(ZoomSDKMeetingError)error EndReason:(EndMeetingReason)reason;
383
388- (void)onMeetingStatisticWarning:(StatisticWarningType)type;
389
395- (void)onFreeMeetingNeedToUpgrade:(FreeMeetingNeedUpgradeType)type giftUpgradeURL:(NSString*_Nullable)giftURL;
396
400- (void)onFreeMeetingUpgradeToGiftFreeTrialStart;
401
405- (void)onFreeMeetingUpgradeToGiftFreeTrialStop;
406
410- (void)onFreeMeetingUpgradedToProMeeting;
411
415- (void)onFreeMeetingRemainTimeStopCountDown;
416
421- (void)onFreeMeetingRemainTime:(unsigned int)seconds;
426- (void)onMeetingParameterNotification:(ZoomSDKMeetingParameter *_Nullable)meetingParameter;
427
432- (void)onJoinMeetingNeedUserInfo:(ZoomSDKMeetingInputUserInfoHandler *_Nullable)handler;
433
438- (void)onUserConfirmToStartArchive:(ZoomSDKMeetingArchiveConfirmHandler *_Nullable)handler;
439
445- (void)onEndOtherMeetingToJoinMeetingNotification:(ZoomSDKError (^)(void))actionEndOtherMeeting actionCancel:(void (^)(void))actionCancel;
446
452- (void)onMeetingFullToWatchLiveStream:(NSString*)liveStreamUrl;
453
458- (void)onUserConfirmRecoverMeeting:(ZoomSDKRecoverMeetingHandler * _Nullable)handler;
459@end
460
466@interface ZoomSDKMeetingService : NSObject
467{
468 id<ZoomSDKMeetingServiceDelegate> _delegate;
477 //customized UI
500}
504@property (assign, nonatomic, nullable) id<ZoomSDKMeetingServiceDelegate> delegate;
505
510- (ZoomSDKMeetingUIController*)getMeetingUIController;
511
516- (ZoomSDKMeetingConfiguration*)getMeetingConfiguration;
517
522- (ZoomSDKH323Helper*_Nullable)getH323Helper;
523
528- (ZoomSDKWaitingRoomController*)getWaitingRoomController;
529
534- (ZoomSDKASController*)getASController;
535
540- (ZoomSDKPhoneHelper*)getPhoneHelper;
541
546- (ZoomSDKMeetingActionController*)getMeetingActionController;
547
552- (ZoomSDKLiveStreamHelper*)getLiveStreamHelper;
553
558- (ZoomSDKVideoContainer*_Nullable)getVideoContainer;
559
564- (ZoomSDKMeetingRecordController*)getRecordController;
569- (ZoomSDKWebinarController*)getWebinarController;
570
575- (ZoomSDKCloseCaptionController*)getCloseCaptionController;
576
581- (ZoomSDKRealNameAuthenticationController *)getRealNameController;
582
587- (ZoomSDKQAController *)getQAController;
588
593- (ZoomSDKNewBreakoutRoomController *)getNewBreakoutRoomController;
594
599- (ZoomSDKInterpretationController*)getInterpretationController;
600
605- (ZoomSDKSignInterpretationController*)getSignInterpretationController;
610- (ZoomSDKReactionController*)getReactionController;
611
616- (ZoomSDKAppSignalController*_Nullable)getAppSignalController;
617
622- (ZoomSDKRawArchivingController*)getRawArchivingController;
623
624
629- (ZoomSDKCustomImmersiveController*_Nullable)getMeetingImmersiveController;
630
635- (ZoomSDKMeetingWhiteboardController*)getMeetingWhiteboardController;
640- (ZoomSDKMeetingChatController*)getMeetingChatController;
641
646- (ZoomSDKMeetingEncryptionController*)getInMeetingEncryptionController;
647
652- (ZoomSDKMeetingRemoteSupportController*)getMeetingRemoteSupportController;
653
658- (NSString*)getInMeetingDataCenterInfo;
659
664- (ZoomSDKPollingController*)getMeetingPollingController;
665
670- (ZoomSDKMeetingAICompanionController*)getInMeetingAICompanionController;
671
677- (ZoomSDKCameraControlHelper*_Nullable)getCameraControlHelper:(unsigned int)userId;
678
683- (ZoomSDKMeetingProductionStudioController*)getMeetingProductionStudioController;
684
689- (ZoomSDKError)revokeCameraControlPrivilege;
690
695- (ZoomSDKMeetingIndicatorController*_Nullable)getMeetingIndicatorController;
696
701- (ZoomSDKMeetingDocsController*_Nullable)getMeetingDocsController;
702
708- (ZoomSDKError)startMeeting:(ZoomSDKStartMeetingElements *)context;
715- (ZoomSDKError)startMeetingWithZAK:(ZoomSDKStartMeetingUseZakElements *)context;
722- (ZoomSDKError)joinMeeting:(ZoomSDKJoinMeetingElements *)context;
727- (void)leaveMeetingWithCmd:(LeaveMeetingCmd)cmd;
728
733- (ZoomSDKMeetingStatus)getMeetingStatus;
734
740- (NSString*_Nullable)getMeetingProperty:(MeetingPropertyCmd)command;
741
746- (int)getSupportedMeetingAudioType;
747
754- (ZoomSDKConnectionQuality)getConnectionQuality:(ConnectionComponent)component Sending:(BOOL)sending;
759- (MeetingType)getMeetingType;
760
766- (BOOL)isFailoverMeeting;
767
773- (ZoomSDKError)handleZoomWebUrlAction:(NSString*)urlAction;
774
780- (CGSize)getUserVideoSize:(unsigned int)userID;
781@end
782NS_ASSUME_NONNULL_END
783
784
785
786
StatisticWarningType
Enumeration of warning types.
MeetingPropertyCmd
Get default information of meeting.
SDKUserType
Enumeration of the types of users.
FreeMeetingNeedUpgradeType
Enumeration indicating reasons why a free meeting needs an upgrade.
MeetingType
Enumeration of meeting types.
ZoomSDKAudioRawdataSamplingRate
Enumeration representing the sampling rate of acquired raw audio data.
ConnectionComponent
Enumeration of component types.
ZoomSDKError
Enumeration of common errors of SDK.
LeaveMeetingCmd
Enumeration of commands for leaving meeting.
ZoomSDKUserType
Enumeration of user types.
ZoomSDKVideoRawdataColorspace
The colorspace of video rawdata.
ZoomSDKMeetingError
Enumeration of errors to start/join meeting.
EndMeetingReason
Enumeration of ending meeting errors.
ZoomSDKMeetingStatus
Enumeration of meeting status.
ZoomSDKConnectionQuality
Enumeration of connection quality.
The Zoom share controller responsible for managing screen sharing, annotation, and remote control fun...
A controller that manages the display of App Signal and AI Companion panels.
Provides APIs to control the remote camera, including pan, tilt, and zoom operations.
Controller interface to manage closed captions and live transcription in meetings.
Interface for controlling the meeting immersive view feature. For more information on this feature,...
Provides helper APIs for H.323 device management in Zoom meetings.
Interface for managing interpretation in a Zoom meeting.
Interface for managing standard and raw live streams in a meeting.
Interface for managing participant-related actions in a meeting, such as retrieving participant list,...
The interface for the user to confirm whether start archiving after joining the meeting.
Provide APIs to manage in-meeting chat messages and file transfers.
Meeting configuration class to control various meeting UI and behavior settings.
Zoom SDK meeting docs sharing controller.
Zoom SDK meeting encryption controller.
Controller that manages meeting indicator items and dispatches updates via delegate.
Interface for handling user input when joining a meeting.
Meeting parameter information.
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.
Provides control and status APIs for Zoom meeting production studio mode.
Controller to manage meeting recording features.
Zoom SDK meeting remote support controller.
It is an implementation for client to start/join a Meeting.
ZoomSDKMeetingConfiguration * _meetingConfiguration
ZoomSDKH323Helper * _h323Helper
ZoomSDKWebinarController * _webinarController
ZoomSDKRawArchivingController * _rawArchivingController
ZoomSDKCustomImmersiveController * _customImmersiveController
ZoomSDKReactionController * _reactionController
ZoomSDKMeetingWhiteboardController * _whiteboardController
ZoomSDKNewBreakoutRoomController * _newBOController
ZoomSDKAppSignalController * _appSignalController
id< ZoomSDKMeetingServiceDelegate > _delegate
ZoomSDKMeetingRemoteSupportController * _remoteSupportController
ZoomSDKPhoneHelper * _phoneHelper
ZoomSDKPollingController * _pollingController
ZoomSDKInterpretationController * _InterpretationController
ZoomSDKWaitingRoomController * _waitingRoomController
ZoomSDKVideoContainer * _videoContainer
ZoomSDKMeetingRecordController * _recordController
ZoomSDKMeetingProductionStudioController * _productionStudioController
ZoomSDKMeetingIndicatorController * _meetingIndicatorController
ZoomSDKMeetingDocsController * _meetingDocsController
ZoomSDKLiveStreamHelper * _liveStreamHelper
ZoomSDKMeetingChatController * _chatController
ZoomSDKCloseCaptionController * _closeCaptionController
ZoomSDKMeetingAICompanionController * _AICompanionController
ZoomSDKRealNameAuthenticationController * _realNameController
ZoomSDKMeetingUIController * _meetingUIController
ZoomSDKSignInterpretationController * _signInterpretationController
ZoomSDKMeetingEncryptionController * _encryptionController
ZoomSDKASController * _asController
ZoomSDKMeetingActionController * _actionController
ZoomSDKQAController * _QAController
Class to control and customize Zoom meeting UI components.
Controller to manage whiteboard functionality during Zoom meetings.
Controller class to manage breakout room features and permissions.
Provides APIs to manage Zoom phone call-in and call-out features.
Polling controller interface.
Provide interfaces to manage Q&A session in Zoom meeting.
Controller for managing raw archiving privilege in Zoom SDK.
Interface for managing emoji reactions and emoji feedback in Zoom SDK.
Controller to manage Zoom SDK Real Name Authentication.
The interface for host user to handle recover meeting or not when start a deleted or expired meeting.
Manage sign interpretation status, interpreters, and available languages in a Zoom meeting.
Meeting start options when using SDK credentials (no ZAK).
Meeting start options using ZAK (Zoom Access Key).
Container class to manage multiple video elements.
Interface for managing the waiting room during a meeting.
Controller for managing webinar-specific functions.