IMeetingViewLayoutHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IVIDEOLAYOUTHELPER_H
#define ZRC_IVIDEOLAYOUTHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum VideoLayoutStyle
{
    VideoLayoutStyleUnknown = 0,              
    VideoLayoutStyleGallery = 1,              
    VideoLayoutStyleSpeaker = 2,              
    VideoLayoutStyleThumbnail = 3,            
    VideoLayoutStyleContentOnly = 4,          
    VideoLayoutStyleCancelContentOnly = 5,    
    VideoLayoutStyleDynamicLayout = 6,        
};
 
enum VideoThumbPosition
{
    VideoThumbPositionCenter = 0,       
    VideoThumbPositionUp = 1,           
    VideoThumbPositionRight = 2,        
    VideoThumbPositionUpRight = 3,      
    VideoThumbPositionDown = 4,         
    VideoThumbPositionDownRight = 5,    
    VideoThumbPositionLeft = 6,         
    VideoThumbPositionUpLeft = 7,       
    VideoThumbPositionDownLeft = 8      
};
 
enum VideoThumbSize
{
    VideoThumbSizeOff = 0,            
    VideoThumbSize1x = 1,             
    VideoThumbSize2x = 2,             
    VideoThumbSize3x = 3,             
    VideoThumbSizeVideoStripe = 4,    
};
 
enum PageVideoType
{
    PageVideoTypeUnknown = -1,            
    PageVideoTypeGalleryView = 0,         
    PageVideoTypeThumbnailView = 1,       
    PageVideoTypeDynamicLayoutView = 2    
};
 
enum VideoOrderType
{
    VideoOrderTypeUnknown = -1,           
    VideoOrderTypeDefault = 0,            
    VideoOrderTypeAlphabetical,           
    VideoOrderTypeReverseAlphabetical,    
    VideoOrderTypeSavedOrder              
};
 
enum DynamicLayoutType
{
    DynamicLayoutTypeSpeakersOnUnknown = -1,
    DynamicLayoutTypeSpeakersOnBottom = 0,
    DynamicLayoutTypeSpeakersOnMiddle,
    DynamicLayoutTypeSpeakersOnTop
};
 
enum ConfidenceMonitorLayoutType
{
    ConfidenceMonitorLayoutTypeUnknown = -1,        
    ConfidenceMonitorLayoutTypeSelf = 0,            
    ConfidenceMonitorLayoutTypeActive = 1,          
    ConfidenceMonitorLayoutTypeShareContent = 2,    
};
 
enum AttendeeViewLayoutType
{
    AttendeeViewLayoutTypeNone = 0,         
    AttendeeViewLayoutTypeStandard,         
    AttendeeViewLayoutTypeSpeaker,          
    AttendeeViewLayoutTypeGallery,          
    AttendeeViewLayoutTypeFollow,           
    AttendeeViewLayoutTypeShareContentOnly  
};
 
enum ThumbnailsPositionType
{
    ThumbnailsPositionTypeNone = -1,        
    ThumbnailsPositionTypeBottom = 0,       
    ThumbnailsPositionTypeTop,              
    ThumbnailsPositionTypeUnknown = 255,    
};
 
struct VideoPageStatus
{
    bool          isInFirstPage = false;                       
    bool          isInLastPage = false;                        
    PageVideoType pageVideoType = PageVideoTypeGalleryView;    
    int           videoCountInCurrentPage = 0;                 
};
 
struct VideoThumbInfo
{
    bool               isSupported = false;                    
    VideoThumbPosition position = VideoThumbPositionCenter;    
    VideoThumbSize     size = VideoThumbSizeOff;               
    VideoPageStatus    videoPageStatus;                        
    bool               isThumbnailOnTop = false;               
};
 
struct VideoLayoutStatus
{
    bool canSwitchSpeakerView = false;      
    bool canSwitchThumbnailView = false;    
    bool canSwitchGalleryView = false;      
    bool canSwitchContentOnly = false;      
    bool canSwitchDynamicLayout = false;    
 
    bool isInThumbnail = false;        
    bool isInGalleryView = false;      
    bool isInContentOnly = false;      
    bool isInImmersive = false;        
    bool isInDynamicLayout = false;    
 
    bool canAdjustFloatingVideo = false;           
    bool canSwitchFloatingShareContent = false;    
    bool isInFloatingShareContent = false;         
};
 
struct WallViewStyleStatus
{
    VideoLayoutStatus videoLayoutStatus;    
    VideoPageStatus   videoPageStatus;      
    VideoThumbInfo    videoThumbInfo;       
};
 
struct VideoOrderInfo
{
    VideoOrderType type = VideoOrderTypeUnknown;    
    bool           hasSavedOrder = false;           
    bool           isFollowHostOrder = false;       
    bool           isSavedOrderEnabled = false;     
};
 
struct ConfidenceMonitorInfo
{
    ConfidenceMonitorLayoutType layout = ConfidenceMonitorLayoutTypeUnknown;    
    bool                        isSharedContentAvailable = false;
};
 
