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 <UIKit/UIKit.h>
8#import <MobileRTC/MobileRTCConstants.h>
9#import <MobileRTC/MobileRTCMeetingDelegate.h>
10
15@interface MobileRTCMeetingStartParam : NSObject
19@property (nonatomic, assign, readwrite) BOOL isAppShare;
20
24@property (nonatomic, assign, readwrite) BOOL noAudio;
25
29@property (nonatomic, assign, readwrite) BOOL noVideo;
30
35@property (nullable, nonatomic, copy, readwrite) NSString * customerKey;
36
40@property (nullable, nonatomic, copy, readwrite) NSString * vanityID;
41
45@property (nullable, nonatomic, copy, readwrite) NSString * meetingNumber;
46
50@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;
51
55@property(nullable, nonatomic, copy) NSString *inviteContactID;
56
60@property (nonatomic, assign, readwrite) BOOL isAudioRawDataStereo;
61
65@property (nonatomic, assign, readwrite) MobileRTCAudioRawdataSamplingRate audioRawSampleRate;
66
70@property (nonatomic, assign, readwrite) MobileRTCVideoRawdataColorspace videoRawdataColorspace;
71
72
73@end
74
80@end
81
91@property (nonatomic, assign, readwrite) MobileRTCUserType userType;
92
96@property (nullable, nonatomic, copy, readwrite) NSString * userName;
97
102@property (nonnull, nonatomic, copy, readwrite) NSString * zak;
103
104@end
105
110@interface MobileRTCMeetingJoinParam : NSObject
114@property (nonatomic, assign, readwrite) BOOL noAudio;
115
119@property (nonatomic, assign, readwrite) BOOL noVideo;
120
125@property (nullable, nonatomic, copy, readwrite) NSString * customerKey;
129@property (nullable, nonatomic, copy, readwrite) NSString * vanityID;
133@property (nullable, nonatomic, copy, readwrite) NSString * meetingNumber;
137@property (nullable, nonatomic, copy, readwrite) NSString * userName;
141@property (nullable, nonatomic, copy, readwrite) NSString * password;
145@property (nullable, nonatomic, copy, readwrite) NSString * webinarToken;
146
150@property (nullable, nonatomic, copy, readwrite) NSString * zak;
151
155@property (nullable, nonatomic, copy, readwrite) NSString * onBehalfToken;
156
160@property(nullable, nonatomic, copy, readwrite) NSString *appPrivilegeToken;
161
165@property (nullable, nonatomic, copy, readwrite) NSString * join_token;
166
170@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;
171
175@property (nonatomic, assign, readwrite) BOOL isAudioRawDataStereo;
176
180@property (nonatomic, assign, readwrite) MobileRTCAudioRawdataSamplingRate audioRawSampleRate;
181
185@property (nonatomic, assign, readwrite) MobileRTCVideoRawdataColorspace videoRawdataColorspace;
186
187@end
188
198@property (nullable, nonatomic, copy, readwrite) NSString * formattedHtmlContent;
199
203@property (nullable, nonatomic, copy, readwrite) NSString * accountOwnerUrl;
204
208@property (nullable, nonatomic, copy, readwrite) NSString * termsUrl;
209
213@property (nullable, nonatomic, copy, readwrite) NSString * privacyPolicyUrl;
214
215@end
216
221@interface MobileRTCMeetingParameter : NSObject
225@property (nonatomic, assign) MobileRTCMeetingType meetingType;
226
230@property (nonatomic, assign) BOOL isViewOnly;
231
235@property (nonatomic, assign) BOOL isAutoRecordingLocal;
236
240@property (nonatomic, assign) BOOL isAutoRecordingCloud;
241
245@property (nonatomic, assign) unsigned long long meetingNumber;
246
250@property (nonatomic, copy) NSString * _Nullable meetingTopic;
251
255@property (nonatomic, copy) NSString * _Nullable meetingHost;
256
257@end
258
259
264@interface MobileRTCInputUserInfoHandler : NSObject
265
269@property(nonatomic, copy, readonly) NSString * _Nullable defaultDisplayName;
270
274@property(nonatomic, assign, readonly) BOOL canModifyDefaultDisplayName;
275
281- (BOOL)isValidEmail:(NSString *_Nonnull)email;
282
289- (MobileRTCSDKError)inputUserInfo:(NSString *_Nonnull)name email:(NSString *_Nonnull)email;
290
294- (void)cancel;
295
296@end
297
298@protocol MobileRTCMeetingServiceDelegate;
304@interface MobileRTCMeetingService : NSObject
308@property (weak, nonatomic) id<MobileRTCMeetingServiceDelegate> _Nullable delegate;
309
313@property (weak, nonatomic) id<MobileRTCCustomizedUIMeetingDelegate> _Nullable customizedUImeetingDelegate;
314
322- (MobileRTCMeetError)startMeetingWithStartParam:(nonnull MobileRTCMeetingStartParam*)param;
323
330- (MobileRTCMeetError)joinMeetingWithJoinParam:(nonnull MobileRTCMeetingJoinParam*)param;
331
337- (MobileRTCMeetError)handZoomWebUrl:(nonnull NSString*)meetingUrl;
338
343- (MobileRTCMeetingState)getMeetingState;
344
349- (void)leaveMeetingWithCmd:(LeaveMeetingCmd)cmd;
350
356- (UIView * _Nullable)meetingView;
357
364- (BOOL)setCustomizedInvitationDomain:(NSString *_Nonnull)invitationDomain;
365
370- (BOOL)isSupportPSMode;
371
376- (BOOL)isPSModeStarted;
377
382- (NSUInteger)getPSUserID;
383
384@end
MobileRTCMeetError
Enumeration of errors to start/join meeting.
MobileRTCMeetingState
Enumeration of the meeting status.
MobileRTCUserType
Enumeration of user types.
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCVideoRawdataColorspace
Enumeration of the colorspace of acquired raw video data.
LeaveMeetingCmd
Enumeration of the commands for leaving meeting.
MobileRTCMeetingType
Enumeration of meeting types.
MobileRTCAudioRawdataSamplingRate
Enumeration of 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
YES to start meeting with microphone disabled. Otherwise, NO.
NSString * customerKey
Developer-specified string to track end user.
BOOL noVideo
YES to start meeting with camera disabled. Otherwise, NO.
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
YES to start meeting with screen sharing immediately enabled. Otherwise, NO.
NSString * inviteContactID
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...