INDIHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_INDIHELPER_H
#define ZRC_INDIHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum NDIResolution
{
    NDIResolutionUnknown = -1, 
    NDIResolution360p = 0,     
    NDIResolution720p,         
    NDIResolution1080p,        
};
 
enum NDIFrameRate
{
    NDIFrameRateUnknown = -1, 
    NDIFrameRate25fps = 0,  
    NDIFrameRate29_97fps,   
    NDIFrameRate30fps,      
    NDIFrameRate50fps,      
    NDIFrameRate59_94fps,   
    NDIFrameRate60fps,      
};
 
enum NDISourceType
{
    NDISourceTypeNone = 0,          
    NDISourceTypeActiveSpeaker,     
    NDISourceTypeUser,              
    NDISourceTypeShare,             
    NDISourceTypePinGroup,          
    NDISourceTypeSpotlightGroup,    
    NDISourceTypeGallery,           
};
 
struct NDIUsageSettings
{
    bool          isPersistentNDIEnabled = false;       
    bool          isPersistentNDILocked = false;        
    bool          isNDIEnabledForPreMeeting = false;    
    NDIResolution resolution = NDIResolutionUnknown;    
    NDIFrameRate  frameRate = NDIFrameRateUnknown;      
    std::vector<NDIResolution> supportedResolutionList; 
    std::vector<NDIFrameRate> supportedFrameRateList;   
    int32_t       outputCount = 12;                     
    int32_t       maxOutputCount = 12;                  
};
 
struct NDIGalleryGridSize
{
    uint32_t maxRows = 0;
    uint32_t maxColumns = 0;
};
 
struct NDISource
{
    NDISourceType    type = NDISourceTypeNone;              
    int32_t          sourceID = 0;                          
    ConfInstType     fromType = ConfInstTypeCurrentConf;    
    int32_t          sourceTypeIndex = 0;                   
    int32_t          shareSourceID = 0;                     
    NDIGalleryGridSize  gridSize;                           
};
 
struct NDIPinnedSource
{
    NDISource        source;    
    int32_t          index = 0; 
};
 
struct NDIUsageInfo
{
    bool                           ndiEnabled = false;          
    int32_t                        supportedCount = 0;          
    std::vector<NDIPinnedSource>   sources;                     
    int32_t                        galleryPageCount = -1;       
};
 
class INDIHelperSink
{
public:
    virtual ~INDIHelperSink() {}
 
    virtual void OnNDIUsageSettingsNotification(const NDIUsageSettings& settings) = 0;
 
    virtual void OnNDIUsageNotification(const NDIUsageInfo& ndiUsageInfo) = 0;
 
    virtual void OnNDIAvailableSourcesNotification(const std::vector<NDISource>& sources) = 0;
 
    virtual void OnNDIDeviceListNotification(const std::vector<Device>& devices) = 0;
    
    virtual void OnPersistentNDISourcesNotification(const std::vector<NDIPinnedSource>& sources) = 0;
};
 
class INDIHelper
{
public:
    virtual ~INDIHelper() {}
 
    virtual ZRCSDKError RegisterSink(INDIHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(INDIHelperSink* pSink) = 0;
 
    virtual ZRCSDKError SetNDIResolution(NDIResolution resolution) = 0;
 
    virtual ZRCSDKError SetNDIFrameRate(NDIFrameRate frameRate) = 0;
 
    virtual ZRCSDKError SetNDIEnableInPreMeeting(bool enable) = 0;
    
    virtual ZRCSDKError SetNDIOutputCount(int32_t outputCount) = 0;
 
    virtual ZRCSDKError GetAvailableNDISources(std::vector<NDISource>& sources) = 0;
 
    virtual ZRCSDKError GetNDIPinnedSources(std::vector<NDIPinnedSource>& sources) = 0;
 
    virtual ZRCSDKError PinNDI(const NDISource& source, int32_t index) = 0;
 
    virtual ZRCSDKError UnpinNDI(const NDISource& source, int32_t index) = 0;
 
    virtual ZRCSDKError GetNDIDeviceList(std::vector<Device>& devices) = 0;
 
    virtual ZRCSDKError AddPersistentNDISource(const NDISource& source, int32_t index) = 0;
 
    virtual ZRCSDKError RemovePersistentNDISource(int32_t index) = 0;
 
    virtual ZRCSDKError ListPersistentNDISources() = 0;
};
 
NS_ZRCSDK_END
 
#endif /* ZRC_INDIHELPER_H */