Skip to content

cvedia::rt::iface::SecuRT

Inherits from SolutionManager, std::enable_shared_from_this< SolutionManager >

Public Types

Name
enum Classes
enum class AttributesExtractionClass
enum AreaEvent
enum class PpeState
enum Direction
enum AnalyticsCategory
enum PerformanceProfile
enum class FeatureExtractionType

Public Functions

Name
virtual ~SecuRT() =default
virtual std::string getAnalyticsEntities(AnalyticsCategory category) const =0
virtual std::string getExclusionAreas() const =0
virtual std::unordered_set< std::string > getAreaIds() const =0
virtual std::unordered_set< std::string > getLineIds() const =0
virtual NODISCARD bool createCrossingArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::unordered_set< Classes > const & classes, bool ignoreStationaryObjects, AreaEvent type, std::array< double, 4 > const & color, std::string const & filtersJson ="") const =0
virtual NODISCARD bool createIntrusionArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::unordered_set< Classes > const & classes, std::array< double, 4 > const & color, std::string const & filtersJson ="") const =0
virtual NODISCARD bool createCrowdEstimationArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createOccupancyArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::unordered_set< Classes > const & classes, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createCountingLine(std::string const & id, std::string const & name, std::vector< Point2f > const & linePoints, std::unordered_set< Classes > const & classes, Direction dir, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createDwellingArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::unordered_set< Classes > const & classes, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createLoiteringArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::unordered_set< Classes > const & classes, int seconds, std::array< double, 4 > const & color, std::string const & filtersJson ="") const =0
virtual NODISCARD bool createCrowdingArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::unordered_set< Classes > const & classes, int objectCnt, int seconds, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createLineCrossing(std::string const & id, std::string const & name, std::vector< Point2f > const & linePoints, std::unordered_set< Classes > const & classes, Direction dir, std::array< double, 4 > const & color, std::string const & filtersJson ="") const =0
virtual NODISCARD bool createSpeedLines(std::string const & idA, std::string const & idB, std::string const & name, std::vector< Point2f > const & linePointsA, std::vector< Point2f > const & linePointsB, float distance, std::unordered_set< Classes > const & classes, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createArmedPersonArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createObjectLeftArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, int seconds, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createObjectRemovedArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, int seconds, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createTailgatingLine(std::string const & id, std::string const & name, std::vector< Point2f > const & linePoints, std::unordered_set< Classes > const & classes, int seconds, Direction dir, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createFallenPersonArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createVehicleGuardArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createPpeArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, PpeState headState, PpeState vestState, int duration, std::array< double, 4 > const & color) const =0
virtual NODISCARD bool createLicensePlateArea(std::string const & id, std::string const & name, std::vector< Point2f > const & area, std::array< double, 4 > const & color) const =0
virtual std::string getArea(std::string const & id) const =0
virtual NODISCARD bool hasArea(std::string const & id) const =0
virtual NODISCARD bool deleteArea(std::string const & id) const =0
virtual NODISCARD bool deleteAllAreas() const =0
virtual NODISCARD std::unordered_set< AttributesExtractionClass > getAttributesExtraction() const =0
virtual NODISCARD bool setAttributesExtraction(std::unordered_set< AttributesExtractionClass > const & classes) const =0
virtual NODISCARD std::unordered_set< FeatureExtractionType > getFeatureExtraction() const =0
virtual NODISCARD bool setFeatureExtraction(std::unordered_set< FeatureExtractionType > const & types) =0
virtual std::string getLine(std::string const & id) const =0
virtual NODISCARD bool hasLine(std::string const & id) const =0
virtual NODISCARD bool deleteLine(std::string const & id) const =0
virtual NODISCARD bool deleteAllLines() const =0
virtual NODISCARD PerformanceProfile getPerformanceProfile() const =0
virtual NODISCARD bool setPerformanceProfile(cvedia::rt::iface::SecuRT::PerformanceProfile profile) =0
virtual NODISCARD bool addExclusionArea(std::vector< Point2f > const & area, std::unordered_set< Classes > const & classes) =0
virtual NODISCARD bool deleteExclusionAreas() =0
virtual NODISCARD bool setMaskingAreas(std::vector< std::vector< Point2f > > const & areas) =0
virtual NODISCARD bool setMotionArea(std::vector< Point2f > const & mask) =0
virtual void calculateMotionMask() const =0
virtual void enableVehicleClassification() const =0
virtual bool getSmokeOrFireAnalytics() const =0
virtual bool setSmokeOrFireAnalytics(bool enable) const =0
virtual bool getPipMode() const =0
virtual bool setPipMode(bool state) =0

Additional inherited members

Public Types inherited from SolutionManager

Name
enum uint8_t RawFrameType
enum uint8_t EncodingType

Public Functions inherited from SolutionManager

Name
std::optional< Codec > encodingTypeToCodec(EncodingType encodingType)
virtual ~SolutionManager() =default
virtual Uuid getInstanceUuid() const =0
virtual std::string getInstanceName() const =0
virtual std::string getVersion() const =0
virtual int64_t getStartTime() const =0
virtual int getTrackCount() const =0
virtual int getRecentMaxTracks() const =0
virtual int getInputQueueSize() const =0
virtual uint64_t getFramesProcessed() const =0
virtual int getDroppedFramesCount() const =0
virtual float getLatency() const =0
virtual float getCurrentFrameRate() const =0
virtual float getAppSrcFramerate() const =0
virtual std::optional< Codec > getInputCodec() const =0
virtual InstanceStatistics getInstanceStatistics() const =0
virtual std::string getInputResolution() const =0
virtual std::string getInputFormat() const =0
virtual float getInputFramerate() const =0
virtual float getActualFramerate() const =0
virtual void setFrameRateLimit(int frameRateLimit) =0
virtual int getFrameRateLimit() const =0
virtual void setInputPixelLimit(int pixels) =0
virtual int getInputPixelLimit() const =0
virtual int getRecommendedFrameRate() const =0
virtual bool needData(std::chrono::milliseconds const currentFrameTime) =0
virtual expected< void > pushRawFrame(const rt::cbuffer & image) =0
virtual expected< void > pushRawFrame(void const * buffer, int width, int height, RawFrameType type, std::chrono::milliseconds timestamp) =0
virtual expected< void > pushEncodedFrame(unsigned char const * data, size_t dataSize, EncodingType type, std::chrono::milliseconds timestamp) =0
virtual std::unique_ptr< solution::Event > consumeEvents() =0
virtual std::vector< std::unique_ptr< solution::Event > > consumeAllEvents() =0
virtual std::set< std::string > getInternalSchemaEventTypes() const =0
virtual expected< void > submitSchemaEvents(std::vector< solution::SchemaEvent > events) =0
virtual void setMetadataMode(bool enable) =0
virtual void setStatisticsMode(bool enable) =0
virtual void setDiagnosticsMode(bool enable) =0
virtual void setDebugMode(bool enableDebug) =0
virtual bool getMetadataMode() const =0
virtual bool getStatisticsMode() const =0
virtual bool getDiagnosticsMode() const =0
virtual bool getDebugMode() const =0
virtual void setTentativeTracks(bool enable) const =0
virtual bool getTentativeTracks() const =0
virtual bool isDebugMode() const =0
virtual bool isMetadataEnabled() const =0
virtual bool isStatisticsEnabled() const =0
virtual bool isDiagnosticsEnabled() const =0
virtual std::string getConfigurationFile() const =0
virtual bool setInputToManual() =0
virtual bool setInputToRtsp(std::string const & rtspUri) =0
virtual bool setInputOrientation(int orientation) =0
virtual int getInputOrientation() const =0
virtual std::string enableHlsOutput() =0
virtual bool disableHlsOutput() =0
virtual bool enableRtspOutput(std::string const & uri) =0
virtual bool disableRtspOutput(std::string const & uri) =0
virtual bool setRenderPreset(std::string const & preset) =0
virtual void setBlockingReadaheadQueue(bool enable) =0
virtual expected< void > attachToInstanceController(iface::InstanceController *const instanceController) =0
virtual void setupCallbacks() =0
virtual void removeCallbacks() =0
virtual pCValue getConfigValue(std::string const & path) const =0
virtual bool setStateValue(std::string const & path, CValue value) const =0
virtual expected< bool > setConfigValue(std::string const & path, CValue value) const =0
virtual expected< bool > setConfigValues(std::vector< std::pair< std::string, CValue > > const & pathsToValues) const =0
virtual bool deleteStateValue(std::string const & path) const =0
virtual expected< bool > deleteConfigValue(std::string const & path) const =0
virtual expected< bool > deleteConfigValues(std::vector< std::string > const & paths) const =0
virtual types::DetectorMode getDetectorMode() const =0
virtual void setDetectorMode(types::DetectorMode mode) const =0
virtual types::Modality getSensorModality() const =0
virtual void setSensorModality(types::Modality const modality) const =0
virtual types::Sensitivity getDetectionSensitivity() const =0
virtual void setDetectionSensitivity(types::Sensitivity mode) const =0
virtual types::Sensitivity getMovementSensitivity() const =0
virtual void setMovementSensitivity(types::Sensitivity mode) const =0
virtual nlohmann::json extractInfo() const =0
virtual void pushStatisticsEvent() =0
virtual bool isOverloaded() =0
virtual uint64_t getEventsEmitted() const =0

Protected Functions inherited from SolutionManager

Name
virtual bool load() =0
virtual bool unload() =0
virtual void setRecommendedFrameRate(int fps) const =0
virtual bool _loadInstanceCallback() =0
virtual bool _unloadInstanceCallback() =0
virtual expected< void > _handleInput() =0
virtual iface::InstanceController * getInstanceController() const =0
virtual iface::InstanceController * getInstanceController() =0
virtual std::shared_ptr< iface::Instance > getInstance() const =0
virtual std::shared_ptr< iface::Instance > getInstance() =0
virtual std::shared_ptr< iface::Solution > getSolution() const =0
virtual std::shared_ptr< iface::Solution > getSolution() =0
virtual void setInstanceController(iface::InstanceController *const instanceController) =0

Friends inherited from SolutionManager

Name
class ::cvedia::rt::InstanceControllerImpl

Public Types Documentation

enum Classes

Enumerator Value Description
Person 1
Animal 2
Vehicle 3
Face 4
Unknown 5

enum AttributesExtractionClass

Enumerator Value Description
Person 1
Animal 2
Vehicle 3

enum AreaEvent

Enumerator Value Description
Enter 1
Exit 2
EnterExit 3

enum PpeState

Enumerator Value Description
Ignored 0
Present 1
Absent 2

enum Direction

Enumerator Value Description
Up 1
Down 2
Both 3

enum AnalyticsCategory

Enumerator Value Description
All 1
Line 2
Area 3

enum PerformanceProfile

Enumerator Value Description
Performance 0
Balanced 1
Accurate 2

enum FeatureExtractionType

Enumerator Value Description
Face 1
Person 2
Vehicle 3

Public Functions Documentation

function ~SecuRT

virtual ~SecuRT() =default

function getAnalyticsEntities

virtual std::string getAnalyticsEntities(
    AnalyticsCategory category
) const =0

function getExclusionAreas

virtual std::string getExclusionAreas() const =0

function getAreaIds

virtual std::unordered_set< std::string > getAreaIds() const =0

function getLineIds

virtual std::unordered_set< std::string > getLineIds() const =0

function createCrossingArea

virtual NODISCARD bool createCrossingArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::unordered_set< Classes > const & classes,
    bool ignoreStationaryObjects,
    AreaEvent type,
    std::array< double, 4 > const & color,
    std::string const & filtersJson =""
) const =0