struct ScreenLayoutCtrlInfo
{
    ScreenLayoutSourceType layout = ScreenLayoutSourceTypeNone;     
    bool enable = false;                                            
    bool visible = false;                                           
};
 
struct ScreenLayoutInfo
{
    MeetingScreen screen = MeetingScreenUnknown;                    
    ScreenLayoutSourceType layout = ScreenLayoutSourceTypeNone;     
    std::vector<ScreenLayoutCtrlInfo> layoutCtrlInfos;              
};
 
struct ScreenLayoutStatus
{
    bool canShowContentOnly = false;                    
    bool isInContentOnly = false;                       
    bool canAdjustFloatingVideo = false;                
    bool canSwitchFloatingShareContent = false;         
    bool isInFloatingShareContent = false;              
    std::vector<ScreenLayoutInfo> layoutInfos;          
};
 
class IMeetingViewLayoutHelperSink
{
public:
    virtual ~IMeetingViewLayoutHelperSink() {}
 
    virtual void OnUpdateWallviewStyleNotification(const WallViewStyleStatus& status) = 0;
 
    virtual void OnUpdateVideoThumbInfo(const VideoThumbInfo& info) = 0;
 
    virtual void OnUpdateVideoPageStatusNotification(const VideoPageStatus& noti) = 0;
 
    virtual void OnUpdateIsNonVideoParticipantsShowedNotification(bool isShowNonVideoParticipants) = 0;
 
    virtual void OnUpdateShowUpTo49PerPageInGallery(bool enabled) = 0;
 
    virtual void OnAutoSwitchSpeakerNotification(bool support, bool enable) = 0;
 
    virtual void OnVideoOrderNotification(const VideoOrderInfo& videoOrderInfo) = 0;
 
    virtual void OnDynamicLayoutOptionNotification(DynamicLayoutType layout) = 0;
    
    virtual void OnConfidenceMonitorNotification(const ConfidenceMonitorInfo& info) = 0;
 
    virtual void OnChangeAttendeeViewNotification(AttendeeViewLayoutType layout) = 0;
   
    virtual void OnAttendeeViewLayoutEnableShareContentOnlyNotification(bool isSupport, bool isEnable) = 0;
 
    virtual void OnUpdateGalleryGridSelectionNotification(bool isEnabled, uint32_t row, uint32_t column) = 0;
 
    virtual void OnUpdateScreenLayoutStatus(const ScreenLayoutStatus& status) = 0;
 
    virtual void OnThumbnailsPositionNotification(ThumbnailsPositionType type) = 0;
};
 
class IMeetingViewLayoutHelper
{
public:
    virtual ~IMeetingViewLayoutHelper() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingViewLayoutHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingViewLayoutHelperSink* pSink) = 0;
 
    virtual ZRCSDKError UpdateVideoLayoutStyle(VideoLayoutStyle style) = 0;
 
    virtual ZRCSDKError ControlVideoPosition(VideoThumbPosition position, VideoThumbSize size) = 0;
 
    virtual ZRCSDKError TurnVideoPage(bool forward, PageVideoType pageVideoType) = 0;
 
    virtual ZRCSDKError SwitchToFloatingShareForSingleScreen(bool floatingShare) = 0;
 
    virtual ZRCSDKError IsSupportShowNonVideoParticipants(bool& support) = 0;
    
    virtual ZRCSDKError ShowNonVideoParticipants(bool show) = 0;
 
    virtual ZRCSDKError EnableShowUpTo49PerPageInGallery(bool enable) = 0;
 
    virtual ZRCSDKError EnableAutoSwitchSpeaker(bool enable) = 0;
 
    virtual ZRCSDKError SelectVideoOrder(VideoOrderType type) = 0;
 
    virtual ZRCSDKError SetDynamicLayoutOption(DynamicLayoutType layout) = 0;
 
    virtual ZRCSDKError SetConfidenceMonitorLayout(ConfidenceMonitorLayoutType layout) = 0;
 
    virtual ZRCSDKError ChangeAttendeeView(AttendeeViewLayoutType layout) = 0;
 
    virtual ZRCSDKError SelectGalleryGrid(uint32_t row, uint32_t column) = 0;
 
    virtual ZRCSDKError ExpandConfSelfVideo(bool expand) = 0;
 
    virtual ZRCSDKError SetScreenLayout(MeetingScreen screenIndex, ScreenLayoutSourceType layout) = 0;
 
    virtual ZRCSDKError SetShareContentOnly(bool enable) = 0;
 
    virtual ZRCSDKError ShowScreenIndex(bool show) = 0;
 
    virtual ZRCSDKError GetThumbnailsPosition(ThumbnailsPositionType& type) = 0;
 
    virtual ZRCSDKError ChangeThumbnailsPosition(ThumbnailsPositionType type) = 0;
};
 
NS_ZRCSDK_END
#endif    //ZRC_IVIDEOLAYOUTHELPER_H