Managed Interface¶

The Managed interface provides a set of high-level API's to configure and control CVEDIA-RT and its plugins.

Namespaces¶

Name
cvedia::rt API for controlling the server and lifecycle management of runtime instances.

Classes¶

	Name
class	cvedia::rt::module::AmbaOutManaged Ambarella output plugin.
class	cvedia::rt::module::TrackerManaged Basic tracking functionality that tracks objects across multiple frames and provides temporal stability.
class	cvedia::rt::module::GStreamerWriterOutput Plugin for outputting streams.
class	cvedia::rt::InferenceManaged Universal interface for running inference on any of the supported chipsets as well as shaping the output of detectors, classifiers and regressors.
class	cvedia::rt::InstanceImpl API for interfacing with a specific runtime instance.
class	cvedia::module::JetsonUtilsManaged Post-processing plugins for applying jetsonutils and modifiers to images on the framebuffer stack.
class	cvedia::rt::module::MotionManagedImpl Motion detection plugin that acts on video feeds for identifying areas of interest.
class	cvedia::rt::module::MQTTEventActionHandler Plugin for storing images and structured data on disk.
class	cvedia::rt::module::MQTTInputHandler Plugin reading frames from MQTT networks.
class	cvedia::rt::module::MQTTManaged MQTT messaging protocol implementation for reading and writing data on a queue.
class	cvedia::rt::module::MQTTOutputHandler Plugin for outputting frames to MQTT networks.
class	cvedia::rt::module::RESTEventActionHandler Plugin for storing images and structured data on disk.
class	cvedia::rt::module::RESTHandler Plugin for storing images and structured data on disk.
class	cvedia::rt::module::RESTOutputHandler Plugin for outputting frames to REST networks.
class	cvedia::rt::module::TripwireManaged Interface for managing zones, tripwires and rules.
class	cvedia::rt::module::WriteDataEventActionHandler Plugin for storing images and structured data on disk.
class	cvedia::rt::module::WriteDataImpl Plugin for storing images and structured data on disk.
class	cvedia::rt::module::WriteDataOutputHandler Plugin for storing images and structured data on disk.
class	cvedia::rt::module::ZMQImpl ZMQ messaging protocol implementation for reading and writing data on a queue.
class	cvedia::rt::module::ZoneManaged Interface for managing zones.

Functions¶

	Name
std::unique_ptr< InferenceEngine >	create(std::string const & pluginName)
NODISCARD void *	getPtr() override
NODISCARD expected< pCValue >	runInference(cvec const & jobs) override
NODISCARD expected< void >	loadModelFromConfig() override
NODISCARD expected< void >	loadModel(std::string const & path) override
NODISCARD expected< void >	loadModel(std::string const & path, CValue & handlerConfig) override
NODISCARD expected< void >	setPoolSize(int poolSize) override
void	setBackendConfig(pCValue conf) override
NODISCARD expected< pCValue >	getCapabilities() override
NODISCARD expected< pCValue >	getModelConfig() override
ssize_t	inputBatchSize() override
ssize_t	inputWidth() override
ssize_t	inputHeight() override
ssize_t	inputChannels() override
std::vector< int >	inputShape() override
std::vector< int >	outputShape() override
expected< uCVDictRoot >	getStateDict() const override
expected< uCVDictRoot >	getConfigDict() const override
expected< std::shared_ptr< iface::InferenceHandler > >	getActiveHandler() const override
std::map< std::string, std::shared_ptr< ConfigDescriptor > >	getConfigDescriptors() const override
NODISCARD expected< std::pair< cbuffer, std::vector< cv::Rect2f > > >	packJobs(cvec const & jobs) override
NODISCARD expected< std::pair< cbuffer, std::vector< cv::Rect2f > > >	packJobs(cvec const & jobs, int width, int height) override
	MQTTInputHandler(std::string const & pluginName)
	~MQTTInputHandler() override =default
	MQTTInputHandler(MQTTInputHandler const & other) =delete
MQTTInputHandler &	operator=(MQTTInputHandler const & other) =delete
	MQTTInputHandler(MQTTInputHandler && other) =delete
