Encoder.h

Go to the documentation of this file.

// Copyright (c) 2016 Digital Barriers

#pragma once

#include "EdgeVisSDK.h"
#include "IAsset.h"
#include "Stream.h"
#include "StreamTypes.h"
#include "Camera.h"
#include "EncoderStatusInfo.h"
#include "EncoderInfo.h"
#include "SensorInfo.h"
#include "FeatureInfo.h"
#include "EncoderCapabilities.h"
#include "OpResult.h"
#include "DeepSleepManager.h"

#include <vector>

namespace EdgeVisDecoderSDK
{
  class EncoderImpl;
  class Server;
  class Stream;
  class MediaStream;
  class AnalyticsStream;
  class EncoderSettings;
  class IEncoderListener;
  class AlarmManagement;
  class PTZStream;
  class PassThruStream;
  class Service;
  class ArchiveService;
  class FullResService;
  class EncoderEvents;
  class SecureConnectProxyService;

  class Encoder : public IAsset, public EdgeVisSDKPimpl<EncoderImpl>
  {
  private:
    friend class EncoderImpl;

  public:
    DB_EDGEVIS_SDK Encoder();
    EdgeVisSDKPimplWeakConstructor(Encoder);
    DB_EDGEVIS_SDK virtual ~Encoder();

    DB_EDGEVIS_SDK virtual Server GetServer() const;
    
    DB_EDGEVIS_SDK bool IsConnectedToServer() const;

    DB_EDGEVIS_SDK std::wstring TimezoneID() const;

    DB_EDGEVIS_SDK std::wstring Location() const;
    
    DB_EDGEVIS_SDK int32_t MaxBandwidth() const;
    
    DB_EDGEVIS_SDK int32_t MinBandwidth() const;
    
    DB_EDGEVIS_SDK std::wstring OS() const;
    
    DB_EDGEVIS_SDK int64_t LastConnectDisconnectTime() const;
    
    DB_EDGEVIS_SDK int64_t DeepSleepWakeTime() const;
    
    DB_EDGEVIS_SDK int64_t DeepSleepNextCheckInTime() const;
    
    DB_EDGEVIS_SDK int64_t ResumeSleepTime() const;

    DB_EDGEVIS_SDK EncoderInfo GetEncoderInfo();

    typedef std::vector< Stream > StreamsList;
    
    DB_EDGEVIS_SDK StreamsList GetStreams() const;
    
    DB_EDGEVIS_SDK MediaStream GetMediaStream() const;
    
    DB_EDGEVIS_SDK AnalyticsStream GetAnalyticsStream() const;
    
    DB_EDGEVIS_SDK PTZStream GetPTZStream() const;
    
    DB_EDGEVIS_SDK PassThruStream GetPassThruStream() const;
    
    DB_EDGEVIS_SDK ArchiveService GetArchiveService() const;
    
    DB_EDGEVIS_SDK FullResService GetFullResService() const;
    
    DB_EDGEVIS_SDK SecureConnectProxyService GetSecureConnectProxyService() const;
    
    DB_EDGEVIS_SDK Stream GetStream( const std::wstring& name ) const;
    
    DB_EDGEVIS_SDK Stream GetStream( StreamType type ) const;
    
    DB_EDGEVIS_SDK EncoderSettings Settings() const;
    
    typedef std::vector< Camera > CameraList;
    
    DB_EDGEVIS_SDK OpResult Cameras(CameraList & result, bool include_virtual = true) const;
    
    DB_EDGEVIS_SDK OpResult GetCamera( Camera & result, int32_t inputId ) const;
    
    DB_EDGEVIS_SDK OpResult GetCurrentCamera(Camera & result) const;

    DB_EDGEVIS_SDK int32_t SensorColour() const;
    
    DB_EDGEVIS_SDK OpResult SetSensorColour(int32_t rgb);

    DB_EDGEVIS_SDK std::vector< SensorInfo > Sensors() const;
    