function createIntrusionArea

virtual NODISCARD bool createIntrusionArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::unordered_set< Classes > const & classes,
    std::array< double, 4 > const & color,
    std::string const & filtersJson =""
) const =0

function createCrowdEstimationArea

virtual NODISCARD bool createCrowdEstimationArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::array< double, 4 > const & color
) const =0

function createOccupancyArea

virtual NODISCARD bool createOccupancyArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::unordered_set< Classes > const & classes,
    std::array< double, 4 > const & color
) const =0

function createCountingLine

virtual NODISCARD bool createCountingLine(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & linePoints,
    std::unordered_set< Classes > const & classes,
    Direction dir,
    std::array< double, 4 > const & color
) const =0

function createDwellingArea

virtual NODISCARD bool createDwellingArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::unordered_set< Classes > const & classes,
    std::array< double, 4 > const & color
) const =0

function createLoiteringArea

virtual NODISCARD bool createLoiteringArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::unordered_set< Classes > const & classes,
    int seconds,
    std::array< double, 4 > const & color,
    std::string const & filtersJson =""
) const =0

function createCrowdingArea

virtual NODISCARD bool createCrowdingArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::unordered_set< Classes > const & classes,
    int objectCnt,
    int seconds,
    std::array< double, 4 > const & color
) const =0

