Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTC.h
Go to the documentation of this file.
1
5
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/MobileRTCMeetingSettings+Custom3DAvatar.h>
39#import <MobileRTC/MobileRTCCustom3DAvatarElementSettingContext.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#import <MobileRTC/MobileRTCJoinMeetingInfoHandler.h>
58
63@interface MobileRTCSDKInitContext : NSObject
67@property (nonatomic, copy) NSString * _Nullable domain;
71@property (nonatomic, assign) BOOL enableLog;
75@property (nonatomic, copy) NSString * _Nullable bundleResPath;
79@property (nonatomic, assign) MobileRTC_ZoomLocale locale;
95@property (nonatomic, copy) NSString * _Nullable appGroupId;
99@property (nonatomic, copy) NSString * _Nullable replaykitBundleIdentifier;
100
104@property (nonatomic, assign) NSInteger wrapperType;
105
109@property (assign, nonatomic) BOOL enableCustomizeMeetingUI;
110
111@end
112
119@interface MobileRTC : NSObject
123@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCDomain;
124
128@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCResPath;
129
133@property (copy, nonatomic, readonly) NSString * _Nullable mobileRTCCustomLocalizableName;
134
140+ (MobileRTC * _Nonnull)sharedRTC;
141
147- (BOOL)initialize:(MobileRTCSDKInitContext * _Nonnull)context;
148
155- (BOOL)switchDomain:(NSString * _Nonnull)newDomain force:(BOOL)force;
156
162- (void)setMobileRTCCustomLocalizableName:(NSString * _Nullable)localizableName;
163
169- (UINavigationController * _Nullable)mobileRTCRootController DEPRECATED_MSG_ATTRIBUTE("This method is deprecated. Use mobileRTCPresentationScene instead.");
170
176- (void)setMobileRTCRootController:(UINavigationController * _Nullable)navController DEPRECATED_MSG_ATTRIBUTE("This method is deprecated. Use setMobileRTCPresentationScene instead.");
177
182- (UIScene *_Nullable)mobileRTCPresentationScene;
183
190- (void)setMobileRTCPresentationScene:(UIScene * _Nonnull)scene;
191
196- (NSString * _Nullable)mobileRTCVersion;
197
203
209
215
222
228
234
240
246
251- (MobileRTCCameraControlService * _Nullable)getCameraControlService:(NSInteger)userId;
252
258
264
270
276
282
288
294
300- (NSArray <NSString *> * _Nonnull)supportedLanguages;
301
307- (void)setLanguage:(NSString * _Nullable)lang;
308
314
320
326
332
337- (void)cleanup;
338
346- (void)willTransitionToTraitCollection:(UITraitCollection *_Nullable)newCollection withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>_Nullable)coordinator;
347
355- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>_Nullable)coordinator;
356
363
364@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:120
void appWillTerminate()
Notifies common layer that application will terminate. Call the appWillTerminate via applicationWillT...
BOOL hasRawDataLicense()
Gets whether you have permission to use raw data.
MobileRTCSDKError revokeCameraControlPrivilege()
Revoke camera control privilege.
BOOL isSupportedCustomizeMeetingUI()
Queries if custom meeting UI is supported by MobileRTC.
NSString *_Nullable mobileRTCCustomLocalizableName
The name of APP Localizable file for MobileRTC, read-only.
Definition MobileRTC.h:133
MobileRTCDirectShareService *_Nullable getDirectShareService()
Gets the default MobileRTC direct share service.
MobileRTCVideoSourceHelper *_Nullable getVideoSourceHelper()
Gets the video source helper.
void appWillResignActive()
Notifies common layer that application will resign active. Call the systematical method and then call...
void appDidEnterBackground()
Notifies common layer that application did enter background. Call the appDidEnterBackground via appli...
MobileRTCShareSourceHelper *_Nullable getShareSourceHelper()
Gets the share source helper.
NSString *_Nullable mobileRTCDomain
MobileRTC domain, read-only.
Definition MobileRTC.h:123
MobileRTCSMSService *_Nullable getSMSService()
Gets the default MobileRTC sms service.
MobileRTCMeetingService *_Nullable getMeetingService()
Gets the default meeting service.
MobileRTC *_Nonnull sharedRTC()
Gets the MobileRTC client.
void appDidBecomeActive()
Notifies common layer that application did become active. Call the appDidBecomeActive via application...
MobileRTCAnnotationService *_Nullable getAnnotationService()
Gets the MobileRTC default annotation service.
MobileRTCMeetingSettings *_Nullable getMeetingSettings()
Gets the MobileRTC default meeting settings.
MobileRTCWaitingRoomService *_Nullable getWaitingRoomService()
Gets the default MobileRTC waiting room service.
MobileRTCRemoteControlService *_Nullable getRemoteControlService()
Gets the default MobileRTC remote control service.
NSArray< NSString * > *_Nonnull supportedLanguages()
Gets the languages supported by MobileRTC.
BOOL isEnabledCustomizeMeetingUI()
Queries if custom meeting UI is enabled by MobileRTC.
UIScene *_Nullable mobileRTCPresentationScene()
Get the presentation scene of MobileRTC client.
MobileRTCReminderHelper *_Nullable getReminderHelper()
Gets the default MobileRTC reminder helper.
BOOL isRTCAuthorized()
Queries if the MobileRTC is authorized successfully or not.
void cleanup()
Cleanup the SDK.
NSString *_Nullable mobileRTCResPath
The path of MobileRTC Resources Bundle, read-only.
Definition MobileRTC.h:128
UINavigationController *_Nullable mobileRTCRootController()
Gets the root navigation controller of MobileRTC client.
MobileRTCAuthService *_Nullable getAuthService()
Gets the default authentication service.
NSString *_Nullable mobileRTCVersion()
Gets the MobileRTC version.
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:64
BOOL enableLog
[Optional] enableLog Set MobileRTC log enable or not. The path of Log: Sandbox/AppData/tmp/.
Definition MobileRTC.h:71
NSInteger wrapperType
SDK wrapper type (reserved for internal use).
Definition MobileRTC.h:104
NSString *_Nullable domain
[Required] domain The domain is used to start/join a ZOOM meeting.
Definition MobileRTC.h:67
MobileRTCRawDataMemoryMode videoRawdataMemoryMode
[Optional] The video rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:83
NSString *_Nullable bundleResPath
[Optional] bundleResPath Set the path of MobileRTC resource bundle.
Definition MobileRTC.h:75
BOOL enableCustomizeMeetingUI
Enable Custom In-Meeting UI in meeting.
Definition MobileRTC.h:109
MobileRTCRawDataMemoryMode audioRawdataMemoryMode
[Optional] The audio rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:91
NSString *_Nullable appGroupId
[Optional] If you use screen share, you need create group id in your apple developer account,...
Definition MobileRTC.h:95
MobileRTCRawDataMemoryMode shareRawdataMemoryMode
[Optional] The share rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition MobileRTC.h:87
MobileRTC_ZoomLocale locale
[Optional] Locale fo Customer.
Definition MobileRTC.h:79
NSString *_Nullable replaykitBundleIdentifier
[Optional] If you use direct screen share, you need create replaykit bundle identifier in your apple ...
Definition MobileRTC.h:99
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.