Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <MobileRTC/MobileRTCConstants.h>
8#import <MobileRTC/MobileRTCMeetingDelegate.h>
9
14@interface MobileRTCMeetingStartParam : NSObject
18@property (nonatomic, assign, readwrite) BOOL isAppShare;
19
23@property (nonatomic, assign, readwrite) BOOL noAudio;
24
28@property (nonatomic, assign, readwrite) BOOL noVideo;
29
34@property (nullable, nonatomic, copy, readwrite) NSString * customerKey;
35
39@property (nullable, nonatomic, copy, readwrite) NSString * vanityID;
40
44@property (nullable, nonatomic, copy, readwrite) NSString * meetingNumber;
45
49@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;
50
54@property(nullable, nonatomic, copy) NSString *inviteContactID;
55
59@property (nonatomic, assign, readwrite) BOOL isAudioRawDataStereo;
60
64@property (nonatomic, assign, readwrite) MobileRTCAudioRawdataSamplingRate audioRawSampleRate;
65
69@property (nonatomic, assign, readwrite) MobileRTCVideoRawdataColorspace videoRawdataColorspace;
70
71@end
72
78@end
79
89@property (nonatomic, assign, readwrite) MobileRTCUserType userType;
90
94@property (nullable, nonatomic, copy, readwrite) NSString * userName;
95
100@property (nonnull, nonatomic, copy, readwrite) NSString * zak;
101
102@end
103
108@interface MobileRTCMeetingJoinParam : NSObject
112@property (nonatomic, assign, readwrite) BOOL noAudio;
113
117@property (nonatomic, assign, readwrite) BOOL noVideo;
118
123@property (nullable, nonatomic, copy, readwrite) NSString * customerKey;
127@property (nullable, nonatomic, copy, readwrite) NSString * vanityID;
131@property (nullable, nonatomic, copy, readwrite) NSString * meetingNumber;
135@property (nullable, nonatomic, copy, readwrite) NSString * userName;
139@property (nullable, nonatomic, copy, readwrite) NSString * password;
143@property (nullable, nonatomic, copy, readwrite) NSString * webinarToken;
144
148@property (nullable, nonatomic, copy, readwrite) NSString * zak;
149
153@property (nullable, nonatomic, copy, readwrite) NSString * onBehalfToken;
154
158@property(nullable, nonatomic, copy, readwrite) NSString *appPrivilegeToken;
159
163@property (nullable, nonatomic, copy, readwrite) NSString * join_token;
164
168@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;
169
173@property (nonatomic, assign, readwrite) BOOL isAudioRawDataStereo;
174
178@property (nonatomic, assign, readwrite) MobileRTCAudioRawdataSamplingRate audioRawSampleRate;
179
183@property (nonatomic, assign, readwrite) MobileRTCVideoRawdataColorspace videoRawdataColorspace;
184
185
186@end
187
197@property (nullable, nonatomic, copy, readwrite) NSString * formattedHtmlContent;
198
202@property (nullable, nonatomic, copy, readwrite) NSString * accountOwnerUrl;
203
207@property (nullable, nonatomic, copy, readwrite) NSString * termsUrl;
208
212@property (nullable, nonatomic, copy, readwrite) NSString * privacyPolicyUrl;
213
214@end
215
220@interface MobileRTCMeetingParameter : NSObject
224@property (nonatomic, assign) MobileRTCMeetingType meetingType;
225
229@property (nonatomic, assign) BOOL isViewOnly;
230
234@property (nonatomic, assign) BOOL isAutoRecordingLocal;
235
239@property (nonatomic, assign) BOOL isAutoRecordingCloud;
240
244@property (nonatomic, assign) unsigned long long meetingNumber;
245
249@property (nonatomic, copy) NSString * _Nullable meetingTopic;
250
254@property (nonatomic, copy) NSString * _Nullable meetingHost;
255
256@end
257
258
263@interface MobileRTCInputUserInfoHandler : NSObject
264
268@property(nonatomic, copy, readonly) NSString * _Nullable defaultDisplayName;
269
273@property(nonatomic, assign, readonly) BOOL canModifyDefaultDisplayName;
274
280- (BOOL)isValidEmail:(NSString *_Nonnull)email;
281
288- (MobileRTCSDKError)inputUserInfo:(NSString *_Nonnull)name email:(NSString *_Nonnull)email;
289
293- (void)cancel;
294
295@end
296
297@protocol MobileRTCMeetingServiceDelegate;
303@interface MobileRTCMeetingService : NSObject
307@property (weak, nonatomic) id<MobileRTCMeetingServiceDelegate> _Nullable delegate;
308
312@property (weak, nonatomic) id<MobileRTCCustomizedUIMeetingDelegate> _Nullable customizedUImeetingDelegate;
313
321- (MobileRTCMeetError)startMeetingWithStartParam:(nonnull MobileRTCMeetingStartParam*)param;
322
329- (MobileRTCMeetError)joinMeetingWithJoinParam:(nonnull MobileRTCMeetingJoinParam*)param;
330
336- (MobileRTCMeetError)handZoomWebUrl:(nonnull NSString*)meetingUrl;
337
342- (MobileRTCMeetingState)getMeetingState;
343
348- (void)leaveMeetingWithCmd:(LeaveMeetingCmd)cmd;
349
355- (UIView * _Nullable)meetingView;
356
363- (BOOL)setCustomizedInvitationDomain:(NSString *_Nonnull)invitationDomain;
364
369- (BOOL)isSupportPSMode;
370
375- (BOOL)isPSModeStarted;
376
380- (NSUInteger)getPSUserID;
381
382@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.
MobileRTCVideoRawdataColorspace
Enumeration representing the colorspace of acquired raw video data.
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.
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.
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.
MobileRTCVideoRawdataColorspace videoRawdataColorspace
<Optional> The colorspace of video rawdata. The default is VideoRawdataColorspace_BT601_L.
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...