function createLineCrossing

virtual NODISCARD bool createLineCrossing(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & linePoints,
    std::unordered_set< Classes > const & classes,
    Direction dir,
    std::array< double, 4 > const & color,
    std::string const & filtersJson =""
) const =0

function createSpeedLines

virtual NODISCARD bool createSpeedLines(
    std::string const & idA,
    std::string const & idB,
    std::string const & name,
    std::vector< Point2f > const & linePointsA,
    std::vector< Point2f > const & linePointsB,
    float distance,
    std::unordered_set< Classes > const & classes,
    std::array< double, 4 > const & color
) const =0

function createArmedPersonArea

virtual NODISCARD bool createArmedPersonArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::array< double, 4 > const & color
) const =0

function createObjectLeftArea

virtual NODISCARD bool createObjectLeftArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    int seconds,
    std::array< double, 4 > const & color
) const =0

function createObjectRemovedArea

virtual NODISCARD bool createObjectRemovedArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    int seconds,
    std::array< double, 4 > const & color
) const =0

function createTailgatingLine

virtual NODISCARD bool createTailgatingLine(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & linePoints,
    std::unordered_set< Classes > const & classes,
    int seconds,
    Direction dir,
    std::array< double, 4 > const & color
) const =0

function createFallenPersonArea

