stub_analytics_plugin  1.6
Network Optix Video Analytics SDK
Public Member Functions | List of all members
nx::sdk::analytics::Action Class Referenceabstract

#include <action.h>

Inheritance diagram for nx::sdk::analytics::Action:
nxpl::PluginInterface

Public Member Functions

virtual const char * actionId ()=0
 
virtual nxpl::NX_GUID objectId ()=0
 
virtual nxpl::NX_GUID deviceId ()=0
 
virtual int64_t timestampUs ()=0
 
virtual const nx::sdk::Settingsparams ()=0
 
virtual int paramCount ()=0
 
virtual void handleResult (const char *actionUrl, const char *messageToUser)=0
 
- Public Member Functions inherited from nxpl::PluginInterface
virtual void * queryInterface (const nxpl::NX_GUID &interfaceID)=0
 Cast to type, specified by interfaceID. More...
 
virtual unsigned int addRef ()=0
 Increment reference counter. More...
 
virtual unsigned int releaseRef ()=0
 Decrement reference counter. More...
 

Detailed Description

Interface to an object supplied to Engine::executeAction().

Member Function Documentation

◆ actionId()

virtual const char* nx::sdk::analytics::Action::actionId ( )
pure virtual

Id of the action being triggered.

◆ deviceId()

virtual nxpl::NX_GUID nx::sdk::analytics::Action::deviceId ( )
pure virtual

Id of a device from which the action has been triggered.

◆ handleResult()

virtual void nx::sdk::analytics::Action::handleResult ( const char *  actionUrl,
const char *  messageToUser 
)
pure virtual

Report action result back to Server. If the action is decided not to have any result, this method can be either called with nulls or not called at all.

Parameters
actionUrlIf not null, Client will open this URL in an embedded browser.
messageToUserIf not null, Client will show this text to the user.

◆ objectId()

virtual nxpl::NX_GUID nx::sdk::analytics::Action::objectId ( )
pure virtual

Id of a metadata object for which the action has been triggered.

◆ paramCount()

virtual int nx::sdk::analytics::Action::paramCount ( )
pure virtual

Number of items in params() array.

◆ params()

virtual const nx::sdk::Settings* nx::sdk::analytics::Action::params ( )
pure virtual

If the Engine manifest defines params for this action type, contains the array of their values after they are filled by the user via Client form. Otherwise, null.

◆ timestampUs()

virtual int64_t nx::sdk::analytics::Action::timestampUs ( )
pure virtual

Timestamp of a video frame from which the action has been triggered.


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