MQTTInputHandler &	operator=(MQTTInputHandler && other) =delete
std::shared_ptr< iface::InputHandler >	create(std::string const & moduleName)
int	getCurrentFrameIndex() override
float	getCurrentFps(iface::FPSType =iface::FPSType::FPSType_TARGET) override
double	getCurrentTimestamp() override
bool	canRead() override
expected< void >	openUri(std::string const & uri) override
void	close() override
expected< void >	readConfig()
expected< cvec >	readFrame(bool ignore_skip_frame =false, cmap frameSettings ={}) override
std::vector< InputFormat >	getSupportedFormats() override
void	setSourceFormat(InputFormat fmt) override
InputFormat	getSourceFormat() override

Functions Documentation¶

function create¶

static std::unique_ptr< InferenceEngine > create(
    std::string const & pluginName
)

function getPtr¶

NODISCARD void * getPtr() override

function runInference¶

NODISCARD expected< pCValue > runInference(
    cvec const & jobs
) override

function loadModelFromConfig¶

NODISCARD expected< void > loadModelFromConfig() override

function loadModel¶

NODISCARD expected< void > loadModel(
    std::string const & path
) override

function loadModel¶

NODISCARD expected< void > loadModel(
    std::string const & path,
    CValue & handlerConfig
) override

function setPoolSize¶

NODISCARD expected< void > setPoolSize(
    int poolSize
) override

function setBackendConfig¶

void setBackendConfig(
    pCValue conf
) override

function getCapabilities¶

NODISCARD expected< pCValue > getCapabilities() override

function getModelConfig¶

NODISCARD expected< pCValue > getModelConfig() override

function inputBatchSize¶

ssize_t inputBatchSize() override

function inputWidth¶

ssize_t inputWidth() override

function inputHeight¶

ssize_t inputHeight() override

function inputChannels¶

ssize_t inputChannels() override

function inputShape¶

std::vector< int > inputShape() override

function outputShape¶

std::vector< int > outputShape() override

function getStateDict¶

expected< uCVDictRoot > getStateDict() const override

function getConfigDict¶

expected< uCVDictRoot > getConfigDict() const override

function getActiveHandler¶

expected< std::shared_ptr< iface::InferenceHandler > > getActiveHandler() const override

function getConfigDescriptors¶

std::map< std::string, std::shared_ptr< ConfigDescriptor > > getConfigDescriptors() const override

function packJobs¶

NODISCARD expected< std::pair< cbuffer, std::vector< cv::Rect2f > > > packJobs(
    cvec const & jobs
) override

function packJobs¶

NODISCARD expected< std::pair< cbuffer, std::vector< cv::Rect2f > > > packJobs(
    cvec const & jobs,
    int width,
    int height
) override

function MQTTInputHandler¶

MQTTInputHandler(
    std::string const & pluginName
)

function ~MQTTInputHandler¶

~MQTTInputHandler() override =default

function MQTTInputHandler¶

MQTTInputHandler(
    MQTTInputHandler const & other
) =delete

function operator=¶

MQTTInputHandler & operator=(
    MQTTInputHandler const & other
) =delete

function MQTTInputHandler¶

MQTTInputHandler(
    MQTTInputHandler && other
) =delete

function operator=¶

MQTTInputHandler & operator=(
    MQTTInputHandler && other
) =delete

function create¶

static std::shared_ptr< iface::InputHandler > create(
    std::string const & moduleName
)

function getCurrentFrameIndex¶

inline int getCurrentFrameIndex() override

Returns current position in video

function getCurrentFps¶

inline float getCurrentFps(
    iface::FPSType  =iface::FPSType::FPSType_TARGET
) override

function getCurrentTimestamp¶

inline double getCurrentTimestamp() override

function canRead¶

inline bool canRead() override

function openUri¶

expected< void > openUri(
    std::string const & uri
) override

function close¶

inline void close() override

function readConfig¶

expected< void > readConfig()

function readFrame¶

expected< cvec > readFrame(
    bool ignore_skip_frame =false,
    cmap frameSettings ={}
) override

function getSupportedFormats¶

inline std::vector< InputFormat > getSupportedFormats() override

function setSourceFormat¶

inline void setSourceFormat(
    InputFormat fmt
) override

function getSourceFormat¶

inline InputFormat getSourceFormat() override

Updated on 2023-06-02 at 17:01:23 +0000