EncoderCapabilities.h

Go to the documentation of this file.

// Copyright (c) 2018 Digital Barriers

#pragma once
#include "EdgeVisSDK.h"
#include "Pimpl.h"

#include "VideoAnalyticsConfig.h"

namespace EdgeVisDecoderSDK
{
    class EncoderCapabilitiesImpl;

    class EncoderCapabilities : public EdgeVisSDKPimpl<EncoderCapabilitiesImpl>
    {
    public:
        DB_EDGEVIS_SDK EncoderCapabilities();
        EdgeVisSDKPimplWeakConstructor(EncoderCapabilities);

        DB_EDGEVIS_SDK int8_t SupportedPTZProtocolVersion() const;

        DB_EDGEVIS_SDK bool PTZProtocolSupportsMove(const std::wstring& protocol) const;

        DB_EDGEVIS_SDK int32_t PTZProtocolMaxPresets(const std::wstring& protocol) const;

        DB_EDGEVIS_SDK bool PTZEncoderStoredPresets() const;

        DB_EDGEVIS_SDK bool SupportsWebVideoAnalyticsConfig() const;

        DB_EDGEVIS_SDK int32_t GetVideoAnalyticsConfigVersion() const;

        DB_EDGEVIS_SDK bool SupportsVideoAnalyticsConfig() const;

        DB_EDGEVIS_SDK bool VPTZSupportsMove() const;

        DB_EDGEVIS_SDK bool SupportsWebPTZ() const;

        DB_EDGEVIS_SDK bool SupportsWebVPTZ() const;

        DB_EDGEVIS_SDK int8_t SupportedWebPTZProtocolVersion() const;

        DB_EDGEVIS_SDK int8_t RelayCount() const;

        DB_EDGEVIS_SDK bool SupportsRDCSensors() const;

        DB_EDGEVIS_SDK bool Supports7TechSensors() const;

        DB_EDGEVIS_SDK bool SupportsQualTronSensors() const;

        DB_EDGEVIS_SDK bool SupportsReboot() const;

        DB_EDGEVIS_SDK bool SupportsIridium() const;

        DB_EDGEVIS_SDK bool SupportsSafeZone2D() const;

        DB_EDGEVIS_SDK int8_t GetSafeZone2DVersion() const;

        DB_EDGEVIS_SDK int8_t GetVideoAnalyticsVersion() const;

        DB_EDGEVIS_SDK bool SupportsSafeZoneAI() const;

        DB_EDGEVIS_SDK std::vector<std::pair<int32_t, int32_t>> GetStreamingDimensions() const;

        DB_EDGEVIS_SDK std::vector<int32_t> GetStreamingTargetHeights() const;

        DB_EDGEVIS_SDK std::vector<std::wstring> GetStreamingDimensionsStrings() const;

        DB_EDGEVIS_SDK std::wstring GetStreamingFrameHeightString(const int32_t height) const;

        DB_EDGEVIS_SDK std::vector<int32_t> GetStreamingFrameSteps(const std::pair<int32_t, int32_t>& dims) const;

        DB_EDGEVIS_SDK std::vector<int32_t> GetStreamingFrameSteps(const int32_t height) const;

        DB_EDGEVIS_SDK int32_t GetMinStreamingFrameStep(const std::pair<int32_t, int32_t>& dims) const;

        DB_EDGEVIS_SDK int32_t GetMinStreamingFrameStep(const int32_t height) const;

        DB_EDGEVIS_SDK std::wstring GetStreamingFrameStepString(const int32_t frame_step) const;

        DB_EDGEVIS_SDK std::vector<int32_t> GetStreamingAudioQualityValues() const;

        DB_EDGEVIS_SDK std::vector<std::wstring> GetStreamingAudioQualityStrings() const;

        DB_EDGEVIS_SDK int32_t GetStreamingAudioQualityValue(const std::wstring& audio_name) const;

        DB_EDGEVIS_SDK std::wstring GetStreamingAudioQualityString(const int32_t audio_quality) const;

        DB_EDGEVIS_SDK std::vector<int32_t> GetBandwidthShareValues() const;

        DB_EDGEVIS_SDK std::vector<std::wstring> GetBandwidthShareStrings() const;

        DB_EDGEVIS_SDK int32_t GetBandwidthShareValue(const std::wstring& bw_share_name) const;

        DB_EDGEVIS_SDK std::wstring GetBandwidthShareString(const int32_t bw_share_val) const;

        DB_EDGEVIS_SDK std::vector<std::wstring> GetCodecModeValues() const;

        DB_EDGEVIS_SDK std::vector<std::wstring> GetCodecModeStrings() const;

        DB_EDGEVIS_SDK std::wstring GetCodecModeValue(const std::wstring& mode_name) const;

        DB_EDGEVIS_SDK std::wstring GetCodecModeString(const std::wstring& mode_value) const;

        DB_EDGEVIS_SDK std::vector<std::wstring> GetAvailableStreamProfileIDs() const;

        DB_EDGEVIS_SDK std::wstring GetStreamProfileDisplayString(const std::wstring& id) const;

        DB_EDGEVIS_SDK bool StreamProfileIsPreset(const std::wstring& id) const;

        DB_EDGEVIS_SDK bool SupportsStreamConfig() const;

        DB_EDGEVIS_SDK bool SupportsBandwidthConfig() const;

        DB_EDGEVIS_SDK bool SupportsDynamicAudioQuality() const;

        DB_EDGEVIS_SDK bool SupportsGOPDownload() const;

        DB_EDGEVIS_SDK bool SupportsGOPTranscode() const;

        DB_EDGEVIS_SDK bool SupportsHighPriorityGOPDownload() const;

        DB_EDGEVIS_SDK bool SupportsHighPriorityCSXDownload() const;

        DB_EDGEVIS_SDK std::vector<std::string> GetAvailableVideoAnalytics() const;

        DB_EDGEVIS_SDK VideoAnalyticsConfig GetDefaultVideoAnalyticsConfig(const std::string& analytic_name) const;

        DB_EDGEVIS_SDK std::vector<VideoAnalyticsScenario> GetDefaultVideoAnalyticsScenarios() const;

        DB_EDGEVIS_SDK VideoAnalyticsScenario GetDefaultVideoAnalyticsScenario(const std::string& scenario_name) const;

        DB_EDGEVIS_SDK int32_t GetMaxCameras() const;

        DB_EDGEVIS_SDK int32_t GetMaxVideoStreams() const;

        DB_EDGEVIS_SDK std::wstring GetProductName() const;

        DB_EDGEVIS_SDK virtual ~EncoderCapabilities();

        DB_EDGEVIS_SDK bool IsConfigValid() const;
    };
}