virtual NODISCARD bool createFallenPersonArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::array< double, 4 > const & color
) const =0

function createVehicleGuardArea

virtual NODISCARD bool createVehicleGuardArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::array< double, 4 > const & color
) const =0

function createPpeArea

virtual NODISCARD bool createPpeArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    PpeState headState,
    PpeState vestState,
    int duration,
    std::array< double, 4 > const & color
) const =0

function createLicensePlateArea

virtual NODISCARD bool createLicensePlateArea(
    std::string const & id,
    std::string const & name,
    std::vector< Point2f > const & area,
    std::array< double, 4 > const & color
) const =0

function getArea

virtual std::string getArea(
    std::string const & id
) const =0

function hasArea

virtual NODISCARD bool hasArea(
    std::string const & id
) const =0

function deleteArea

virtual NODISCARD bool deleteArea(
    std::string const & id
) const =0

function deleteAllAreas

virtual NODISCARD bool deleteAllAreas() const =0

function getAttributesExtraction

virtual NODISCARD std::unordered_set< AttributesExtractionClass > getAttributesExtraction() const =0

function setAttributesExtraction

virtual NODISCARD bool setAttributesExtraction(
    std::unordered_set< AttributesExtractionClass > const & classes
) const =0

function getFeatureExtraction

virtual NODISCARD std::unordered_set< FeatureExtractionType > getFeatureExtraction() const =0

function setFeatureExtraction

virtual NODISCARD bool setFeatureExtraction(
    std::unordered_set< FeatureExtractionType > const & types
) =0

function getLine

virtual std::string getLine(
    std::string const & id
) const =0

function hasLine

virtual NODISCARD bool hasLine(
    std::string const & id
) const =0

function deleteLine

virtual NODISCARD bool deleteLine(
    std::string const & id
) const =0

function deleteAllLines

virtual NODISCARD bool deleteAllLines() const =0

function getPerformanceProfile

virtual NODISCARD PerformanceProfile getPerformanceProfile() const =0

function setPerformanceProfile

virtual NODISCARD bool setPerformanceProfile(
    cvedia::rt::iface::SecuRT::PerformanceProfile profile
) =0

function addExclusionArea

virtual NODISCARD bool addExclusionArea(
    std::vector< Point2f > const & area,
    std::unordered_set< Classes > const & classes
) =0

function deleteExclusionAreas

virtual NODISCARD bool deleteExclusionAreas() =0

function setMaskingAreas

virtual NODISCARD bool setMaskingAreas(
    std::vector< std::vector< Point2f > > const & areas
) =0

function setMotionArea

virtual NODISCARD bool setMotionArea(
    std::vector< Point2f > const & mask
) =0

function calculateMotionMask

virtual void calculateMotionMask() const =0

function enableVehicleClassification

virtual void enableVehicleClassification() const =0

function getSmokeOrFireAnalytics

virtual bool getSmokeOrFireAnalytics() const =0

function setSmokeOrFireAnalytics

virtual bool setSmokeOrFireAnalytics(
    bool enable
) const =0

function getPipMode

virtual bool getPipMode() const =0

function setPipMode

virtual bool setPipMode(
    bool state
) =0