|
using | PixelFormat = nx::sdk::analytics::IUncompressedVideoFrame::PixelFormat |
|
|
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 > ¶ms, std::string *outActionUrl, std::string *outMessageToUser, nx::sdk::Error *error) override |
|
| 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::IHandler * | handler () const |
|
◆ 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
-
actionId | Id of the action being triggered. |
objectId | Id of a metadata object for which the action has been triggered. |
params | If 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. |
outActionUrl | If set by this call, Client will open this URL in an embedded browser. |
outMessageToUser | If 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:
- samples/stub_analytics_plugin/src/nx/vms_server_plugins/analytics/stub/engine.h
- samples/stub_analytics_plugin/src/nx/vms_server_plugins/analytics/stub/engine.cpp