Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService+Video.h
Go to the documentation of this file.
1
5
6#import <MobileRTC/MobileRTC.h>
7#import <AVFoundation/AVFoundation.h>
8
21@property (nonatomic, assign) MobileRTCVideoPreferenceMode mode;
22
27@property (nonatomic, assign) NSUInteger minimumFrameRate;
28
33@property (nonatomic, assign) NSUInteger maximumFrameRate;
34
35@end
36
41@interface MobileRTCCameraDevice : NSObject
45@property (nonatomic, readonly, nullable, copy) NSString* deviceId;
49@property (nonatomic, readonly, nullable, copy) NSString* deviceName;
53@property (nonatomic, readonly, assign) BOOL isSelectDevice;
57@property (nonatomic, readonly, assign) AVCaptureDevicePosition position;
61@property (nonatomic, readonly, nullable, copy) AVCaptureDeviceType deviceType;
65@property (nonatomic, readonly, assign) CGFloat maxZoomFactor;
69@property (nonatomic, readonly, assign) CGFloat videoZoomFactorUpscaleThreshold;
70
71@end
72
73
77@interface MobileRTCMeetingService (Video)
78
84
90
96- (MobileRTCSDKError)muteMyVideo:(BOOL)mute;
97
103- (BOOL)rotateMyVideo:(UIDeviceOrientation)rotation;
104
110- (BOOL)isUserSpotlighted:(NSUInteger)userId;
111
119- (BOOL)spotlightVideo:(BOOL)on withUser:(NSUInteger)userId;
120
127
132- (NSArray <NSNumber *>* _Nullable)getSpotLightedVideoUserList;
133
140- (BOOL)isUserPinned:(NSUInteger)userId;
141
147-(MobileRTCPinResult)canPinVideo:(NSUInteger)userId;
148
156- (BOOL)pinVideo:(BOOL)on withUser:(NSUInteger)userId;
157
163- (BOOL)isUserVideoSending:(NSUInteger)userID;
164
171- (BOOL)stopUserVideo:(NSUInteger)userID;
172
179- (BOOL)askUserStartVideo:(NSUInteger)userID;
180
186- (CGSize)getUserVideoSize:(NSUInteger)userID;
187
188#pragma mark Camera Related
194
200
207
213- (BOOL)switchCamera:(NSString * _Nullable)cameraId;
214
220
227- (BOOL)zoomCamera:(CGFloat)velocity;
228
235- (MobileRTCSDKError)setVideoQualityPreference:(MobileRTCVideoPreferenceSetting * _Nullable)preferenceSetting;
236
242
248
253- (NSArray <NSNumber *>* _Nullable)getVideoOrderList;
254
260- (MobileRTCSDKError)stopIncomingVideo:(BOOL)enable;
261
267
273
280- (MobileRTCSDKError)enableVideoAutoFraming:(MobileRTCAutoFramingParameter * _Nullable)setting forMode:(MobileRTCAutoFramingMode)mode;
281
287
293
299
305- (MobileRTCSDKError)setVideoAutoFramingMode:(MobileRTCAutoFramingMode)mode;
306
312- (MobileRTCSDKError)setVideoAutoFramingRatio:(CGFloat)ratio;
313
319- (MobileRTCSDKError)setFaceRecognitionFailStrategy:(MobileRTCFaceRecognitionFailStrategy)strategy;
320
326- (MobileRTCAutoFramingParameter * _Nullable)getVideoAutoFramingSetting:(MobileRTCAutoFramingMode)mode;
327
334
343- (MobileRTCSDKError)enableAlphaChannelMode:(BOOL)enable;
344
350
351@end
MobileRTCFaceRecognitionFailStrategy
Enumeration of the face recognition failure strategies.
MobileRTCVideoPreferenceMode
Enumeration of the video preference modes.
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCCameraError
Enumeration of camera-related operational error states.
MobileRTCPinResult
Enumeration of possible results for pinning a user.
MobileRTCAutoFramingMode
Enumeration of the auto framing modes in video.
BOOL isFollowHostVideoOrderOn()
Queries if follow host video order is currently on.
MobileRTCAutoFramingMode getVideoAutoFramingMode()
Gets the current mode of auto-framing.
BOOL unSpotlightAllVideos()
Un-spotlights all users.
BOOL isSupportFollowHostVideoOrder()
Queries if the account supports follow host video order feature.
NSArray< MobileRTCCameraDevice * > *_Nullable getCameraDeviceList()
Gets the camera device list.
MobileRTCCameraError switchMyCamera()
Switches the camera of the current user in the local device.
BOOL isAlphaChannelModeEnabled()
Determines if alpha channel mode is enabled.
BOOL isStopIncomingVideoSupported()
Determines if the incoming video is supported.
NSArray< NSNumber * > *_Nullable getSpotLightedVideoUserList()
Gets the spotlight user list.
MobileRTCCameraDevice *_Nullable getSelectedCamera()
Gets the current camera device in use.
BOOL canEnableAlphaChannelMode()
Determines if alpha channel mode can be enabled.
NSArray< NSNumber * > *_Nullable getVideoOrderList()
Gets the follow host video order array currently.
BOOL isVideoAutoFramingEnabled()
Determines whether auto-framing is enabled.
BOOL canUnmuteMyVideo()
Queries if the user can unmute their video themselves.
BOOL isSendingMyVideo()
Queries if the user is sending video.
BOOL isIncomingVideoStoped()
Determines if the incoming video is stopped.
BOOL isBackCamera()
Queries if the user is using back camera.
MobileRTCSDKError disableVideoAutoFraming()
Stops video auto-framing.
A class that contains auto-framing parameters.
NSString * deviceId
Camera device ID.
AVCaptureDevicePosition position
Camera position.
CGFloat maxZoomFactor
Camera maximum zoom factor. Maximum supported is 10.
AVCaptureDeviceType deviceType
Camera device type.
CGFloat videoZoomFactorUpscaleThreshold
The maximum optical zoom factor.
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.