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
108- (ZoomVideoSDKError)startVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate>_Nullable)delegate DEPRECATED_MSG_ATTRIBUTE("startVideoPreview:resolution:");
109
116- (ZoomVideoSDKError)startVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate>_Nullable)delegate resolution:(ZoomVideoSDKVideoResolution)resolution;
117
123- (ZoomVideoSDKError)stopVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate> _Nullable)delegate;
124
131- (ZoomVideoSDKError)startVideoCanvasPreview:(UIView * _Nullable)view andAspectMode:(ZoomVideoSDKVideoAspect)aspect;
132
138- (ZoomVideoSDKError)stopVideoCanvasPreview:(UIView * _Nullable)view;
139
144- (ZoomVideoSDKError)startVideo;
145
150- (ZoomVideoSDKError)stopVideo;
151
158- (BOOL)rotateMyVideo:(UIDeviceOrientation)rotation;
159
166- (ZoomVideoSDKError)mirrorMyVideo:(BOOL)enable;
167
173- (BOOL)isMyVideoMirrored;
174
178- (void)switchCamera API_UNAVAILABLE(visionos);
179
185- (NSArray <ZoomVideoSDKCameraDevice *>* _Nullable)getCameraDeviceList;
186
192- (BOOL)switchCamera:(NSString * _Nullable)cameraId API_UNAVAILABLE(visionos);
193
198- (ZoomVideoSDKCameraDevice * _Nullable)getSelectedCamera;
199
205- (ZoomVideoSDKError)setVideoQualityPreference:(ZoomVideoSDKVideoPreferenceSetting * _Nullable)preferenceSetting;
206
207#pragma mark - OriginalAspec -
212- (BOOL)isOriginalAspectRatioEnabled;
213
220- (BOOL)enableOriginalAspectRatio:(BOOL)enabled;
221
222#pragma mark - alpha channel -
228- (BOOL)canEnableAlphaChannelMode;
229
235- (ZoomVideoSDKError)enableAlphaChannelMode:(BOOL)enable;
236
241- (BOOL)isAlphaChannelModeEnabled;
242
248- (BOOL)isDeviceSupportAlphaChannelMode;
249
250#pragma mark - spotlight -
256- (ZoomVideoSDKError)spotLightVideo:(ZoomVideoSDKUser * _Nullable)user;
257
263- (ZoomVideoSDKError)unSpotLightVideo:(ZoomVideoSDKUser * _Nullable)user;
264
269- (ZoomVideoSDKError)unSpotlightAllVideos;
270
275- (NSArray <ZoomVideoSDKUser *>* _Nullable)getSpotlightedVideoUserList;
276
277#pragma mark - multi stream -
278
283- (BOOL)isMultiStreamSupported API_UNAVAILABLE(visionos);
284
292- (BOOL)enableMultiStreamVideo:(NSString * _Nullable)cameraDeviceID customDeviceName:(NSString * _Nullable)customDeviceName API_UNAVAILABLE(visionos);
293
299- (BOOL)disableMultiStreamVideo:(NSString * _Nullable)cameraDeviceID API_UNAVAILABLE(visionos);
300
306- (BOOL)muteMultiStreamVideo:(NSString * _Nullable)cameraDeviceID API_UNAVAILABLE(visionos);
307
313- (BOOL)unmuteMultiStreamVideo:(NSString * _Nullable)cameraDeviceID API_UNAVAILABLE(visionos);
314
320- (NSString * _Nullable)getDeviceIDByMyPipe:(ZoomVideoSDKRawDataPipe * _Nullable)pipe;
321
327- (NSString *_Nullable)getDeviceIDByMyCanvas:(ZoomVideoSDKVideoCanvas *_Nullable)canvas;
328
329@end
ZoomVideoSDKVideoPreferenceMode
Enumerates the video preference modes.
ZoomVideoSDKVideoResolution
Enumeration of render resolution.
ZoomVideoSDKError
Enumerates all 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
if the camera is turned on. YES : camera turned on, NO : camera turned off.