    DB_EDGEVIS_SDK OpResult SetSensor( std::wstring sensor_id, const std::wstring& friendly_name, const double lat, const double lon );

    DB_EDGEVIS_SDK OpResult SetSensor(std::wstring sensor_id, const std::wstring & friendly_name, const double lat, const double lon, const SensorModel model);
    
    DB_EDGEVIS_SDK OpResult RemoveSensor( std::wstring sensor_id );
    
    DB_EDGEVIS_SDK OpResult RemoveAllSensors();
    
    DB_EDGEVIS_SDK void RegisterListener( IEncoderListener* listener );
    
    DB_EDGEVIS_SDK void UnregisterListener( IEncoderListener* listener );
        
    DB_EDGEVIS_SDK OpResult QueryStatus( 
      std::vector< EncoderStatusInfo >& result,
      const std::wstring typeFilter = L"",
      bool all = false,
      int64_t startTime = 0,
      int64_t endTime = 0
      );
    
    DB_EDGEVIS_SDK OpResult QueryEvents(
      EncoderEvents & result,
      const std::wstring typeFilter = L"",
      int64_t startTime = 0,
      int64_t endTime = 0
      );
    
    DB_EDGEVIS_SDK OpResult QueryFeatures(std::vector< FeatureInfo >& result);

    DB_EDGEVIS_SDK bool GetFeature(std::wstring featureName, FeatureInfo& feature);

    DB_EDGEVIS_SDK bool HasFeatureAvailable(std::wstring featureName, int32_t timeout = 0);

    DB_EDGEVIS_SDK int32_t GetFeatureLicenceCount(std::wstring featureName);

    DB_EDGEVIS_SDK int32_t MaxLicencedHeight();

    DB_EDGEVIS_SDK int32_t MinLicencedFrameStep();

    DB_EDGEVIS_SDK int32_t MaxSupportedHeight();
    
    DB_EDGEVIS_SDK OpResult QueryDeepSleepTime(int64_t& wakeTime);
    
    DB_EDGEVIS_SDK OpResult SetDeepSleepTime( const int64_t newTime );
    
    
    DB_EDGEVIS_SDK OpResult SetResumeSleepTime( const int64_t newTime );
    
    DB_EDGEVIS_SDK OpResult PostponeDeepSleep( int32_t timeMins );
    
    DB_EDGEVIS_SDK void RequestKeyFrame();


  public:
    //
    // IAsset members
    //
    
    DB_EDGEVIS_SDK virtual std::wstring Name() const;

    DB_EDGEVIS_SDK virtual std::wstring QualifiedName() const;
      
    DB_EDGEVIS_SDK virtual std::wstring UniqueID() const;

    DB_EDGEVIS_SDK virtual std::wstring DeviceID() const;

    DB_EDGEVIS_SDK virtual std::wstring Version() const;
    
    DB_EDGEVIS_SDK virtual std::wstring Domain() const;
    
    DB_EDGEVIS_SDK virtual std::wstring Groups() const;

  public:
    
    DB_EDGEVIS_SDK bool CheckEncoderVersion( int32_t majorVer ) const;
    
    DB_EDGEVIS_SDK OpResult CheckEncoderVersionEx( const std::wstring& model );

    
    DB_EDGEVIS_SDK std::wstring GetManagerURL();
    
    DB_EDGEVIS_SDK int64_t GetTotalBytesSent();

    DB_EDGEVIS_SDK int64_t GetTotalBytesReceived();

    DB_EDGEVIS_SDK void ResetDataUsageStats();


    DB_EDGEVIS_SDK OpResult QueryEncoderCapabilities(EncoderCapabilities & capabilities);

    DB_EDGEVIS_SDK std::wstring GetCAMSRuleManagerURL();

    DB_EDGEVIS_SDK OpResult Reboot();

    DB_EDGEVIS_SDK DeepSleepManager GetDeepSleepManager() const;

    DB_EDGEVIS_SDK int32_t GetStreamIndex() const;
  };
}