ZMVideoSDKVideoHelper.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import "ZMVideoSDKUserHelper.h"
 
NS_ASSUME_NONNULL_BEGIN
@interface ZMVideoSDKVirtualBackgroundItem : NSObject

@property (nonatomic, copy, readonly) NSString *imageFilePath;

@property (nonatomic, copy, readonly) NSString *imageName;

@property (nonatomic, assign, readonly) ZMVideoSDKVirtualBackgroundDataType type;

@property (nonatomic, assign, readonly) BOOL canVirtualBackgroundBeDeleted;
 
@end
 
 

@interface ZMVideoSDKCameraDevice : NSObject
@property (nonatomic, copy, readonly) NSString* deviceID;
    
@property (nonatomic, copy, readonly) NSString* deviceName;
    
@property (nonatomic, assign, readonly) BOOL isSelectedDevice;

@property (nonatomic, assign, readonly) BOOL isSelectedAsMultiCamera;
    
@property (nonatomic, assign, readonly) BOOL isRunningAsMultiCamera;
@end
 

@interface ZMVideoSDKPreferenceSetting : NSObject
@property (nonatomic, assign, readwrite) ZMVideoSDKVideoPreferenceMode mode;
    
@property (nonatomic, assign, readwrite) unsigned int minimumFrameRate;
    
@property (nonatomic, assign, readwrite) unsigned int maximumFrameRate;
@end
 

@interface ZMVideoSDKVideoHelper : NSObject
    
- (ZMVideoSDKErrors)startVideo;
    
- (ZMVideoSDKErrors)stopVideo;
    
- (BOOL)rotateMyVideo:(ZMVideoRotation)rotation;
    
- (BOOL)switchCamera;
    
- (BOOL)selectCamera:(NSString*)cameraDeviceID;
    
- (unsigned int)getNumberOfCameras;
    
- (NSArray<ZMVideoSDKCameraDevice *>* _Nullable)getCameraList;

- (ZMVideoSDKErrors)canControlCamera:(BOOL *)canControl deviceID:(nullable NSString*)deviceID;

- (ZMVideoSDKErrors)turnCameraLeft:(unsigned int)range deviceID:(nullable NSString*)deviceID;

- (ZMVideoSDKErrors)turnCameraRight:(unsigned int)range deviceID:(nullable NSString*)deviceID;

- (ZMVideoSDKErrors)turnCameraUp:(unsigned int)range deviceID:(nullable NSString*)deviceID;

- (ZMVideoSDKErrors)turnCameraDown:(unsigned int)range deviceID:(nullable NSString*)deviceID;

- (ZMVideoSDKErrors)zoomCameraIn:(unsigned int)range deviceID:(nullable NSString*)deviceID;

- (ZMVideoSDKErrors)zoomCameraOut:(unsigned int)range deviceID:(nullable NSString*)deviceID;

- (ZMVideoSDKErrors)setVideoQualityPreference:(ZMVideoSDKPreferenceSetting*)preferenceSetting;

- (BOOL)enableMultiStreamVideo:(NSString *)cameraDeviceID customDeviceName:(nullable NSString *)customDeviceName;

- (BOOL)disableMultiStreamVideo:(NSString *)cameraDeviceID;

- (BOOL)muteMultiStreamVideo:(NSString *)cameraDeviceID;

- (BOOL)unmuteMultiStreamVideo:(NSString *)cameraDeviceID;
- (NSString * _Nullable)getDeviceIDByMyPipe:(ZMVideoSDKRawDataPipe *)pipe;
- (ZMVideoSDKErrors)startVideoPreview:(id<ZMVideoSDKRawDataPipeDelegate>)listener deviceID:(NSString* _Nullable)cameraDeviceID DEPRECATED_MSG_ATTRIBUTE("Use -startVideoPreview:deviceID:resolution: instead");

- (ZMVideoSDKErrors)startVideoPreview:(id<ZMVideoSDKRawDataPipeDelegate>)listener deviceID:(NSString* _Nullable)cameraDeviceID resolution:(ZMVideoSDKResolution)resolution;
- (ZMVideoSDKErrors)stopVideoPreview:(id<ZMVideoSDKRawDataPipeDelegate>)listener;

- (ZMVideoSDKErrors)startVideoCanvasPreview:(NSView*)view deviceID:(NSString* _Nullable)cameraDeviceID;

- (ZMVideoSDKErrors)stopVideoCanvasPreview:(NSView*)view;

- (ZMVideoSDKErrors)addVirtualBackgroundItem:(NSString *)imagePath imageItem:(ZMVideoSDKVirtualBackgroundItem * _Nullable * _Nonnull)imageItem;

- (ZMVideoSDKErrors)removeVirtualBackgroundItem:(ZMVideoSDKVirtualBackgroundItem *)imageItem;

- (NSArray<ZMVideoSDKVirtualBackgroundItem* >* _Nullable)getVirtualBackgroundItemList;

- (ZMVideoSDKErrors)setVirtualBackgroundItem:(ZMVideoSDKVirtualBackgroundItem*)imageItem;

- (ZMVideoSDKVirtualBackgroundItem* _Nullable)getSelectedVirtualBackgroundItem;

- (BOOL)isOriginalAspectRatioEnabled;

- (BOOL)enableOriginalAspectRatio:(BOOL)bEnabled;
 

- (ZMVideoSDKErrors)mirrorMyVideo:(BOOL)bEnabled;

- (BOOL)isMyVideoMirrored;

- (BOOL)isDeviceSupportAlphaChannelMode;

- (BOOL)canEnableAlphaChannelMode;

- (ZMVideoSDKErrors)enableAlphaChannelMode:(BOOL)enabled;

- (BOOL)isAlphaChannelModeEnabled;

- (ZMVideoSDKErrors)spotLightVideo:(ZMVideoSDKUser*)user;

- (ZMVideoSDKErrors)unSpotLightVideo:(ZMVideoSDKUser*)user;

- (ZMVideoSDKErrors)unSpotlightAllVideos;

- (NSArray<ZMVideoSDKUser *>* _Nullable)getSpotlightedVideoUserList;
@end
 
NS_ASSUME_NONNULL_END