Encoder.h

Go to the documentation of this file.

// Copyright (c) 2016 Digital Barriers

#pragma once

#include "Pimpl.h"
#include "EdgeVisSDK.h"
#include "ArchiveAudio.h"
#include "ArchivePlaybackManager.h"
#include "ArchiveRecordingState.h"
#include "ArchiveRecordMode.h"
#include "AreaOfInterestConfig.h"
#include "AspectRatios.h"
#include "PCMAudio.h"
#include "YCbCrFrame.h"
#include "IArchivePlaybackListener.h"
#include "IEncoderListener.h"
#include "IRemoteConfigListener.h"
#include "ServerAddresses.h"
#include "EncoderProfile.h"
#include "CameraProfile.h"
#include "SecureConnectEndpointInfo.h"
#include "LoggingLevel.h"
#include "StreamingProfile.h"
#include "StreamConfig.h"
#include "EncoderCapabilities.h"
#include "BandwidthConfig.h"
#include "RecordingProfile.h"

#include <vector>
#include <string>

namespace EdgeVisEncoderSDK
{
  typedef EdgeVisSDKCore::AreaOfInterestConfig AreaOfInterestConfig;
  typedef EdgeVisSDKCore::ServerAddresses ServerAddresses;
  typedef std::vector< CameraProfile > CameraProfilesList;

  class EncoderImpl;
  class Encoder : public EdgeVisSDKPimpl<EncoderImpl>
  {
  public:
    
    DB_EDGEVIS_SDK Encoder(const std::wstring& config_path, const std::wstring& product_name);
    
    EdgeVisSDKPimplWeakConstructor(Encoder);
    

    DB_EDGEVIS_SDK void Start();

    DB_EDGEVIS_SDK bool IsStarted() const;

    DB_EDGEVIS_SDK void Stop();

    DB_EDGEVIS_SDK void SetSerialNumber(const std::wstring& serialNumber);

    DB_EDGEVIS_SDK ServerLinkState GetServerState();
    
    DB_EDGEVIS_SDK ServerLinkError GetServerError();

    DB_EDGEVIS_SDK MediaStreamState GetStreamState();

    DB_EDGEVIS_SDK std::wstring ClientVersion();


    DB_EDGEVIS_SDK std::wstring GetAddress() const;

    DB_EDGEVIS_SDK void SetAddress(const std::wstring &address);
    
    DB_EDGEVIS_SDK std::wstring GetEncoderName() const;
    
    DB_EDGEVIS_SDK std::wstring GetPassword() const;
    
    DB_EDGEVIS_SDK void SetCredentials(const std::wstring &name, const std::wstring &password);

    DB_EDGEVIS_SDK std::wstring GetServerName() const;


    DB_EDGEVIS_SDK std::wstring GetServerVersion() const;
    

    DB_EDGEVIS_SDK void RegisterListener(IEncoderListener* listener);
    
    DB_EDGEVIS_SDK void UnregisterListener(IEncoderListener* listener);
    
    DB_EDGEVIS_SDK void RegisterArchivePlaybackListener(IArchivePlaybackListener* listener);
    
    DB_EDGEVIS_SDK void UnregisterArchivePlaybackListener(IArchivePlaybackListener* listener);

    DB_EDGEVIS_SDK void RegisterRemoteConfigListener(IRemoteConfigListener* listener);

    DB_EDGEVIS_SDK void UnregisterRemoteConfigListener(IRemoteConfigListener* listener);


    DB_EDGEVIS_SDK void EncodeYCbCrFrame(YCbCrFrame frame);

    DB_EDGEVIS_SDK void EncodePCMAudio(PCMAudio audio);

    DB_EDGEVIS_SDK void SetLocation(double lat, double lon, double accuracy, double altitude);


    DB_EDGEVIS_SDK EdgeVisSDKCore::AspectRatio GetEncodeAspectRatio();

    DB_EDGEVIS_SDK void SetEncodeAspectRatio(EdgeVisSDKCore::AspectRatio aspectRatio);
    

