IVirtualBackgroundHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IVIRTUALBACKGROUNDHELPER_H
#define ZRC_IVIRTUALBACKGROUNDHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum VBResourceType
{
    RESOURCE_TYPE_IMAGE = 0,    
    RESOURCE_TYPE_VIDEO = 1     
};
 
struct VirtualBackgroundItem
{
    std::string     id;                 
    std::string     name;               
    std::string     bigImageURL;        
    std::string     smallImageURL;      
    bool            isDownloadedOnZR;   
    VBResourceType  resourceType;       
    std::string     downloadFileId;     
};
 
struct VirtualBackgroundOptions
{
    bool isVirtualBackgroundFeatureOn = false;              
    bool isSupportSmartVirtualBackground = false;           
    bool isSupportGreenScreenVirtualBackground = false;     
    bool isSupportBlurVirtualBackground = false;            
    bool isSettingLockedOnWeb = false;                      
    bool isForceEnabledOnWeb = false;                       
};
 
class IVirtualBackgroundHelperSink
{
public:
    virtual ~IVirtualBackgroundHelperSink() {}
 
    virtual void OnUpdateVirtualBackgroundOptions(const VirtualBackgroundOptions& options) = 0;
 
    virtual void OnUpdateVirtualBackgroundList(const std::vector<VirtualBackgroundItem>& vbList) = 0;
 
    virtual void OnUpdateSelectedVirtualBackground(const std::string& selectedVBID) = 0;
 
    virtual void OnUpdateEnableGreenScreen(bool isEnableGreenScreen) = 0;
 
    virtual void OnUpdateIsImmersiveCutOut(bool isImmersiveCutOut) = 0;
 
    virtual void OnUpdateIsDetectingVirtualBackground(bool isDetecting) = 0;
 
    virtual void OnUpdateDetectVirtualBackgroundResult(int32_t result) = 0;
 
    virtual void OnDownloadingFinished(const std::string& localFilePath, uint32_t result) = 0;
};
 
class IVirtualBackgroundHelper
{
public:
    virtual ~IVirtualBackgroundHelper() {}
 
    virtual ZRCSDKError RegisterSink(IVirtualBackgroundHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IVirtualBackgroundHelperSink* pSink) = 0;
 
    virtual ZRCSDKError PreviewVirtualBackground(bool start) = 0;
 
    virtual ZRCSDKError SelectVirtualBackground(const std::string& vbID) = 0;
 
    virtual ZRCSDKError RedetectVirtualBackground() = 0;
 
    virtual ZRCSDKError DownloadVirtualBackgroundImage(std::string imgUrl, std::string localFilePath) = 0;
 
    virtual ZRCSDKError NotifyZRRefreshVirtualBackgroundListInMeeting() = 0;
};
 
NS_ZRCSDK_END
 
#endif //ZRC_IVIRTUALBACKGROUNDHELPER_H