Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTC.h
Go to the documentation of this file.
1
6#import <UIKit/UIKit.h>
7#import <Foundation/Foundation.h>
8#import <MobileRTC/MobileRTCConstants.h>
9#import <MobileRTC/MobileRTCMeetingUserInfo.h>
10#import <MobileRTC/MobileRTCRoomDevice.h>
11#import <MobileRTC/MobileRTCAuthService.h>
12#import <MobileRTC/MobileRTCMeetingService.h>
13#import <MobileRTC/MobileRTCAutoFramingParameter.h>
14#import <MobileRTC/MobileRTCMeetingService+AppShare.h>
15#import <MobileRTC/MobileRTCMeetingService+InMeeting.h>
16#import <MobileRTC/MobileRTCMeetingService+Customize.h>
17#import <MobileRTC/MobileRTCMeetingService+Audio.h>
18#import <MobileRTC/MobileRTCMeetingService+Video.h>
19#import <MobileRTC/MobileRTCMeetingService+User.h>
20#import <MobileRTC/MobileRTCMeetingService+Chat.h>
21#import <MobileRTC/MobileRTCMeetingService+Avatar.h>
22#import <MobileRTC/MobileRTCMeetingService+Webinar.h>
23#import <MobileRTC/MobileRTCMeetingService+QA.h>
24#import <MobileRTC/MobileRTCMeetingService+VirtualBackground.h>
25#import <MobileRTC/MobileRTCMeetingService+Interpretation.h>
26#import <MobileRTC/MobileRTCMeetingService+BO.h>
27#import <MobileRTC/MobileRTCMeetingService+Reaction.h>
28#import <MobileRTC/MobileRTCMeetingService+LiveTranscription.h>
29#import <MobileRTC/MobileRTCMeetingService+Docs.h>
30#import <MobileRTC/MobileRTCMeetingService+RawArchiving.h>
31#import <MobileRTC/MobileRTCMeetingService+Phone.h>
32#import <MobileRTC/MobileRTCMeetingService+SmartSummary.h>
33#import <MobileRTC/MobileRTCMeetingService+AICompanion.h>
34#import <MobileRTC/MobileRTCMeetingService+Whiteboard.h>
35#import <MobileRTC/MobileRTCMeetingService+Polling.h>
36#import <MobileRTC/MobileRTCMeetingService+Encryption.h>
37#import <MobileRTC/MobileRTCMeetingSettings.h>
38#import <MobileRTC/MobileRTCInviteHelper.h>
39#import <MobileRTC/MobileRTCMeetingChat.h>
40#import <MobileRTC/MobileRTCMeetingDelegate.h>
41#import <MobileRTC/MobileRTCVideoView.h>
42#import <MobileRTC/MobileRTCMeetingActionItem.h>
43#import <MobileRTC/MobileRTCAnnotationService.h>
44#import <MobileRTC/MobileRTCRemoteControlService.h>
45#import <MobileRTC/MobileRTCCameraControlService.h>
46#import <MobileRTC/MobileRTCWaitingRoomService.h>
47#import <MobileRTC/MobileRTCRenderer.h>
48#import <MobileRTC/MobileRTCAudioRawDataHelper.h>
49#import <MobileRTC/MobileRTCVideoSourceHelper.h>
50#import <MobileRTC/MobileRTCShareSourceHelper.h>
51#import <MobileRTC/MobileRTCAudioSourceHelper.h>
52#import <MobileRTC/MobileRTCSMSService.h>
53#import <MobileRTC/MobileRTCDirectShareService.h>
54#import <MobileRTC/MobileRTCReminderHelper.h>
55
60@interface MobileRTCSDKInitContext : NSObject
64@property (nonatomic, copy) NSString * _Nullable domain;
68@property (nonatomic, assign) BOOL enableLog;
72@property (nonatomic, copy) NSString * _Nullable bundleResPath;
76@property (nonatomic, assign) MobileRTC_ZoomLocale locale;
92@property (nonatomic, copy) NSString * _Nullable appGroupId;
96@property (nonatomic, copy) NSString * _Nullable replaykitBundleIdentifier;
97
101@property (nonatomic, assign) NSInteger wrapperType;
102
106@property (assign, nonatomic) BOOL enableCustomizeMeetingUI;
107
108@end
109
116@interface MobileRTC : NSObject
120@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCDomain;
121
125@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCResPath;
126
130@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCCustomLocalizableName;
131
137+ (MobileRTC * _Nonnull)sharedRTC;
138
144- (BOOL)initialize:(MobileRTCSDKInitContext * _Nonnull)context;
145
152- (BOOL)switchDomain:(NSString * _Nonnull)newDomain force:(BOOL)force;
153
159- (void)setMobileRTCCustomLocalizableName:(NSString * _Nullable)localizableName;
160
166- (UINavigationController * _Nullable)mobileRTCRootController DEPRECATED_MSG_ATTRIBUTE("This method is deprecated. Use mobileRTCPresentationScene instead.");
167
173- (void)setMobileRTCRootController:(UINavigationController * _Nullable)navController DEPRECATED_MSG_ATTRIBUTE("This method is deprecated. Use setMobileRTCPresentationScene instead.");
174
179- (UIScene *_Nullable)mobileRTCPresentationScene;
180
187- (void)setMobileRTCPresentationScene:(UIScene * _Nonnull)scene;
188
193- (NSString * _Nullable)mobileRTCVersion;
194
199- (BOOL)isRTCAuthorized;
200
205- (BOOL)isSupportedCustomizeMeetingUI;
206
211- (BOOL)isEnabledCustomizeMeetingUI;
212
218- (MobileRTCAuthService * _Nullable)getAuthService;
219
224- (MobileRTCMeetingService * _Nullable)getMeetingService;
225
230- (MobileRTCMeetingSettings * _Nullable)getMeetingSettings;
231
236- (MobileRTCAnnotationService * _Nullable)getAnnotationService;
237
242- (MobileRTCRemoteControlService * _Nullable)getRemoteControlService;
243
248- (MobileRTCCameraControlService * _Nullable)getCameraControlService:(NSInteger)userId;
249
254- (MobileRTCSDKError)revokeCameraControlPrivilege;
255
260- (MobileRTCWaitingRoomService * _Nullable)getWaitingRoomService;
261
266- (MobileRTCSMSService * _Nullable)getSMSService;
267
272- (MobileRTCDirectShareService * _Nullable)getDirectShareService;
273
278- (MobileRTCReminderHelper * _Nullable)getReminderHelper;
279
284- (MobileRTCVideoSourceHelper * _Nullable)getVideoSourceHelper;
285
290- (MobileRTCShareSourceHelper * _Nullable)getShareSourceHelper;
291
297- (NSArray <NSString *> * _Nonnull)supportedLanguages;
298
304- (void)setLanguage:(NSString * _Nullable)lang;
305
310- (void)appWillResignActive;
311
316- (void)appDidBecomeActive;
317
322- (void)appDidEnterBackground;
323
328- (void)appWillTerminate;
329
334- (void)cleanup;
335
343- (void)willTransitionToTraitCollection:(UITraitCollection *_Nullable)newCollection withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>_Nullable)coordinator;
344
352- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>_Nullable)coordinator;
353
359- (BOOL)hasRawDataLicense;
360
361@end
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCRawDataMemoryMode
Enumeration of memory modes for raw data handling.
MobileRTC_ZoomLocale
Enumeration of locale for customer.
The Zoom annotation service for managing annotation.
The method provides support for authorizing MobileRTC.
Provides APIs to control the remote camera, including pan, tilt, and zoom operations.
Direct sharing helper Interface.
Initialize the class to acquire all the services.
Definition MobileRTC.h:117
Enables the client to start or join a meeting.
A class to modify the configurations of the meeting.
A helper for managing meeting reminders and notifications.
It provides Remote Control Service.
The configuration object used to initialize the Zoom SDK.
Definition MobileRTC.h:61
BOOL enableLog
[Optional] enableLog Set MobileRTC log enable or not. The path of Log: Sandbox/AppData/tmp/.
Definition MobileRTC.h:68
NSInteger wrapperType
SDK wrapper type (reserved for internal use).
Definition MobileRTC.h:101
NSString *_Nullable domain
[Required] domain The domain is used to start/join a ZOOM meeting.
Definition MobileRTC.h:64
MobileRTCRawDataMemoryMode videoRawdataMemoryMode
[Optional] The video rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:80
NSString *_Nullable bundleResPath
[Optional] bundleResPath Set the path of MobileRTC resource bundle.
Definition MobileRTC.h:72
BOOL enableCustomizeMeetingUI
Enable Custom In-Meeting UI in meeting.
Definition MobileRTC.h:106
MobileRTCRawDataMemoryMode audioRawdataMemoryMode
[Optional] The audio rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:88
NSString *_Nullable appGroupId
[Optional] If you use screen share, you need create group id in your apple developer account,...
Definition MobileRTC.h:92
MobileRTCRawDataMemoryMode shareRawdataMemoryMode
[Optional] The share rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:84
MobileRTC_ZoomLocale locale
[Optional] Locale fo Customer.
Definition MobileRTC.h:76
NSString *_Nullable replaykitBundleIdentifier
[Optional] If you use direct screen share, you need create replaykit bundle identifier in your apple ...
Definition MobileRTC.h:96
For SMS service usage like following flow.
A helper that manages external source for share video and share audio in a meeting.
A helper for managing video sources and capture.
Interface for managing the waiting room during a meeting.