    DB_EDGEVIS_SDK std::vector<CameraProfile> GetCameraProfiles() const;

    DB_EDGEVIS_SDK void SetCameraProfiles(std::vector<CameraProfile> cameras);
    
    DB_EDGEVIS_SDK int8_t GetVideoInput() const;
    
    DB_EDGEVIS_SDK void SetVideoInput(int8_t input);
    
    DB_EDGEVIS_SDK bool GetAudioEnabled();
    
    DB_EDGEVIS_SDK void SetAudioEnabled(bool enable);
    
    DB_EDGEVIS_SDK bool GetAudioOnlyEnabled();

    DB_EDGEVIS_SDK void SetAudioOnlyEnabled(bool enable);

    DB_EDGEVIS_SDK bool GetGPSEnabled();

    DB_EDGEVIS_SDK void SetGPSEnabled(bool enable);

    DB_EDGEVIS_SDK AreaOfInterestConfig GetAreaOfInterestConfig(const int32_t input) const;

    DB_EDGEVIS_SDK bool SetAreaOfInterestConfig(const AreaOfInterestConfig& aoi);
    
    DB_EDGEVIS_SDK std::wstring GetTimezone();
    
    DB_EDGEVIS_SDK void SetTimezone(std::wstring timezone);

    DB_EDGEVIS_SDK std::wstring GetOperatorInfo();

    DB_EDGEVIS_SDK void SetOperatorInfo(const std::wstring& op);

    DB_EDGEVIS_SDK void ReportBatteryCharge(int32_t percent);


    DB_EDGEVIS_SDK void ReportCPUTemperature(double temp);


    DB_EDGEVIS_SDK void ReportCPUUsage(int32_t percent);


    DB_EDGEVIS_SDK EncoderCapabilities QueryEncoderCapabilities() const;


    DB_EDGEVIS_SDK bool GetArchiveRecordingEnabled();

    DB_EDGEVIS_SDK void SetArchiveRecordingEnabled(bool enable);

    DB_EDGEVIS_SDK std::wstring GetArchiveRecordingPath();

    DB_EDGEVIS_SDK void SetArchiveRecordingPath(const std::wstring &path);

    DB_EDGEVIS_SDK int32_t GetArchiveDiskQuota();

    DB_EDGEVIS_SDK void SetArchiveDiskQuota(int32_t quota);

    DB_EDGEVIS_SDK int32_t GetArchiveDiskFullAlarmThreshold();

    DB_EDGEVIS_SDK void SetArchiveDiskFullAlarmThreshold(int32_t threshold);

    DB_EDGEVIS_SDK ArchiveRecordMode GetArchiveRecordMode();

    DB_EDGEVIS_SDK void SetArchiveRecordMode(ArchiveRecordMode recordMode);

    DB_EDGEVIS_SDK int GetPreRecordBufferDuration();

    DB_EDGEVIS_SDK void SetPreRecordBufferDuration(int bufferDuration);

    DB_EDGEVIS_SDK int GetPostRecordBufferDuration();

    DB_EDGEVIS_SDK void SetPostRecordBufferDuration(int bufferDuration);

    DB_EDGEVIS_SDK bool IsPostRecording() const;

    DB_EDGEVIS_SDK int8_t GetArchiveDiskUsage();

    DB_EDGEVIS_SDK ArchiveRecordingState GetArchiveRecordingState();

    DB_EDGEVIS_SDK bool EraseArchiveRecordings();

    DB_EDGEVIS_SDK ArchivePlaybackManager GetArchivePlaybackManager();

    DB_EDGEVIS_SDK bool SetArchiveFileSize(int32_t file_size_mb);

    DB_EDGEVIS_SDK int32_t GetArchiveFileSize();

    DB_EDGEVIS_SDK bool SetArchiveFileDuration(int32_t file_duration_minutes);

    DB_EDGEVIS_SDK int32_t GetArchiveFileDuration();

    DB_EDGEVIS_SDK bool ConfigureArchiveRecordingProfile(RecordingProfile profile);

    DB_EDGEVIS_SDK RecordingProfile GetArchiveRecordingProfile() const;


