Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKVideoHelper.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <AVFoundation/AVFoundation.h>
8#import <ZoomVideoSDK/ZoomVideoSDKConstants.h>
9#import <ZoomVideoSDK/ZoomVideoSDKRawDataPipe.h>
10
11@protocol ZoomVideoSDKRawDataPipeDelegate;
14
19@interface ZoomVideoSDKVideoStatus : NSObject
23@property (nonatomic, assign) BOOL on;
24
25@end
26
27
33
37@property (nonatomic, assign) ZoomVideoSDKVideoPreferenceMode mode;
38
43@property (nonatomic, assign) NSUInteger minimumFrameRate;
44
49@property (nonatomic, assign) NSUInteger maximumFrameRate;
50
51@end
52
57@interface ZoomVideoSDKCameraDevice : NSObject
61@property (nonatomic, readonly, nullable, copy) NSString* deviceId;
65@property (nonatomic, readonly, nullable, copy) NSString* deviceName;
69@property (nonatomic, readonly, assign) BOOL isSelectDevice;
73@property (nonatomic, readonly, assign) AVCaptureDevicePosition position;
77@property (nonatomic, readonly, nullable, copy) AVCaptureDeviceType deviceType;
81@property (nonatomic, readonly, assign) CGFloat maxZoomFactor;
85@property (nonatomic, readonly, assign) CGFloat videoZoomFactorUpscaleThreshold;
89@property (nonatomic, readonly, assign) BOOL isSelectedAsMultiCamera;
93@property (nonatomic, readonly, assign) BOOL isRunningAsMultiCamera;
94
95@end
96
101@interface ZoomVideoSDKVideoHelper : NSObject
102
109- (ZoomVideoSDKError)startVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate>_Nullable)delegate DEPRECATED_MSG_ATTRIBUTE("startVideoPreview:resolution:");
110
117- (ZoomVideoSDKError)startVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate>_Nullable)delegate resolution:(ZoomVideoSDKVideoResolution)resolution;
118
124- (ZoomVideoSDKError)stopVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate> _Nullable)delegate;
125
132- (ZoomVideoSDKError)startVideoCanvasPreview:(UIView * _Nullable)view andAspectMode:(ZoomVideoSDKVideoAspect)aspect;
133
139- (ZoomVideoSDKError)stopVideoCanvasPreview:(UIView * _Nullable)view;
140
145- (ZoomVideoSDKError)startVideo;
146
151- (ZoomVideoSDKError)stopVideo;
152
159- (BOOL)rotateMyVideo:(UIDeviceOrientation)rotation;
160
167- (ZoomVideoSDKError)mirrorMyVideo:(BOOL)enable;
168
174- (BOOL)isMyVideoMirrored;
175
179- (void)switchCamera API_UNAVAILABLE(visionos);
180
186- (NSArray <ZoomVideoSDKCameraDevice *>* _Nullable)getCameraDeviceList;
187
193- (BOOL)switchCamera:(NSString * _Nullable)cameraId API_UNAVAILABLE(visionos);
194
199- (ZoomVideoSDKCameraDevice * _Nullable)getSelectedCamera;
200
206- (ZoomVideoSDKError)setVideoQualityPreference:(ZoomVideoSDKVideoPreferenceSetting * _Nullable)preferenceSetting;
207
208#pragma mark - OriginalAspec -
213- (BOOL)isOriginalAspectRatioEnabled;
214
221- (BOOL)enableOriginalAspectRatio:(BOOL)enabled;
222
223#pragma mark - alpha channel -
229- (BOOL)canEnableAlphaChannelMode;
230
236- (ZoomVideoSDKError)enableAlphaChannelMode:(BOOL)enable;
237
242- (BOOL)isAlphaChannelModeEnabled;
243
249- (BOOL)isDeviceSupportAlphaChannelMode;
250
251#pragma mark - spotlight -
257- (ZoomVideoSDKError)spotLightVideo:(ZoomVideoSDKUser * _Nullable)user;
258
264- (ZoomVideoSDKError)unSpotLightVideo:(ZoomVideoSDKUser * _Nullable)user;
265
270- (ZoomVideoSDKError)unSpotlightAllVideos;
271
276- (NSArray <ZoomVideoSDKUser *>* _Nullable)getSpotlightedVideoUserList;
277
278#pragma mark - multi stream -
279
284- (BOOL)isMultiStreamSupported API_UNAVAILABLE(visionos);
285
293- (BOOL)enableMultiStreamVideo:(NSString * _Nullable)cameraDeviceID customDeviceName:(NSString * _Nullable)customDeviceName API_UNAVAILABLE(visionos);
294
300- (BOOL)disableMultiStreamVideo:(NSString * _Nullable)cameraDeviceID API_UNAVAILABLE(visionos);
301
307- (BOOL)muteMultiStreamVideo:(NSString * _Nullable)cameraDeviceID API_UNAVAILABLE(visionos);
308
314- (BOOL)unmuteMultiStreamVideo:(NSString * _Nullable)cameraDeviceID API_UNAVAILABLE(visionos);
315
321- (NSString * _Nullable)getDeviceIDByMyPipe:(ZoomVideoSDKRawDataPipe * _Nullable)pipe;
322
328- (NSString *_Nullable)getDeviceIDByMyCanvas:(ZoomVideoSDKVideoCanvas *_Nullable)canvas;
329
330@end
ZoomVideoSDKVideoPreferenceMode
Enumeration of video preference modes.
ZoomVideoSDKVideoResolution
Enumeration of the render resolution.
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
ZoomVideoSDKVideoAspect
Enumeration of the video aspect ratio.
Represents a camera device and its state.
A class to manage the subscription and unsubscription of video or share raw data.
Zoom Video SDK user information.
The video canvas is the display area of the video streams on the user’s local device....
An interface to control video and manage cameras during a video session.
Video preference interface.When setting custom modes, the maximum and minimum frame rates are provide...
BOOL on
Determines whether the camera is turned on.