Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService+Video.h
Go to the documentation of this file.
1//
2// MobileRTCMeetingService+Video.h
3// MobileRTC
4//
5// Created by Zoom Communications on 2018/6/6.
6// Copyright © Zoom Communications, Inc. All rights reserved.
7//
8
9#import <MobileRTC/MobileRTC.h>
10#import <AVFoundation/AVFoundation.h>
11
24@property (nonatomic, assign) MobileRTCVideoPreferenceMode mode;
25
30@property (nonatomic, assign) NSUInteger minimumFrameRate;
31
36@property (nonatomic, assign) NSUInteger maximumFrameRate;
37
38@end
39
44@interface MobileRTCCameraDevice : NSObject
48@property (nonatomic, readonly, nullable, copy) NSString* deviceId;
52@property (nonatomic, readonly, nullable, copy) NSString* deviceName;
56@property (nonatomic, readonly, assign) BOOL isSelectDevice;
60@property (nonatomic, readonly, assign) AVCaptureDevicePosition position;
64@property (nonatomic, readonly, nullable, copy) AVCaptureDeviceType deviceType;
68@property (nonatomic, readonly, assign) CGFloat maxZoomFactor;
72@property (nonatomic, readonly, assign) CGFloat videoZoomFactorUpscaleThreshold;
73
74@end
75
76
80@interface MobileRTCMeetingService (Video)
81
86- (BOOL)isSendingMyVideo;
87
92- (BOOL)canUnmuteMyVideo;
93
99- (MobileRTCSDKError)muteMyVideo:(BOOL)mute;
100
105- (BOOL)rotateMyVideo:(UIDeviceOrientation)rotation;
106
112- (BOOL)isUserSpotlighted:(NSUInteger)userId;
113
121- (BOOL)spotlightVideo:(BOOL)on withUser:(NSUInteger)userId;
122
128- (BOOL)unSpotlightAllVideos;
129
134- (NSArray <NSNumber *>* _Nullable)getSpotLightedVideoUserList;
135
142- (BOOL)isUserPinned:(NSUInteger)userId;
143
149-(MobileRTCPinResult)canPinVideo:(NSUInteger)userId;
150
158- (BOOL)pinVideo:(BOOL)on withUser:(NSUInteger)userId;
159
165- (BOOL)isUserVideoSending:(NSUInteger)userID;
166
173- (BOOL)stopUserVideo:(NSUInteger)userID;
174
181- (BOOL)askUserStartVideo:(NSUInteger)userID;
182
188- (CGSize)getUserVideoSize:(NSUInteger)userID;
189
190#pragma mark Camera Related
195- (BOOL)isBackCamera;
196
201- (MobileRTCCameraError)switchMyCamera;
202
208- (NSArray <MobileRTCCameraDevice *>* _Nullable)getCameraDeviceList;
209
215- (BOOL)switchCamera:(NSString * _Nullable)cameraId;
216
221- (MobileRTCCameraDevice * _Nullable)getSelectedCamera;
222
228- (BOOL)zoomCamera:(CGFloat)velocity;
229
236- (MobileRTCSDKError)setVideoQualityPreference:(MobileRTCVideoPreferenceSetting * _Nullable)preferenceSetting;
237
242- (BOOL)isSupportFollowHostVideoOrder;
243
248- (BOOL)isFollowHostVideoOrderOn;
249
254- (NSArray <NSNumber *>* _Nullable)getVideoOrderList;
255
261- (MobileRTCSDKError)stopIncomingVideo:(BOOL)enable;
262
267- (BOOL)isIncomingVideoStoped;
268
273- (BOOL)isStopIncomingVideoSupported;
274
281- (MobileRTCSDKError)enableVideoAutoFraming:(MobileRTCAutoFramingParameter * _Nullable)setting forMode:(MobileRTCAutoFramingMode)mode;
282
287- (MobileRTCSDKError)disableVideoAutoFraming;
288
293- (BOOL)isVideoAutoFramingEnabled;
294
299- (MobileRTCAutoFramingMode)getVideoAutoFramingMode;
300
306- (MobileRTCSDKError)setVideoAutoFramingMode:(MobileRTCAutoFramingMode)mode;
307
314- (MobileRTCSDKError)setVideoAutoFramingRatio:(CGFloat)ratio;
315
321- (MobileRTCSDKError)setFaceRecognitionFailStrategy:(MobileRTCFaceRecognitionFailStrategy)strategy;
322
328- (MobileRTCAutoFramingParameter * _Nullable)getVideoAutoFramingSetting:(MobileRTCAutoFramingMode)mode;
329
335- (BOOL)canEnableAlphaChannelMode;
336
345- (MobileRTCSDKError)enableAlphaChannelMode:(BOOL)enable;
346
351- (BOOL)isAlphaChannelModeEnabled;
352
353@end
MobileRTCFaceRecognitionFailStrategy
Enumeration of face recognition failure strategies.
MobileRTCVideoPreferenceMode
Enumeration of video preference modes.
MobileRTCSDKError
Enumeration of SDK error.
MobileRTCCameraError
Enumeration of camera-related operational error states.
MobileRTCPinResult
Enumeration of possible results for pinning a user.
MobileRTCAutoFramingMode
Enumeration of auto framing modes in video.
NSUInteger minimumFrameRate
Minimum frame rate, default is 0, minimumFrameRate should be less than maximumFrameRate.
MobileRTCVideoPreferenceMode mode
Preferred video mode.
NSUInteger maximumFrameRate
Maximum frame rate, default is 0, , maximumFrameRate should be less or equal than 30.