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

#include <i_action.h>

Inheritance diagram for nx::sdk::analytics::IAction:
nx::sdk::Interface< IAction > nx::sdk::IRefCountable

Public Member Functions

virtual const char * actionId ()=0
 
virtual Uuid objectId ()=0
 
virtual Uuid deviceId ()=0
 
virtual int64_t timestampUs ()=0
 
virtual const nx::sdk::IStringMapparams ()=0
 
virtual void handleResult (const char *actionUrl, const char *messageToUser)=0
 
- Public Member Functions inherited from nx::sdk::Interface< IAction >
virtual IRefCountablequeryInterface (IRefCountable::InterfaceId id) override
 
virtual IRefCountablequeryInterface (InterfaceId id)
 
const IRefCountablequeryInterface (InterfaceId id) const
 
InterfacequeryInterface ()
 
const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
const IRefCountablequeryInterface (InterfaceId id) const
 
template<class Interface >
InterfacequeryInterface ()
 
template<class Interface >
const InterfacequeryInterface () const
 
virtual int addRef () const =0
 
virtual int releaseRef () const =0
 

Static Public Member Functions

static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Additional Inherited Members

- Protected Member Functions inherited from nx::sdk::Interface< IAction >
IRefCountablequeryInterfaceSupportingDeprecatedId (IRefCountable::InterfaceId id, const Uuid &deprecatedInterfaceId)
 

Detailed Description

Object supplied to IEngine::executeAction().

Member Function Documentation

◆ actionId()

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

Id of the action being triggered.

◆ deviceId()

virtual Uuid nx::sdk::analytics::IAction::deviceId ( )
pure virtual

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

◆ handleResult()

virtual void nx::sdk::analytics::IAction::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 Uuid nx::sdk::analytics::IAction::objectId ( )
pure virtual

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

◆ params()

virtual const nx::sdk::IStringMap* nx::sdk::analytics::IAction::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::IAction::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: