IMeetingVideoHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IMEETINGVIDEOHELPER_H
#define ZRC_IMEETINGVIDEOHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum PinShareWarningType
{
    PinShareWarningTypeNone = 0,               
    PinShareWarningTypeNoAnnotationForSelf,    
    PinShareWarningTypeStopSelfShare,          
    PinShareWarningTypeStopCameraShare,        
    PinShareWarningTypeStopWhiteboard          
};
 
enum CanNotPinShareReason
{
    CanNotPinShareReasonUnknown = 1,    
    CanNotPinShareReasonContentOnly     
};
 
enum PreviewVideoType
{
    PreviewVideoTypeCameraSettings = 0,    
    PreviewVideoTypeVirtualBackground,     
    PreviewVideoTypeMeetingAlert,          
};
 
struct ScreenStatusForPin
{
    int32_t                      screenIndex = 0;                                           
    bool                         canPinVideo = false;                                       
    std::vector<int32_t>         pinnedUserIDs;                                             
    ScreenLayoutSourceType       screenLayout = ScreenLayoutSourceTypeActiveVideo;          
    int32_t                      pinnedShareSourceID = 0;                                   
    ShareSourceType              pinnedShareSourceType = ShareSourceTypeUnknown;            
    std::vector<ShareSourceType> pinnableShareTypes;                                        
    bool                         canPinShare = false;                                       
    CanNotPinShareReason         canNotPinShareReason = CanNotPinShareReasonUnknown;        
    bool                         isZRWScreen = false;                                       
    bool                         isThumbnailScreen = false;                                 
    int32_t                      pinnedShareUserID = 0;                                     
};
 
struct SpotlightStatus
{
    bool                 present = false;    
    std::vector<int32_t> userIDs;            
};
 
struct MyVideoTouchUpSettings
{
    bool    isFaceBeautyEnabled = false;    
    int32_t faceBeautyStrength = 0;         
};
 
struct MyVideoLowLightSettings
{
    bool    isAdjustLowLightEnabled = false;    
    bool    isAutoAdjustLowLight = false;       
    int32_t adjustLowLightValue = 0;            
};
 
struct MyVideoSettings
{
    MyVideoTouchUpSettings  touchUpSettings;     
    MyVideoLowLightSettings lowLightSettings;    
 
    bool  allowUserEnhanceAppearance = false;     
    bool  canPresetSettingsForMeeting = false;    
    bool  isLocked = false;                       
};
 
struct MyMeetingVideoSettings
{
    MyVideoSettings setting;    
    MeetingItem     meeting;    
};
 
class IMeetingVideoHelperSink
{
public:
    virtual ~IMeetingVideoHelperSink() {}
 
    virtual void OnUpdateMyVideoNotification(const VideoStatus& videoStatus) = 0;
 
    virtual void OnMuteUserVideoNotification(int32_t userID, const VideoStatus& videoStatus) = 0;
 
    virtual void OnAskStartVideoByHostNotification(int32_t userID) = 0;
 
    virtual void OnUpdateScreenStatusForPinNotification(const std::vector<ScreenStatusForPin>& pinStatusList, PinShareWarningType warningType) = 0;
 
    virtual void OnSpotlightStatusNotification(const SpotlightStatus& spotlightStatus) = 0;
 
    virtual void OnUpdateAllowAttendeesStartVideo(bool allow) = 0;
 
    virtual void OnMyVideoSettingsNotification(const MyVideoSettings& settings) = 0;
 
    virtual void OnMyMeetingVideoSettingsNotification(const MyMeetingVideoSettings& settings) = 0;
};
 
class IMeetingVideoHelper
{
public:
    virtual ~IMeetingVideoHelper() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingVideoHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingVideoHelperSink* pSink) = 0;
 
    virtual ZRCSDKError UpdateMyVideo(bool stop) = 0;
 
    virtual ZRCSDKError MuteUserVideo(int32_t userID, bool mute) = 0;
 
    virtual ZRCSDKError AnswerHostRequestUnmuteVideo(bool accepted) = 0;
 
    virtual ZRCSDKError AllowAttendeesStartVideo(bool allow) = 0;
 
    virtual ZRCSDKError ShowPinUserInstruction(bool show) = 0;
 
    virtual ZRCSDKError AllowUserMultiPin(int32_t userID, bool allow) = 0;
 
    virtual ZRCSDKError PinUserOnScreen(int32_t userID, int32_t screenIndex) = 0;
 
    virtual ZRCSDKError AddPinUserOnScreen(int32_t userID, int32_t screenIndex) = 0;
 
    virtual ZRCSDKError UnpinUserFromScreen(int32_t userID, int32_t screenIndex) = 0;
 
    virtual ZRCSDKError UnpinUserFromAllScreens(int32_t userID) = 0;
 
    virtual ZRCSDKError RemoveAllPinUsers() = 0;
 
    virtual ZRCSDKError SpotlightUser(int32_t userID) = 0;
 
    virtual ZRCSDKError AddSpotlightUser(int32_t userID) = 0;
 
    virtual ZRCSDKError CancelSpotlightUser(int32_t userID) = 0;
 
    virtual ZRCSDKError RemoveAllSpotlightUsers() = 0;
 
    virtual ZRCSDKError IsSupportSetMyVideoHidden(bool& support) = 0;
    
    virtual ZRCSDKError SetMyVideoHidden(bool hidden) = 0;
 
    virtual ZRCSDKError SetMyVideoTouchUp(const MyVideoTouchUpSettings& settings) = 0;
    virtual ZRCSDKError SetMyVideoLowLight(const MyVideoLowLightSettings& settings) = 0;
 
    virtual ZRCSDKError FetchMyMeetingVideoSettings(const MeetingItem& meetingItem) = 0;
    virtual ZRCSDKError SetMyMeetingVideoTouchUp(const MeetingItem& meetingItem, const MyVideoTouchUpSettings& settings) = 0;
    virtual ZRCSDKError SetMyMeetingVideoLowLight(const MeetingItem& meetingItem, const MyVideoLowLightSettings& settings) = 0;
 
    virtual ZRCSDKError ShowVideoPreview(bool show, PreviewVideoType type, const MeetingItem& meeting = MeetingItem()) = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_IMEETINGVIDEOHELPER_H