stub_analytics_plugin  1.6
Network Optix Video Analytics SDK
Public Member Functions | Protected Member Functions | List of all members
nx::mediaserver_plugins::analytics::stub::Engine Class Reference
Inheritance diagram for nx::mediaserver_plugins::analytics::stub::Engine:
nx::sdk::analytics::CommonEngine nxpt::CommonRefCounter< Engine >

Public Member Functions

 Engine (nx::sdk::analytics::Plugin *plugin)
 
virtual nx::sdk::analytics::DeviceAgentobtainDeviceAgent (const nx::sdk::DeviceInfo *deviceInfo, nx::sdk::Error *outError) override
 
bool needUncompressedVideoFrames () const
 
PixelFormat pixelFormat () const
 
- Public Member Functions inherited from nx::sdk::analytics::CommonEngine
virtual Pluginplugin () const override
 
virtual void * queryInterface (const nxpl::NX_GUID &interfaceId) override
 
virtual void setSettings (const nx::sdk::Settings *settings) override
 
virtual nx::sdk::SettingspluginSideSettings () const override
 
virtual const IStringmanifest (Error *error) const override
 
virtual void executeAction (Action *action, Error *outError) override
 
virtual nx::sdk::Error setHandler (nx::sdk::analytics::Engine::IHandler *handler) override
 
- Public Member Functions inherited from nxpt::CommonRefCounter< Engine >
 CommonRefCounter (const CommonRefCounter &)=delete
 
 CommonRefCounter (CommonRefCounter &&)=delete
 
CommonRefCounteroperator= (const CommonRefCounter &)=delete
 
CommonRefCounteroperator= (CommonRefCounter &&)=delete
 
virtual unsigned int addRef () override
 
virtual unsigned int releaseRef () override
 
unsigned int refCount () const
 

Protected Member Functions

virtual std::string manifest () const override
 
virtual void settingsReceived () override
 
virtual void executeAction (const std::string &actionId, nxpl::NX_GUID objectId, nxpl::NX_GUID 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::CommonEngine
 CommonEngine (Plugin *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 ()
 
nx::sdk::analytics::Engine::IHandlerhandler ()
 
- Protected Member Functions inherited from nxpt::CommonRefCounter< Engine >
 CommonRefCounter (CommonRefManager *refManager)
 

Additional Inherited Members

- Protected Attributes inherited from nx::sdk::analytics::CommonEngine
nx::sdk::Utils utils
 
- Protected Attributes inherited from nxpt::CommonRefCounter< Engine >
CommonRefManager m_refManager
 

Member Function Documentation

◆ executeAction()

virtual void nx::mediaserver_plugins::analytics::stub::Engine::executeAction ( const std::string &  ,
nxpl::NX_GUID  ,
nxpl::NX_GUID  ,
int64_t  ,
const std::map< std::string, std::string > &  ,
std::string *  ,
std::string *  ,
nx::sdk::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::CommonEngine.

◆ settingsReceived()

void 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::CommonEngine.


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