zoom_video_sdk_video_helper_interface.h

Go to the documentation of this file.

 
#ifndef _ZOOM_VIDEO_SDK_VIDEO_HELPER_INTERFACE_H_
#define _ZOOM_VIDEO_SDK_VIDEO_HELPER_INTERFACE_H_
#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"
#include "zoom_video_sdk_user_helper_interface.h"
 
BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
typedef enum
{
    VideoRotation_0,
    VideoRotation_90,
    VideoRotation_180,
    VideoRotation_270,
}VideoRotation;

typedef enum
{
    ZoomVideoSDKVideoPreferenceMode_Balance, 
    ZoomVideoSDKVideoPreferenceMode_Sharpness, 
    ZoomVideoSDKVideoPreferenceMode_Smoothness, 
    ZoomVideoSDKVideoPreferenceMode_Custom  
}ZoomVideoSDKVideoPreferenceMode;

typedef struct tagVideoPreferenceSetting
{
    ZoomVideoSDKVideoPreferenceMode mode;  
    uint32_t minimum_frame_rate; 
    uint32_t maximum_frame_rate; 
    tagVideoPreferenceSetting()
    {
        mode = ZoomVideoSDKVideoPreferenceMode_Balance;
        minimum_frame_rate = 0;
        maximum_frame_rate = 0;
    }
} ZoomVideoSDKVideoPreferenceSetting;
 
enum ZoomVideoSDKMultiCameraStreamStatus
{
    ZoomVideoSDKMultiCameraStreamStatus_JoinStart, 
    ZoomVideoSDKMultiCameraStreamStatus_JoinFail, 
    ZoomVideoSDKMultiCameraStreamStatus_Joined, 
    ZoomVideoSDKMultiCameraStreamStatus_Left, 
    ZoomVideoSDKMultiCameraStreamStatus_VideoOn, 
    ZoomVideoSDKMultiCameraStreamStatus_VideoOff, 
};
 
#if !defined (__linux) || defined ANDROID
enum VirtualBackgroundDataType
{
    VirtualBackgroundDataType_NONE,
    VirtualBackgroundDataType_IMAGE,
    VirtualBackgroundDataType_BLUR
};
#endif

class IZoomVideoSDKCameraDevice
{
public:
    virtual ~IZoomVideoSDKCameraDevice(){}
    virtual const zchar_t* getDeviceId() = 0;
    virtual const zchar_t* getDeviceName() = 0;
    virtual bool isSelectedDevice() = 0;
#if !defined (__linux) || defined CMM_ANDROID
    virtual bool isSelectedAsMultiCamera() = 0;
    
    virtual bool isRunningAsMultiCamera() = 0;
#endif
};
 
 
#if !defined (__linux) || defined ANDROID

class IVirtualBackgroundItem  
{
public:
    virtual const zchar_t* getImageFilePath() = 0;
    
    virtual const zchar_t* getImageName() = 0;
    
    virtual VirtualBackgroundDataType getType() = 0;
    
    virtual bool canVirtualBackgroundBeDeleted() = 0;
 
    virtual ~IVirtualBackgroundItem() {};
};
#endif

class IZoomVideoSDKVideoHelper
{
public:
    virtual ~IZoomVideoSDKVideoHelper(){}
    virtual ZoomVideoSDKErrors startVideo() = 0;
    
    virtual ZoomVideoSDKErrors spotLightVideo(IZoomVideoSDKUser *pUser) = 0;
    
    virtual ZoomVideoSDKErrors unSpotLightVideo(IZoomVideoSDKUser *pUser) = 0;
    
    virtual ZoomVideoSDKErrors unSpotlightAllVideos() = 0;
    
    virtual IVideoSDKVector<IZoomVideoSDKUser *> *getSpotlightedVideoUserList() = 0;
    
    virtual ZoomVideoSDKErrors stopVideo() = 0;
    
    virtual bool rotateMyVideo(VideoRotation rotation) = 0;
    
    virtual bool switchCamera() = 0;
    
    virtual bool selectCamera(const zchar_t* cameraDeviceID) = 0;
 
#if !defined (__linux) || defined CMM_ANDROID
    virtual bool enableMultiStreamVideo(const zchar_t* cameraDeviceID, const zchar_t* customDeviceName = nullptr) = 0;
    
