stub_analytics_plugin  1.6
Network Optix Video Analytics 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::IPlugin *plugin)
 
virtual nx::sdk::analytics::IDeviceAgentobtainDeviceAgent (const nx::sdk::IDeviceInfo *deviceInfo, nx::sdk::Error *outError) override
 
bool needUncompressedVideoFrames () const
 
PixelFormat pixelFormat () const
 
- Public Member Functions inherited from nx::sdk::analytics::Engine
virtual IPluginplugin () const override
 
virtual void setEngineInfo (const IEngineInfo *engineInfo) override
 
virtual void setSettings (const nx::sdk::IStringMap *settings) override
 
virtual nx::sdk::IStringMappluginSideSettings () const override
 
virtual const IStringmanifest (Error *error) const override
 
virtual void executeAction (IAction *action, Error *outError) override
 
virtual nx::sdk::Error setHandler (IEngine::IHandler *handler) override
 
virtual bool isCompatible (const nx::sdk::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
 
virtual IRefCountablequeryInterface (InterfaceId id)
 
const IRefCountablequeryInterface (InterfaceId id) const
 
InterfacequeryInterface ()
 
const InterfacequeryInterface () const
 

Protected Member Functions

virtual std::string manifest () const override
 
virtual void settingsReceived () override
 
virtual void executeAction (const std::string &actionId, nx::sdk::Uuid objectId, nx::sdk::Uuid deviceId, int64_t timestampUs, const std::map< std::string, std::string > &params, std::string *outActionUrl, std::string *outMessageToUser, nx::sdk::Error *error) override
 
- Protected Member Functions inherited from nx::sdk::analytics::Engine
 Engine (IPlugin *plugin, bool enableOutput, const std::string &printPrefix="")
 
std::string getParamValue (const char *paramName)
 
void pushPluginEvent (nx::sdk::IPluginEvent::Level level, std::string caption, std::string description)
 
template<typename DerivedPlugin >
DerivedPlugin * pluginCasted ()
 
IEngine::IHandlerhandler () const
 

Additional Inherited Members

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

Member Function Documentation

◆ executeAction()

virtual void nx::vms_server_plugins::analytics::stub::Engine::executeAction ( const std::string &  actionId,
nx::sdk::Uuid  objectId,
nx::sdk::Uuid  ,
int64_t  ,
const std::map< std::string, std::string > &  params,
std::string *  outActionUrl,
std::string *  outMessageToUser,
nx::sdk::Error *  error 
)
overrideprotectedvirtual

Action handler. Called when some action defined by this engine is triggered by Server.

Parameters
actionIdId of the action being triggered.
objectIdId of a metadata object 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 Client form. Otherwise, empty.
outActionUrlIf set by this call, Client will open this URL in an embedded browser.
outMessageToUserIf set by this call, Client will show this text to the user.

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

◆ settingsReceived()

virtual void 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.

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


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