    DB_EDGEVIS_SDK std::wstring GetCurrentProfile();
    
    DB_EDGEVIS_SDK void SetCurrentProfile(const std::wstring & profile_name);
    
    DB_EDGEVIS_SDK std::vector<EncoderProfile> GetProfiles() const;
    
    DB_EDGEVIS_SDK void SetProfile(EncoderProfile profile);
    

    DB_EDGEVIS_SDK int32_t SendBatteryEvent(int8_t percent);

    DB_EDGEVIS_SDK int32_t SendCameraConnectedEvent(int input);

    DB_EDGEVIS_SDK int32_t SendCameraDisconnectedEvent(int input);

    DB_EDGEVIS_SDK int32_t SendCameraConnectedEvent(std::wstring input_name);

    DB_EDGEVIS_SDK int32_t SendCameraDisconnectedEvent(std::wstring input_name);
    
    DB_EDGEVIS_SDK int32_t SendAlertStartEvent();

    DB_EDGEVIS_SDK int32_t SendAlertEndEvent();

    DB_EDGEVIS_SDK int32_t SendLowVoltageEvent(double voltage);

    DB_EDGEVIS_SDK int32_t SendHighVoltageEvent(double voltage);

    DB_EDGEVIS_SDK int32_t SendLowTemperatureEvent(double temp);

    DB_EDGEVIS_SDK int32_t SendHighTemperatureEvent(double temp);

    DB_EDGEVIS_SDK int32_t SendExternalTriggerEvent(int alarm_id);


    DB_EDGEVIS_SDK int32_t SendYardarmSensorEvent(const std::wstring& sensor_id, const std::wstring& friendly_name, bool holstered);


    DB_EDGEVIS_SDK int32_t SendYardarmBatteryEvent(const std::wstring& sensor_id, const std::wstring& friendly_name, int8_t percent);


    DB_EDGEVIS_SDK int32_t SendFaceDetectEvent(int input, std::wstring face_string, std::wstring metadata);


    DB_EDGEVIS_SDK bool IsArchiveRecordingLicenced();


    DB_EDGEVIS_SDK bool IsExternalCameraLicenced();


    DB_EDGEVIS_SDK long long GetTotalBytesSent();

    DB_EDGEVIS_SDK long long GetTotalBytesReceived();

    DB_EDGEVIS_SDK void ResetDataUsageStats();

    DB_EDGEVIS_SDK int GetCurrentBandwidth();

    DB_EDGEVIS_SDK int GetRoundTripTime();

    DB_EDGEVIS_SDK double GetPacketsSentPerSecond();

    DB_EDGEVIS_SDK double GetPacketLossPercentage();

    DB_EDGEVIS_SDK std::vector<SecureConnectEndpointInfo> GetSecureConnectEndpoints();

    DB_EDGEVIS_SDK bool SetSecureConnectEndpoints(std::vector<SecureConnectEndpointInfo> endpoints);

    DB_EDGEVIS_SDK int32_t GetKeepAlivePeriod();

    DB_EDGEVIS_SDK bool SetKeepAlivePeriod(int32_t keep_alive_period);

    DB_EDGEVIS_SDK void SetLoggingLevel(EdgeVisSDKCore::LoggingLevel level, const std::wstring& log_location);

    DB_EDGEVIS_SDK bool SupportsStreamConfig() const;

    DB_EDGEVIS_SDK EdgeVisSDKCore::StreamConfig GetStreamConfig() const;

    DB_EDGEVIS_SDK bool SetStreamConfig(const EdgeVisSDKCore::StreamConfig& stream_cfg);

    DB_EDGEVIS_SDK EdgeVisSDKCore::BandwidthConfig GetBandwidthConfig() const;

    DB_EDGEVIS_SDK bool SetBandwidthConfig(const EdgeVisSDKCore::BandwidthConfig& config);

    DB_EDGEVIS_SDK bool GetEnhancedCodecModeEnabled() const;

    DB_EDGEVIS_SDK void SetEnhancedCodecModeEnabled(bool enable);

  };
}