    virtual bool disableMultiStreamVideo(const zchar_t* cameraDeviceID) = 0;
    
    virtual bool muteMultiStreamVideo(const zchar_t* cameraDeviceID) = 0;
    
    virtual bool unmuteMultiStreamVideo(const zchar_t* cameraDeviceID) = 0;
    
    virtual const zchar_t* getDeviceIDByMyPipe(IZoomVideoSDKRawDataPipe* pPipe) = 0;
#endif

    virtual uint32_t getNumberOfCameras() = 0;
    
    virtual IVideoSDKVector<IZoomVideoSDKCameraDevice*>* getCameraList() = 0;
    
    virtual ZoomVideoSDKErrors canControlCamera(bool& bCan, const zchar_t* pStrDeviceID = nullptr) = 0;
    
    virtual ZoomVideoSDKErrors turnCameraLeft(unsigned int range = 50, const zchar_t * pStrDeviceID = nullptr) = 0;
    
    virtual ZoomVideoSDKErrors turnCameraRight(unsigned int range = 50, const zchar_t* pStrDeviceID = nullptr) = 0;
    
    virtual ZoomVideoSDKErrors turnCameraUp(unsigned int range = 50, const zchar_t* pStrDeviceID = nullptr) = 0;
    
    virtual ZoomVideoSDKErrors turnCameraDown(unsigned int range = 50, const zchar_t* pStrDeviceID = nullptr) = 0;
    
    virtual ZoomVideoSDKErrors zoomCameraIn(unsigned int range = 50, const zchar_t* pStrDeviceID = nullptr) = 0;
    
    virtual ZoomVideoSDKErrors zoomCameraOut(unsigned int range = 50, const zchar_t* pStrDeviceID = nullptr) = 0;
    
    virtual ZoomVideoSDKErrors setVideoQualityPreference(ZoomVideoSDKVideoPreferenceSetting& preference_setting) = 0;
    
    virtual ZoomVideoSDKErrors startVideoPreview(IZoomVideoSDKRawDataPipeDelegate* listener, const zchar_t* cameraDeviceID = nullptr, ZoomVideoSDKResolution resolution = ZoomVideoSDKResolution_1080P) = 0;
    
    virtual ZoomVideoSDKErrors stopVideoPreview(IZoomVideoSDKRawDataPipeDelegate* listener) = 0;
    
    virtual ZoomVideoSDKErrors startVideoCanvasPreview(void* handle, const zchar_t* cameraDeviceID = nullptr) = 0;
    
    virtual ZoomVideoSDKErrors stopVideoCanvasPreview(void* handle) = 0;
 
#if !defined (__linux) || defined ANDROID
    virtual ZoomVideoSDKErrors addVirtualBackgroundItem(const zchar_t* image_path, IVirtualBackgroundItem** imageItem) = 0;
    
    virtual ZoomVideoSDKErrors removeVirtualBackgroundItem(IVirtualBackgroundItem* imageItem) = 0;
    
    virtual IVideoSDKVector<IVirtualBackgroundItem* >* getVirtualBackgroundItemList() = 0;
    
    virtual ZoomVideoSDKErrors setVirtualBackgroundItem(IVirtualBackgroundItem* imageItem) = 0;
    
    virtual IVirtualBackgroundItem* getSelectedVirtualBackgroundItem() = 0;
#endif

    virtual bool isOriginalAspectRatioEnabled() = 0;
    
    virtual bool enableOriginalAspectRatio(bool bEnabled) = 0;
    
    virtual ZoomVideoSDKErrors mirrorMyVideo(bool bEnabled) = 0;
    
    virtual bool isMyVideoMirrored() = 0;
    
    virtual bool canEnableAlphaChannelMode() = 0;
    
    virtual ZoomVideoSDKErrors enableAlphaChannelMode(bool enable) = 0;
    
    virtual bool isAlphaChannelModeEnabled() = 0;
    
    virtual bool isDeviceSupportAlphaChannelMode() = 0;
};
END_ZOOM_VIDEO_SDK_NAMESPACE
#endif