ZoomVideoSDKVideoHelper.h

Go to the documentation of this file.

//
//  ZoomVideoSDKVideoHelper.h
//  ZoomVideoSDK
//
//  Created by Zoom Video Communications on 2018/12/6.
//  Copyright © Zoom Video Communications, Inc. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import <AVFoundation/AVFoundation.h>
#import <ZoomVideoSDK/ZoomVideoSDKConstants.h>
#import <ZoomVideoSDK/ZoomVideoSDKRawDataPipe.h>
 
@protocol ZoomVideoSDKRawDataPipeDelegate;
@class ZoomVideoSDKRawDataPipe;
@class ZoomVideoSDKVideoCanvas;
 
@interface ZoomVideoSDKVideoStatus : NSObject
@property (nonatomic, assign) BOOL          on;
 
@end
 
 
@interface ZoomVideoSDKVideoPreferenceSetting : NSObject
 
@property (nonatomic, assign) ZoomVideoSDKVideoPreferenceMode mode;
 
@property (nonatomic, assign) NSUInteger minimumFrameRate;
 
@property (nonatomic, assign) NSUInteger maximumFrameRate;
 
@end
 
@interface ZoomVideoSDKCameraDevice : NSObject
@property (nonatomic, readonly, nullable, copy) NSString* deviceId;
@property (nonatomic, readonly, nullable, copy) NSString* deviceName;
@property (nonatomic, readonly, assign)         BOOL isSelectDevice;
@property (nonatomic, readonly, assign)         AVCaptureDevicePosition position;
@property (nonatomic, readonly, nullable, copy) AVCaptureDeviceType deviceType;
@property (nonatomic, readonly, assign)         CGFloat maxZoomFactor;
@property (nonatomic, readonly, assign)         CGFloat videoZoomFactorUpscaleThreshold;
@property (nonatomic, readonly, assign)         BOOL isSelectedAsMultiCamera;
@property (nonatomic, readonly, assign)         BOOL isRunningAsMultiCamera;
 
@end
 
@interface ZoomVideoSDKVideoHelper : NSObject
 
- (ZoomVideoSDKError)startVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate>_Nullable)delegate DEPRECATED_MSG_ATTRIBUTE("startVideoPreview:resolution:");
 
- (ZoomVideoSDKError)startVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate>_Nullable)delegate resolution:(ZoomVideoSDKVideoResolution)resolution;
 
- (ZoomVideoSDKError)stopVideoPreview:(id<ZoomVideoSDKRawDataPipeDelegate> _Nullable)delegate;
 
- (ZoomVideoSDKError)startVideoCanvasPreview:(UIView * _Nullable)view andAspectMode:(ZoomVideoSDKVideoAspect)aspect;
 
- (ZoomVideoSDKError)stopVideoCanvasPreview:(UIView * _Nullable)view;
 
- (ZoomVideoSDKError)startVideo;
 
- (ZoomVideoSDKError)stopVideo;
 
- (BOOL)rotateMyVideo:(UIDeviceOrientation)rotation;
 
- (ZoomVideoSDKError)mirrorMyVideo:(BOOL)enable;
 
- (BOOL)isMyVideoMirrored;
 
- (void)switchCamera;
 
- (NSArray <ZoomVideoSDKCameraDevice *>* _Nullable)getCameraDeviceList;
 
- (BOOL)switchCamera:(NSString * _Nullable)cameraId;
 
- (ZoomVideoSDKCameraDevice * _Nullable)getSelectedCamera;
 
- (ZoomVideoSDKError)setVideoQualityPreference:(ZoomVideoSDKVideoPreferenceSetting * _Nullable)preferenceSetting;
 
#pragma mark - OriginalAspec -
- (BOOL)isOriginalAspectRatioEnabled;
 
- (BOOL)enableOriginalAspectRatio:(BOOL)enabled;
 
#pragma mark - alpha channel -
- (BOOL)canEnableAlphaChannelMode;
 
- (ZoomVideoSDKError)enableAlphaChannelMode:(BOOL)enable;
 
- (BOOL)isAlphaChannelModeEnabled;
 
- (BOOL)isDeviceSupportAlphaChannelMode;
 
#pragma mark - spotlight -
- (ZoomVideoSDKError)spotLightVideo:(ZoomVideoSDKUser * _Nullable)user;
 
- (ZoomVideoSDKError)unSpotLightVideo:(ZoomVideoSDKUser * _Nullable)user;
 
- (ZoomVideoSDKError)unSpotlightAllVideos;
 
- (NSArray <ZoomVideoSDKUser *>* _Nullable)getSpotlightedVideoUserList;
 
#pragma mark - multi stream -
 
- (BOOL)isMultiStreamSupported;
 
- (BOOL)enableMultiStreamVideo:(NSString * _Nullable)cameraDeviceID customDeviceName:(NSString * _Nullable)customDeviceName;
 
- (BOOL)disableMultiStreamVideo:(NSString * _Nullable)cameraDeviceID;
 
- (BOOL)muteMultiStreamVideo:(NSString * _Nullable)cameraDeviceID;
 
- (BOOL)unmuteMultiStreamVideo:(NSString * _Nullable)cameraDeviceID;
 
- (NSString * _Nullable)getDeviceIDByMyPipe:(ZoomVideoSDKRawDataPipe * _Nullable)pipe;
 
- (NSString *_Nullable)getDeviceIDByMyCanvas:(ZoomVideoSDKVideoCanvas *_Nullable)canvas;
 
@end