Meeting SDK for iOS 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 Communications on 8/7/14.
6// Copyright (c) Zoom Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <MobileRTC/MobileRTCConstants.h>
11#import <MobileRTC/MobileRTCMeetingDelegate.h>
12
17@interface MobileRTCMeetingStartParam : NSObject
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, copy, readwrite) NSString * customerKey;
38
42@property (nullable, nonatomic, copy, readwrite) NSString * vanityID;
43
47@property (nullable, nonatomic, copy, readwrite) NSString * meetingNumber;
48
52@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;
53
57@property(nullable, nonatomic, copy) NSString *inviteContactID;
58
62@property (nonatomic, assign, readwrite) BOOL isAudioRawDataStereo;
63
67@property (nonatomic, assign, readwrite) MobileRTCAudioRawdataSamplingRate audioRawSampleRate;
68
69@end
70
76@end
77
87@property (nonatomic, assign, readwrite) MobileRTCUserType userType;
88
92@property (nullable, nonatomic, copy, readwrite) NSString * userName;
93
98@property (nonnull, nonatomic, copy, readwrite) NSString * zak;
99
100@end
101
106@interface MobileRTCMeetingJoinParam : NSObject
110@property (nonatomic, assign, readwrite) BOOL noAudio;
111
115@property (nonatomic, assign, readwrite) BOOL noVideo;
116
121@property (nullable, nonatomic, copy, readwrite) NSString * customerKey;
125@property (nullable, nonatomic, copy, readwrite) NSString * vanityID;
129@property (nullable, nonatomic, copy, readwrite) NSString * meetingNumber;
133@property (nullable, nonatomic, copy, readwrite) NSString * userName;
137@property (nullable, nonatomic, copy, readwrite) NSString * password;
141@property (nullable, nonatomic, copy, readwrite) NSString * webinarToken;
142
146@property (nullable, nonatomic, copy, readwrite) NSString * zak;
147
151@property (nullable, nonatomic, copy, readwrite) NSString * onBehalfToken;
152
156@property(nullable, nonatomic, copy, readwrite) NSString *appPrivilegeToken;
157
161@property (nullable, nonatomic, copy, readwrite) NSString * join_token;
162
166@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;
167
171@property (nonatomic, assign, readwrite) BOOL isAudioRawDataStereo;
172
176@property (nonatomic, assign, readwrite) MobileRTCAudioRawdataSamplingRate audioRawSampleRate;
177
178
179@end
180
190@property (nullable, nonatomic, copy, readwrite) NSString * formattedHtmlContent;
191
195@property (nullable, nonatomic, copy, readwrite) NSString * accountOwnerUrl;
196
200@property (nullable, nonatomic, copy, readwrite) NSString * termsUrl;
201
205@property (nullable, nonatomic, copy, readwrite) NSString * privacyPolicyUrl;
206
207@end
208
213@interface MobileRTCMeetingParameter : NSObject
217@property (nonatomic, assign) MobileRTCMeetingType meetingType;
218
222@property (nonatomic, assign) BOOL isViewOnly;
223
227@property (nonatomic, assign) BOOL isAutoRecordingLocal;
228
232@property (nonatomic, assign) BOOL isAutoRecordingCloud;
233
237@property (nonatomic, assign) unsigned long long meetingNumber;
238
242@property (nonatomic, copy) NSString * _Nullable meetingTopic;
243
247@property (nonatomic, copy) NSString * _Nullable meetingHost;
248
249@end
250
251
256@interface MobileRTCInputUserInfoHandler : NSObject
257
261@property(nonatomic, copy, readonly) NSString * _Nullable defaultDisplayName;
262
266@property(nonatomic, assign, readonly) BOOL canModifyDefaultDisplayName;
267
273- (BOOL)isValidEmail:(NSString *_Nonnull)email;
274
281- (MobileRTCSDKError)inputUserInfo:(NSString *_Nonnull)name email:(NSString *_Nonnull)email;
282
286- (void)cancel;
287
288@end
289
290@protocol MobileRTCMeetingServiceDelegate;
296@interface MobileRTCMeetingService : NSObject
300@property (weak, nonatomic) id<MobileRTCMeetingServiceDelegate> _Nullable delegate;
301
305@property (weak, nonatomic) id<MobileRTCCustomizedUIMeetingDelegate> _Nullable customizedUImeetingDelegate;
306
314- (MobileRTCMeetError)startMeetingWithStartParam:(nonnull MobileRTCMeetingStartParam*)param;
315
322- (MobileRTCMeetError)joinMeetingWithJoinParam:(nonnull MobileRTCMeetingJoinParam*)param;
323
329- (MobileRTCMeetError)handZoomWebUrl:(nonnull NSString*)meetingUrl;
330
335- (MobileRTCMeetingState)getMeetingState;
336
341- (void)leaveMeetingWithCmd:(LeaveMeetingCmd)cmd;
342
348- (UIView * _Nullable)meetingView;
349
356- (BOOL)setCustomizedInvitationDomain:(NSString *_Nonnull)invitationDomain;
357
362- (BOOL)isSupportPSMode;
363
368- (BOOL)isPSModeStarted;
369
373- (NSUInteger)getPSUserID;
374
375@end
MobileRTCMeetError
Enumeration of errors to start/join meeting.
MobileRTCMeetingState
Enumeration of meeting status.
MobileRTCUserType
Enumerates the types of users.
MobileRTCSDKError
Enumeration of SDK error.
LeaveMeetingCmd
Enumeration of commands for leaving meeting.
MobileRTCMeetingType
Enumeration of meeting types.
MobileRTCAudioRawdataSamplingRate
Enumeration representing the sampling rate of acquired raw audio data.
Interface for handling user input when joining a meeting.
Provides settings for joining a meeting, such as start meeting with microphone or camera disabled.
Provides settings for meetings.
Manage sign interpretation status, interpreters, and available languages in a Zoom 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.
BOOL isAudioRawDataStereo
<Optional> Is audio raw data stereo? The default is mono.
BOOL isMyVoiceInMix
<Optional> Is my voice in the mixed audio raw data?
NSString * meetingNumber
Meeting number, in format like 123456789.
BOOL isAppShare
Start meeting with screen sharing immediately enabled.
NSString * inviteContactID
<Optional>Set the invitation ID for automatic meeting invitation.
NSString * vanityID
Special ID for the personal link name in organization URL, like "yourcompany" in yourcompany....
MobileRTCAudioRawdataSamplingRate audioRawSampleRate
<Optional> The sampling rate of the acquired raw audio data, The default is MobileRTCAudioRawdataSamp...