iOS SDK API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService.h
Go to the documentation of this file.
1//
2// MobileRTCMeetingService.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
9#import <Foundation/Foundation.h>
12
16@interface MobileRTCMeetingStartParam : NSObject
17
21@property (nonatomic, assign, readwrite) BOOL isAppShare;
22
26@property (nonatomic, assign, readwrite) BOOL noAudio;
27
31@property (nonatomic, assign, readwrite) BOOL noVideo;
32
37@property (nullable, nonatomic, retain, readwrite) NSString * customerKey;
38
42@property (nullable, nonatomic, retain, readwrite) NSString * vanityID;
43
47@property (nullable, nonatomic, retain, readwrite) NSString * meetingNumber;
48
49@end
50
55
56@end
57
63
67@property (nonatomic, assign, readwrite) MobileRTCUserType userType;
68
72@property (nullable, nonatomic, retain, readwrite) NSString * userName;
73
78@property (nonnull, nonatomic, retain, readwrite) NSString * zak;
79
80@end
81
85@interface MobileRTCMeetingJoinParam : NSObject
86
90@property (nonatomic, assign, readwrite) BOOL noAudio;
91
95@property (nonatomic, assign, readwrite) BOOL noVideo;
96
101@property (nullable, nonatomic, retain, readwrite) NSString * customerKey;
105@property (nullable, nonatomic, retain, readwrite) NSString * vanityID;
109@property (nullable, nonatomic, retain, readwrite) NSString * meetingNumber;
113@property (nullable, nonatomic, retain, readwrite) NSString * userName;
117@property (nullable, nonatomic, retain, readwrite) NSString * password;
121@property (nullable, nonatomic, retain, readwrite) NSString * webinarToken;
122
126@property (nullable, nonatomic, retain, readwrite) NSString * zak;
127
131@property(nullable, nonatomic, retain, readwrite) NSString *appPrivilegeToken;
132
136@property (nullable, nonatomic, retain, readwrite) NSString * join_token;
137
138@end
139
144
149@property (nullable, nonatomic, retain, readwrite) NSString * formattedHtmlContent;
150
154@property (nullable, nonatomic, retain, readwrite) NSString * accountOwnerUrl;
155
159@property (nullable, nonatomic, retain, readwrite) NSString * termsUrl;
160
164@property (nullable, nonatomic, retain, readwrite) NSString * privacyPolicyUrl;
165
166@end
167
171@interface MobileRTCMeetingParameter : NSObject
172
176@property (nonatomic, assign) MobileRTCMeetingType meetingType;
177
181@property (nonatomic, assign) BOOL isViewOnly;
182
186@property (nonatomic, assign) BOOL isAutoRecordingLocal;
187
191@property (nonatomic, assign) BOOL isAutoRecordingCloud;
192
196@property (nonatomic, assign) unsigned long long meetingNumber;
197
201@property (nonatomic, retain) NSString * _Nullable meetingTopic;
202
206@property (nonatomic, retain) NSString * _Nullable meetingHost;
207
208@end
209
210@protocol MobileRTCMeetingServiceDelegate;
211
216@interface MobileRTCMeetingService : NSObject
217
221@property (nullable, assign, nonatomic) id<MobileRTCMeetingServiceDelegate> delegate;
222
226@property (nullable, assign, nonatomic) id<MobileRTCCustomizedUIMeetingDelegate> customizedUImeetingDelegate;
227
235- (MobileRTCMeetError)startMeetingWithStartParam:(nonnull MobileRTCMeetingStartParam*)param;
236
243- (MobileRTCMeetError)joinMeetingWithJoinParam:(nonnull MobileRTCMeetingJoinParam*)param;
244
250- (MobileRTCMeetError)handZoomWebUrl:(nonnull NSString*)meetingUrl;
251
256- (MobileRTCMeetingState)getMeetingState;
257
262- (void)leaveMeetingWithCmd:(LeaveMeetingCmd)cmd;
263
269- (UIView * _Nullable)meetingView;
270
277- (BOOL)setCustomizedInvitationDomain:(NSString *_Nonnull)invitationDomain;
278
283- (NSString *_Nullable)getWebinarRegistrationLegalNoticesPrompt;
284
289- (MobileRTCWebinarRegistLegalNoticeContent *_Nullable)getWebinarRegistrationLegalNoticesExplained;
290
291@end
MobileRTCMeetError
MobileRTCMeetError An enumeration of Meeting States.
MobileRTCMeetingState
MobileRTCMeetingState An enumeration of meeting states.
MobileRTCUserType
MobileRTCUserType An enumeration of user types.
LeaveMeetingCmd
LeaveMeetingCmd An enumeration of commands for leaving meeting.
MobileRTCMeetingType
Enumeration of meeting types.
Provides settings for joining a meeting, such as start meeting with microphone or camera disabled.
Provides settings for meetings.
Enables the client to start or join a meeting.
Provides settings for a logged-in user to start a meeting.
Provides parameters for a non-logged-in user (an anonymous user) to start a meeting.
Provides settings for starting a meeting, such as enabling screen sharing, microphone,...
BOOL noAudio
Start meeting with microphone disabled.
NSString * customerKey
Developer-specified string to track end user.
BOOL noVideo
Start meeting with camera disabled.
NSString * meetingNumber
Meeting number, in format like 123456789.
BOOL isAppShare
Start meeting with screen sharing immediately enabled.
NSString * vanityID
Special ID for the personal link name in organization URL, like "yourcompany" in yourcompany....