nx_metadata_sdk  1.0
Metadata SDK
Public Types | Public Member Functions | Protected Member Functions | List of all members
nx::vms_server_plugins::analytics::stub::Engine Class Reference
Inheritance diagram for nx::vms_server_plugins::analytics::stub::Engine:
nx::sdk::analytics::Engine nx::sdk::RefCountable< IEngine >

Public Types

using PixelFormat = nx::sdk::analytics::IUncompressedVideoFrame::PixelFormat
 

Public Member Functions

 Engine (nx::sdk::analytics::Plugin *plugin)
 
bool needUncompressedVideoFrames () const
 
PixelFormat pixelFormat () const
 
std::string capabilities () const
 
- Public Member Functions inherited from nx::sdk::analytics::Engine
virtual void setEngineInfo (const IEngineInfo *engineInfo) override
 
virtual void setHandler (IEngine::IHandler *handler) override
 
virtual bool isCompatible (const IDeviceInfo *deviceInfo) const override
 
- Public Member Functions inherited from nx::sdk::RefCountable< IEngine >
 RefCountable (const RefCountable &)=delete
 
 RefCountable (RefCountable &&)=delete
 
RefCountableoperator= (const RefCountable &)=delete
 
RefCountableoperator= (RefCountable &&)=delete
 
virtual int addRef () const override
 
virtual int releaseRef () const override
 
int refCount () const
 

Protected Member Functions

virtual std::string manifestString () const override
 
virtual nx::sdk::Result< const nx::sdk::ISettingsResponse * > settingsReceived () override
 
virtual void doObtainDeviceAgent (nx::sdk::Result< nx::sdk::analytics::IDeviceAgent *> *outResult, const nx::sdk::IDeviceInfo *deviceInfo) override
 
virtual nx::sdk::Result< sdk::analytics::IAction::ResultexecuteAction (const std::string &actionId, nx::sdk::Uuid trackId, nx::sdk::Uuid deviceId, int64_t timestampUs, nx::sdk::Ptr< nx::sdk::analytics::IObjectTrackInfo > objectTrackInfo, const std::map< std::string, std::string > &params) override
 
- Protected Member Functions inherited from nx::sdk::analytics::Engine
 Engine (bool enableOutput)
 
std::string settingValue (const std::string &settingName)
 
void pushPluginDiagnosticEvent (IPluginDiagnosticEvent::Level level, std::string caption, std::string description)
 
IHandler * handler () const
 
virtual void doSetSettings (Result< const ISettingsResponse *> *outResult, const IStringMap *settings) override
 
virtual void getPluginSideSettings (Result< const ISettingsResponse *> *outResult) const override
 
virtual void getManifest (Result< const IString *> *outResult) const override
 
virtual void doExecuteAction (Result< IAction::Result > *outResult, const IAction *action) override
 

Additional Inherited Members

- Protected Attributes inherited from nx::sdk::analytics::Engine
LogUtils logUtils
 

Member Function Documentation

◆ executeAction()

Result< IAction::Result > nx::vms_server_plugins::analytics::stub::Engine::executeAction ( const std::string &  actionId,
nx::sdk::Uuid  objectTrackId,
nx::sdk::Uuid  deviceId,
int64_t  timestampUs,
nx::sdk::Ptr< nx::sdk::analytics::IObjectTrackInfo trackInfo,
const std::map< std::string, std::string > &  params 
)
overrideprotectedvirtual

Action handler. Called when some Action defined by this Engine is triggered by the Server.

Parameters
actionIdId of the Action being triggered.
objectTrackIdId of an Object Track for which the Action has been triggered.
deviceIdId of a Device (e.g. a camera) from which the Action has been triggered.
timestampUsTimestamp of the object metadata for which the Action has been triggered.
paramsIf the Engine manifest defines params for the Action being triggered, contains their values after they are filled by the user via the Client form. Otherwise, empty.

Reimplemented from nx::sdk::analytics::Engine.

◆ settingsReceived()

Result< const ISettingsResponse * > nx::vms_server_plugins::analytics::stub::Engine::settingsReceived ( )
overrideprotectedvirtual

Called when the settings are received from the Server, even if the values are not changed. Should perform any required (re)initialization. Called even if the settings model is empty.

Returns
Error messages per setting (if any), as in IEngine::setSettings().

Reimplemented from nx::sdk::analytics::Engine.


The documentation for this class was generated from the following files: