ICameraControlHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_ICAMERACONTROLHELPER_H
#define ZRC_ICAMERACONTROLHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
struct SpeakerSwitchingSettingsInfo
{
    bool    enabledOnWeb = false;    
    bool    enabledOnZR = false;     
    int32_t presetStartIndex = 0;    
};
 
struct CameraIntelligentZoomInfo
{
    std::string      deviceID;    
    SmartCameraMask  selectedSmartCameraMode = SmartCameraManualMask;    
    bool             canControlCamera = false;                           
    CameraPresetInfo presetInfo;                                         
};
 
struct FarEndCameraControlInfo
{
    CameraControlType   cameraControlType = CameraControlTypeStart;    
    int32_t             userID = 0;                                    
    std::string         userDisplayName;                               
    bool                remoteResponse = false;    
    CameraControlStatus cameraControlStatus;       
};
 
struct CameraPanTiltResult
{
    int32_t     result = 0;             
    std::string deviceID;               
    uint32_t    speedPercentage = 0;    
};
 
struct MirrorSelfVideoRes
{
    int32_t result = -1;            
    bool    isMirrored = false;     
    std::string deviceID;           
    std::string companionZRID;      
};
 
class ICameraControlHelperSink
{
public:
    virtual ~ICameraControlHelperSink() {}
 
    virtual void OnUpdateSpeakerSwitchingSettingsNotification(const SpeakerSwitchingSettingsInfo& info) = 0;
 
    virtual void OnEnableSpeakerSwitchingResult(int32_t result, bool speakerSwitchingEnabledOnZR) = 0;
 
    virtual void OnUpdateCameraIntelligentZoomNotification(const CameraIntelligentZoomInfo& info) = 0;
 
    virtual void OnUpdateMultiCameraEnabled(bool isMultiCameraEnabled) = 0;
 
    virtual void OnUpdateMaxMultiCameraCount(int32_t maxMultiCameraCount) = 0;
 
    virtual void OnUpdateMainCameraControlInfo(const CameraControlInfo& mainCameraControlInfo) = 0;
 
    virtual void OnUpdateMultiCameraControlInfos(const std::vector<CameraControlInfo>& multiCameraControlInfos) = 0;
 
    virtual void OnCameraPanTiltResult(const CameraPanTiltResult& result) = 0;
 
    virtual void OnUpdateMeetingUserCameraControlStatus(int32_t userID, const CameraControlStatus& cameraControlStatus) = 0;
 
    virtual void OnFarEndCameraControlNotification(const FarEndCameraControlInfo& cameraControlInfo) = 0;
 
    virtual void OnFarEndCameraCameraControlResult(int32_t result, CameraControlType type, bool accept) = 0;
 
    virtual void OnTreatedCameraControlRequestNotification(bool accepted, int32_t userID) = 0;
 
    virtual void OnMirrorVideoResult(const MirrorSelfVideoRes& response) = 0;
 
    virtual void OnUpdateCameraPresetInfo(const CameraPresetInfo& info) = 0;
};
 
class ICameraControlHelper
{
public:
    virtual ~ICameraControlHelper() {}
 
    virtual ZRCSDKError RegisterSink(ICameraControlHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(ICameraControlHelperSink* pSink) = 0;
 
    virtual ZRCSDKError EnableCompanionZRCamera(bool enable, bool isManuallySet, const std::string& companionZRID) = 0;
 
    virtual ZRCSDKError ControlLocalCamera(const std::string& deviceID, CameraControlAction action, CameraControlType type, const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError ControlShareCamera(const std::string& deviceID, CameraControlAction action, CameraControlType type) = 0;
 
    virtual ZRCSDKError ControlUserCamera(int32_t userID, CameraControlAction action, CameraControlType type) = 0;
 
    virtual ZRCSDKError RespondRemoteCameraControlFromUser(int32_t userID, bool accept) = 0;
 
    virtual ZRCSDKError UpdateLocalCameraPanTilt(uint32_t speedPercentage, const std::string& deviceID, const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError UpdateShareCameraPanTilt(uint32_t speedPercentage, const std::string& deviceID) = 0;
 
    virtual ZRCSDKError MirrorLocalVideo(bool mirrored, const std::string& deviceID, const std::string& companionZRID = "") = 0;
    virtual ZRCSDKError MirrorShareVideo(bool mirrored, const std::string& deviceID) = 0;
 
    virtual ZRCSDKError SetCameraPreset(uint32_t index, const std::string& deviceID, const std::string& companionZRID = "") = 0;
    virtual ZRCSDKError GoToCameraPreset(uint32_t index, const std::string& deviceID, const std::string& companionZRID = "") = 0;
    virtual ZRCSDKError NameCameraPreset(uint32_t index, const std::string& name, const std::string& deviceID, const std::string& companionZRID = "") = 0;
    virtual ZRCSDKError SetCameraDefaultPosition(uint32_t index, const std::string& deviceID, const std::string& companionZRID = "") = 0;
    virtual ZRCSDKError CancelCameraDefaultPosition(uint32_t index, const std::string& deviceID, const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError EnableSpeakerSwitching(bool enable) = 0;
 
    virtual ZRCSDKError SwitchCamera() = 0;
 
    virtual ZRCSDKError SwitchToCamera(const Device& camera) = 0;
 
    virtual ZRCSDKError SwitchUserCamera(int32_t userID) = 0;
 
    virtual ZRCSDKError GetCameraIntelligentStatus(const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError ChangeSmartCameraMode(SmartCameraMask mask, const std::string& deviceID, const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError CanEnableCameraBoundaryInCurrentSmartCameraMode(bool& canEnable) = 0;
 
    virtual ZRCSDKError EnableCameraBoundaryInCurrentSmartCameraMode(bool isEnable) = 0;
 
    virtual ZRCSDKError OpenMultipleCamera(const std::string& deviceID, bool open, const std::string& companionZRID = "") = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_ICAMERACONTROLHELPER_H