iOS SDK 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 Video Communications on 8/7/14.
6// Copyright (c) 2019 Zoom Video Communications, Inc. All rights reserved.
7//
8#import <UIKit/UIKit.h>
9#import <Foundation/Foundation.h>
10#import <MobileRTC/MobileRTCConstants.h>
11#import <MobileRTC/MobileRTCAuthService.h>
12#import <MobileRTC/MobileRTCMeetingService.h>
13#import <MobileRTC/MobileRTCMeetingService+AppShare.h>
14#import <MobileRTC/MobileRTCMeetingService+InMeeting.h>
15#import <MobileRTC/MobileRTCMeetingService+Customize.h>
16#import <MobileRTC/MobileRTCMeetingService+Audio.h>
17#import <MobileRTC/MobileRTCMeetingService+Video.h>
18#import <MobileRTC/MobileRTCMeetingService+User.h>
19#import <MobileRTC/MobileRTCMeetingService+Chat.h>
20#import <MobileRTC/MobileRTCMeetingService+Avatar.h>
21#import <MobileRTC/MobileRTCMeetingService+Webinar.h>
22#import <MobileRTC/MobileRTCMeetingService+VirtualBackground.h>
23#import <MobileRTC/MobileRTCMeetingService+Interpretation.h>
24#import <MobileRTC/MobileRTCMeetingService+BO.h>
25#import <MobileRTC/MobileRTCMeetingService+Reaction.h>
26#import <MobileRTC/MobileRTCMeetingService+LiveTranscription.h>
27#import <MobileRTC/MobileRTCMeetingService+RawArchiving.h>
28#import <MobileRTC/MobileRTCMeetingSettings.h>
29#import <MobileRTC/MobileRTCInviteHelper.h>
30#import <MobileRTC/MobileRTCRoomDevice.h>
31#import <MobileRTC/MobileRTCMeetingUserInfo.h>
32#import <MobileRTC/MobileRTCMeetingChat.h>
33#import <MobileRTC/MobileRTCMeetingDelegate.h>
34#import <MobileRTC/MobileRTCVideoView.h>
35#import <MobileRTC/MobileRTCMeetingActionItem.h>
36#import <MobileRTC/MobileRTCAnnotationService.h>
37#import <MobileRTC/MobileRTCRemoteControlService.h>
38#import <MobileRTC/MobileRTCWaitingRoomService.h>
39#import <MobileRTC/MobileRTCRenderer.h>
40#import <MobileRTC/MobileRTCAudioRawDataHelper.h>
41#import <MobileRTC/MobileRTCVideoSourceHelper.h>
42#import <MobileRTC/MobileRTCShareSourceHelper.h>
43#import <MobileRTC/MobileRTCAudioSourceHelper.h>
44#import <MobileRTC/MobileRTCSMSService.h>
45#import <MobileRTC/MobileRTCDirectShareService.h>
46
50@interface MobileRTCSDKInitContext : NSObject
54@property (nonatomic, copy) NSString * _Nullable domain;
58@property (nonatomic, assign) BOOL enableLog;
62@property (nonatomic, copy) NSString * _Nullable bundleResPath;
66@property (nonatomic, assign) MobileRTC_ZoomLocale locale;
82@property (nonatomic, copy) NSString * _Nullable appGroupId;
86@property (nonatomic, copy) NSString * _Nullable replaykitBundleIdentifier;
87@end
88
95@interface MobileRTC : NSObject
99@property (retain, nonatomic, readonly) NSString * _Nullable mobileRTCDomain;
100
104@property (retain, nonatomic, readonly) NSString * _Nullable mobileRTCResPath;
105
109@property (retain, nonatomic, readonly) NSString * _Nullable mobileRTCCustomLocalizableName;
110
116+ (MobileRTC * _Nonnull)sharedRTC;
117
123- (BOOL)initialize:(MobileRTCSDKInitContext * _Nonnull)context;
124
131- (BOOL)switchDomain:(NSString * _Nonnull)newDomain force:(BOOL)force;
132
138- (void)setMobileRTCCustomLocalizableName:(NSString * _Nullable)localizableName;
139
144- (UINavigationController * _Nullable)mobileRTCRootController;
145
153- (void)setMobileRTCRootController:(UINavigationController * _Nullable)navController;
154
159- (NSString * _Nullable)mobileRTCVersion;
160
165- (BOOL)isRTCAuthorized;
166
171- (BOOL)isSupportedCustomizeMeetingUI;
172
178- (MobileRTCAuthService * _Nullable)getAuthService;
179
184- (MobileRTCMeetingService * _Nullable)getMeetingService;
185
190- (MobileRTCMeetingSettings * _Nullable)getMeetingSettings;
191
196- (MobileRTCAnnotationService * _Nullable)getAnnotationService;
197
202- (MobileRTCRemoteControlService * _Nullable)getRemoteControlService;
203
208- (MobileRTCWaitingRoomService * _Nullable)getWaitingRoomService;
209
214- (MobileRTCSMSService * _Nullable)getSMSService;
215
220- (MobileRTCDirectShareService * _Nullable)getDirectShareService;
221
226- (MobileRTCVideoSourceHelper * _Nullable)getVideoSourceHelper;
227
232- (MobileRTCShareSourceHelper * _Nullable)getShareSourceHelper;
233
239- (NSArray <NSString *> * _Nonnull)supportedLanguages;
240
246- (void)setLanguage:(NSString * _Nullable)lang;
247
252- (void)appWillResignActive;
253
258- (void)appDidBecomeActive;
259
264- (void)appDidEnterBackgroud;
265
270- (void)appWillTerminate;
271
279- (void)willTransitionToTraitCollection:(UITraitCollection *_Nullable)newCollection withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>_Nullable)coordinator;
280
288- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>_Nullable)coordinator;
289
294- (BOOL)hasRawDataLicense;
295
296@end
MobileRTCRawDataMemoryMode
Rawdata memory mode.
MobileRTC_ZoomLocale
Locale fo Customer.
The method provides support for authorizing MobileRTC.
Direct sharing helper Interface.
Initialize the class to acquire all the services.
Definition: MobileRTC.h:96
Enables the client to start or join a meeting.
Set to modify the configurations of the meeting.
It provides Remote Control Service.
MobileRTCSDKInitContext.
Definition: MobileRTC.h:51
BOOL enableLog
[Optional] enableLog Set MobileRTC log enable or not. The path of Log: Sandbox/AppData/tmp/
Definition: MobileRTC.h:58
NSString *_Nullable domain
[Required] domain The domain is used to start/join a ZOOM meeting.
Definition: MobileRTC.h:54
MobileRTCRawDataMemoryMode videoRawdataMemoryMode
[Optional] The video rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition: MobileRTC.h:70
NSString *_Nullable bundleResPath
[Optional] bundleResPath Set the path of MobileRTC resource bundle.
Definition: MobileRTC.h:62
MobileRTCRawDataMemoryMode audioRawdataMemoryMode
[Optional] The audio rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition: MobileRTC.h:78
NSString *_Nullable appGroupId
[Optional] If you use screen share, you need create group id in your apple developer account,...
Definition: MobileRTC.h:82
MobileRTCRawDataMemoryMode shareRawdataMemoryMode
[Optional] The share rawdata memory mode. Default is MobileRTCRawDataMemoryModeStack,...
Definition: MobileRTC.h:74
MobileRTC_ZoomLocale locale
[Optional] Locale fo Customer.
Definition: MobileRTC.h:66
NSString *_Nullable replaykitBundleIdentifier
[Optional] If you use direct screen share, you need create replaykit bundle identifier in your apple ...
Definition: MobileRTC.h:86
for SMS service usage like following flow.