IProAVService.h

Go to the documentation of this file.

 
#ifndef ZRC_IPROAVSERVICE_H
#define ZRC_IPROAVSERVICE_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum ProAVVideoNameStrapPosition
{
    ProAVVideoNameStrapPositionUnknown = -1,    
    ProAVVideoNameStrapPositionLeft = 0,        
    ProAVVideoNameStrapPositionCenter = 1,      
    ProAVVideoNameStrapPositionRight = 2,       
};
 
 
enum ProAVUnassignedBehaviorType
{
    ProAVUnassignedBehaviorTypeOff = 0,         
    ProAVUnassignedBehaviorTypeWallpaper = 1,   
};
 
enum ProAVWallpaperRoomType
{
    ProAVWallpaperRoomTypeNone = -1,    
    ProAVWallpaperRoomTypeMain = 0,     
    ProAVWallpaperRoomTypeCZR = 1,      
    ProAVWallpaperRoomTypeCWB = 2,      
};
 
enum ProAVGalleryDistributionMode
{
    ProAVGalleryDistributionModeWaterfall = 0,      
    ProAVGalleryDistributionModeRoundRobin = 1,     
};
 
struct ProAVVideoOverlaySettings
{
    bool isActiveSpeakerGreenOutlineEnabled = false;                            
    bool isReactionIconsEnabled = false;                                        
    bool isRaiseHandIconEnabled = false;                                        
    bool isNameStrapEnabled = false;                                            
    ProAVVideoNameStrapPosition position= ProAVVideoNameStrapPositionUnknown;   
    bool isMuteIconEnabled = false;                                             
    bool isPollOverlayEnabled = false;                                          
    ProAVGalleryDistributionMode galleryDistributionMode = ProAVGalleryDistributionModeWaterfall; 
    uint32_t    maxGalleryPageCount = 0;                                        
    float elementScale = 1.0f;                                                  
};
 
struct ProAVUnassignedBehavior
{
    ProAVUnassignedBehaviorType unassignedType = ProAVUnassignedBehaviorTypeOff; 
    ProAVWallpaperRoomType roomType = ProAVWallpaperRoomTypeNone;                
    uint32_t wallpaperIndex = 0;                                                 
};
 
enum ProAVVideoLossBehaviorType
{
    ProAVVideoLossBehaviorTypeDefault = 0,       
    ProAVVideoLossBehaviorTypeBlackFrame = 1,    
    ProAVVideoLossBehaviorTypeFreezeFrame = 2,   
    ProAVVideoLossBehaviorTypeWallpaper = 3,     
};
 
struct ProAVVideoLossBehavior
{
    ProAVVideoLossBehaviorType behaviorType = ProAVVideoLossBehaviorTypeDefault; 
    ProAVWallpaperRoomType wallpaperRoomType = ProAVWallpaperRoomTypeNone;       
    uint32_t wallpaperIndex = 0;                                                 
};
 
class IProAVServiceSink
{
public:
    virtual ~IProAVServiceSink() {}
 
    virtual void OnProAVVideoOverlaySettingsNotification(const ProAVVideoOverlaySettings& settings) = 0;
    
    virtual void OnProAVUnassignedBehaviorNotification(const ProAVUnassignedBehavior& behavior) = 0;
    
    virtual void OnProAVVideoLossBehaviorNotification(const ProAVVideoLossBehavior& behavior) = 0;
};
 
class IDanteOutputHelper;
class IHWIOHelper;
 
class IProAVService
{
public:
    virtual ~IProAVService() {}
 
    virtual ZRCSDKError RegisterSink(IProAVServiceSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IProAVServiceSink* pSink) = 0;
 
    virtual IDanteOutputHelper* GetDanteOutputHelper() = 0;
 
    virtual IHWIOHelper* GetHWIOHelper() = 0;
 
    virtual ZRCSDKError GetProAVVideoOverlaySettings(ProAVVideoOverlaySettings& settings) = 0;
 
    virtual ZRCSDKError EnableProAVVideoActiveSpeakerGreenOutline(bool enable) = 0;
 
    virtual ZRCSDKError EnableProAVVideoReactionIcons(bool enable) = 0;
 
    virtual ZRCSDKError EnableProAVVideoRaiseHandIcon(bool enable) = 0;
    
    virtual ZRCSDKError EnableProAVVideoMuteIcon(bool enable) = 0;
        
    virtual ZRCSDKError EnableProAVVideoPollOverlay(bool enable) = 0;
 
    virtual ZRCSDKError EnableProAVVideoNameStrap(bool enable) = 0;
 
    virtual ZRCSDKError SetProAVVideoNameStrapPosition(ProAVVideoNameStrapPosition position) = 0;
    
    virtual ZRCSDKError SetProAVGalleryDistributionMode(ProAVGalleryDistributionMode mode) = 0;
    
    virtual ZRCSDKError SetProAVMaxGalleryPageCount(uint32_t count) = 0;
    
    virtual ZRCSDKError SetProAVVideoElementScale(float scale) = 0;
    
    virtual ZRCSDKError SetProAVUnassignedBehavior(const ProAVUnassignedBehavior& behavior) = 0;
 
    virtual ZRCSDKError GetProAVUnassignedBehavior(ProAVUnassignedBehavior& behavior) = 0;
 
    virtual ZRCSDKError SetProAVVideoLossBehavior(const ProAVVideoLossBehavior& behavior) = 0;
 
    virtual ZRCSDKError GetProAVVideoLossBehavior(ProAVVideoLossBehavior& behavior) = 0;
};
 
 
NS_ZRCSDK_END
 
#endif    // ZRC_IPROAVSERVICE_H