Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTC.h
Go to the documentation of this file.
1//
2// MobileRTC.h
3// MobileRTC
4//
5// Created by Zoom Communications on 8/7/14.
6// Copyright (c) Zoom Communications, Inc. All rights reserved.
7//
8#import <UIKit/UIKit.h>
9#import <Foundation/Foundation.h>
10#import <MobileRTC/MobileRTCConstants.h>
11#import <MobileRTC/MobileRTCMeetingUserInfo.h>
12#import <MobileRTC/MobileRTCRoomDevice.h>
13#import <MobileRTC/MobileRTCAuthService.h>
14#import <MobileRTC/MobileRTCMeetingService.h>
15#import <MobileRTC/MobileRTCAutoFramingParameter.h>
16#import <MobileRTC/MobileRTCMeetingService+AppShare.h>
17#import <MobileRTC/MobileRTCMeetingService+InMeeting.h>
18#import <MobileRTC/MobileRTCMeetingService+Customize.h>
19#import <MobileRTC/MobileRTCMeetingService+Audio.h>
20#import <MobileRTC/MobileRTCMeetingService+Video.h>
21#import <MobileRTC/MobileRTCMeetingService+User.h>
22#import <MobileRTC/MobileRTCMeetingService+Chat.h>
23#import <MobileRTC/MobileRTCMeetingService+Avatar.h>
24#import <MobileRTC/MobileRTCMeetingService+Webinar.h>
25#import <MobileRTC/MobileRTCMeetingService+QA.h>
26#import <MobileRTC/MobileRTCMeetingService+VirtualBackground.h>
27#import <MobileRTC/MobileRTCMeetingService+Interpretation.h>
28#import <MobileRTC/MobileRTCMeetingService+BO.h>
29#import <MobileRTC/MobileRTCMeetingService+Reaction.h>
30#import <MobileRTC/MobileRTCMeetingService+LiveTranscription.h>
31#import <MobileRTC/MobileRTCMeetingService+Docs.h>
32#import <MobileRTC/MobileRTCMeetingService+RawArchiving.h>
33#import <MobileRTC/MobileRTCMeetingService+Phone.h>
34#import <MobileRTC/MobileRTCMeetingService+SmartSummary.h>
35#import <MobileRTC/MobileRTCMeetingService+AICompanion.h>
36#import <MobileRTC/MobileRTCMeetingService+Whiteboard.h>
37#import <MobileRTC/MobileRTCMeetingService+Polling.h>
38#import <MobileRTC/MobileRTCMeetingService+Encryption.h>
39#import <MobileRTC/MobileRTCMeetingSettings.h>
40#import <MobileRTC/MobileRTCInviteHelper.h>
41#import <MobileRTC/MobileRTCMeetingChat.h>
42#import <MobileRTC/MobileRTCMeetingDelegate.h>
43#import <MobileRTC/MobileRTCVideoView.h>
44#import <MobileRTC/MobileRTCMeetingActionItem.h>
45#import <MobileRTC/MobileRTCAnnotationService.h>
46#import <MobileRTC/MobileRTCRemoteControlService.h>
47#import <MobileRTC/MobileRTCCameraControlService.h>
48#import <MobileRTC/MobileRTCWaitingRoomService.h>
49#import <MobileRTC/MobileRTCRenderer.h>
50#import <MobileRTC/MobileRTCAudioRawDataHelper.h>
51#import <MobileRTC/MobileRTCVideoSourceHelper.h>
52#import <MobileRTC/MobileRTCShareSourceHelper.h>
53#import <MobileRTC/MobileRTCAudioSourceHelper.h>
54#import <MobileRTC/MobileRTCSMSService.h>
55#import <MobileRTC/MobileRTCDirectShareService.h>
56#import <MobileRTC/MobileRTCReminderHelper.h>
57
62@interface MobileRTCSDKInitContext : NSObject
66@property (nonatomic, copy) NSString * _Nullable domain;
70@property (nonatomic, assign) BOOL enableLog;
74@property (nonatomic, copy) NSString * _Nullable bundleResPath;
78@property (nonatomic, assign) MobileRTC_ZoomLocale locale;
94@property (nonatomic, copy) NSString * _Nullable appGroupId;
98@property (nonatomic, copy) NSString * _Nullable replaykitBundleIdentifier;
99
100@property (nonatomic, assign) NSInteger wrapperType;
101
105@property (assign, nonatomic) BOOL enableCustomizeMeetingUI;
106
107@end
108
115@interface MobileRTC : NSObject
119@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCDomain;
120
124@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCResPath;
125
129@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCCustomLocalizableName;
130
136+ (MobileRTC * _Nonnull)sharedRTC;
137
143- (BOOL)initialize:(MobileRTCSDKInitContext * _Nonnull)context;
144
151- (BOOL)switchDomain:(NSString * _Nonnull)newDomain force:(BOOL)force;
152
158- (void)setMobileRTCCustomLocalizableName:(NSString * _Nullable)localizableName;
159
164- (UINavigationController * _Nullable)mobileRTCRootController;
165
173- (void)setMobileRTCRootController:(UINavigationController * _Nullable)navController;
174
179- (NSString * _Nullable)mobileRTCVersion;
180
185- (BOOL)isRTCAuthorized;
186
191- (BOOL)isSupportedCustomizeMeetingUI;
192
197- (BOOL)isEnabledCustomizeMeetingUI;
198
204- (MobileRTCAuthService * _Nullable)getAuthService;
205
210- (MobileRTCMeetingService * _Nullable)getMeetingService;
211
216- (MobileRTCMeetingSettings * _Nullable)getMeetingSettings;
217
222- (MobileRTCAnnotationService * _Nullable)getAnnotationService;
223
228- (MobileRTCRemoteControlService * _Nullable)getRemoteControlService;
229
234- (MobileRTCCameraControlService * _Nullable)getCameraControlService:(NSInteger)userId;
235
240- (MobileRTCSDKError)revokeCameraControlPrivilege;
241
246- (MobileRTCWaitingRoomService * _Nullable)getWaitingRoomService;
247
252- (MobileRTCSMSService * _Nullable)getSMSService;
253
258- (MobileRTCDirectShareService * _Nullable)getDirectShareService;
259
264- (MobileRTCReminderHelper * _Nullable)getReminderHelper;
265
270- (MobileRTCVideoSourceHelper * _Nullable)getVideoSourceHelper;
271
276- (MobileRTCShareSourceHelper * _Nullable)getShareSourceHelper;
277
283- (NSArray <NSString *> * _Nonnull)supportedLanguages;
284
290- (void)setLanguage:(NSString * _Nullable)lang;
291
296- (void)appWillResignActive;
297
302- (void)appDidBecomeActive;
303
308- (void)appDidEnterBackground;
309
314- (void)appWillTerminate;
315
320- (void)cleanup;
321
329- (void)willTransitionToTraitCollection:(UITraitCollection *_Nullable)newCollection withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>_Nullable)coordinator;
330
338- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>_Nullable)coordinator;
339
344- (BOOL)hasRawDataLicense;
345
346@end
MobileRTCSDKError
Enumeration of SDK error.
MobileRTCRawDataMemoryMode
Enumeration of memory modes for raw data handling.
MobileRTC_ZoomLocale
Locale fo 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:116
Manage sign interpretation status, interpreters, and available languages in a Zoom meeting.
Set to modify the configurations of the meeting.
It provides Remote Control Service.
The configuration object used to initialize the Zoom SDK.
Definition MobileRTC.h:63
BOOL enableLog
[Optional] enableLog Set MobileRTC log enable or not. The path of Log: Sandbox/AppData/tmp/.
Definition MobileRTC.h:70
NSString *_Nullable domain
[Required] domain The domain is used to start/join a ZOOM meeting.
Definition MobileRTC.h:66
MobileRTCRawDataMemoryMode videoRawdataMemoryMode
[Optional] The video rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:82
NSString *_Nullable bundleResPath
[Optional] bundleResPath Set the path of MobileRTC resource bundle.
Definition MobileRTC.h:74
BOOL enableCustomizeMeetingUI
Enable Custom In-Meeting UI in meeting.
Definition MobileRTC.h:105
MobileRTCRawDataMemoryMode audioRawdataMemoryMode
[Optional] The audio rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:90
NSString *_Nullable appGroupId
[Optional] If you use screen share, you need create group id in your apple developer account,...
Definition MobileRTC.h:94
MobileRTCRawDataMemoryMode shareRawdataMemoryMode
[Optional] The share rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:86
MobileRTC_ZoomLocale locale
[Optional] Locale fo Customer.
Definition MobileRTC.h:78
NSString *_Nullable replaykitBundleIdentifier
[Optional] If you use direct screen share, you need create replaykit bundle identifier in your apple ...
Definition MobileRTC.h:98
For SMS service usage like following flow.
Manage external source for share video and share audio in meeting.
Interface for managing the waiting room during a meeting.