IBYODHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IBYODHELPER_H
#define ZRC_IBYODHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum BYODCapability
{
    BYODCapabilityBYOD = 0, 
    BYODCapabilityHDMI      
};
 
enum BYODModeStatus
{
    BYODModeStatusIDLE = 0,    
    BYODModeStatusPlugin,      
    BYODModeStatusInactive,    
    BYODModeStatusActive       
};
 
enum BYODAutoFramingStatus
{
    BYODAutoFramingStatusNone = 0,    
    BYODAutoFramingStatusOn,          
    BYODAutoFramingStatusOff          
};
 
enum BYODMicrophoneStatus
{
    BYODMicrophoneStatusNone = 0,    
    BYODMicrophoneStatusMuted,       
    BYODMicrophoneStatusUnmuted      
};
 
enum ActiveBYODAction
{
    ActiveBYODActionNone = 0,    
    ActiveBYODActionActive,      
    ActiveBYODActionInactive     
};
 
enum ActiveHDMIAction
{
    ActiveHDMIActionNone = 0,    
    ActiveHDMIActionActive,      
    ActiveHDMIActionInactive     
};
 
enum BYODManualOperateAction
{
    BYODManualOperateActionNone = 0,    
    BYODManualOperateActionEnter,       
    BYODManualOperateActionExit         
};
 
struct BYODModeInfo
{
    BYODModeStatus        status = BYODModeStatusIDLE;                      
    Device                cameraInfo;                                       
    BYODAutoFramingStatus autoFramingStatus = BYODAutoFramingStatusNone;    
    BYODMicrophoneStatus  microphoneStatus = BYODMicrophoneStatusNone;      
    int32_t               speakerVolume = -1;                               
    bool                  supportManuallyOperate = false;                   
    int32_t               capability = BYODCapabilityBYOD;                  
    bool                  isHDMIReady = false;                              
    bool                  supportEmergencyCall = false;                     
};
 
struct BYODModeResult
{
    int32_t                 result = 0;                                    
    ActiveBYODAction        byodAction = ActiveBYODActionNone;             
    ActiveHDMIAction        hdmiAction = ActiveHDMIActionNone;             
    BYODManualOperateAction manualAction = BYODManualOperateActionNone;    
};
 
class IBYODHelperSink
{
public:
    virtual ~IBYODHelperSink() {}
 
    virtual void OnBYODModeInfoNotification(const BYODModeInfo& info) = 0;
 
    virtual void OnBYODModeResult(const BYODModeResult& result) = 0;
 
    virtual void OnMakeEmergencyCallInBYODModeNotification(bool succeed) = 0;
};
 
class IBYODHelper
{
public:
    virtual ~IBYODHelper() {}
 
    virtual ZRCSDKError RegisterSink(IBYODHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IBYODHelperSink* pSink) = 0;
 
    virtual ZRCSDKError ActiveBYODMode() = 0;
 
     virtual ZRCSDKError ActiveHDMIShare() = 0;
 
    virtual ZRCSDKError DeactivateBYOD() = 0;
 
    virtual ZRCSDKError SetBYODCameraControl(CameraControlAction controlAction, CameraControlType controlType) = 0;
 
    virtual ZRCSDKError SetBYODAutoFramingOn(bool autoFramingOn) = 0;
 
    virtual ZRCSDKError SetBYODMicrophoneMuted(bool muted) = 0;
 
    virtual ZRCSDKError SetBYODSpeakerVolume(int32_t volume) = 0;
 
    virtual ZRCSDKError MakeEmergencyCallInBYODMode() = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_IBYODHELPER_H