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

#include <i_plugin.h>

Inheritance diagram for nx::sdk::analytics::IPlugin:
nx::sdk::Interface< IPlugin, nx::sdk::IPlugin > nx::sdk::IPlugin nx::sdk::Interface< IPlugin > nx::sdk::IRefCountable

Public Member Functions

virtual const IStringmanifest (Error *outError) const =0
 
virtual IEnginecreateEngine (Error *outError)=0
 
virtual const char * name () const override=0
 
- Public Member Functions inherited from nx::sdk::Interface< IPlugin, nx::sdk::IPlugin >
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::IPlugin
virtual void setUtilityProvider (IUtilityProvider *utilityProvider)=0
 
- Public Member Functions inherited from nx::sdk::Interface< IPlugin >
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::IPlugin
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Additional Inherited Members

- Public Types inherited from nx::sdk::IPlugin
typedef IPlugin *(* EntryPointFunc) ()
 
- Static Public Attributes inherited from nx::sdk::IPlugin
static constexpr const char * kEntryPointFuncName = "createNxPlugin"
 
- Protected Member Functions inherited from nx::sdk::Interface< IPlugin, nx::sdk::IPlugin >
IRefCountablequeryInterfaceSupportingDeprecatedId (IRefCountable::InterfaceId id, const Uuid &deprecatedInterfaceId)
 
- Protected Member Functions inherited from nx::sdk::Interface< IPlugin >
IRefCountablequeryInterfaceSupportingDeprecatedId (IRefCountable::InterfaceId id, const Uuid &deprecatedInterfaceId)
 

Detailed Description

The main interface for an Analytics Plugin instance.

Member Function Documentation

◆ createEngine()

virtual IEngine* nx::sdk::analytics::IPlugin::createEngine ( Error *  outError)
pure virtual

Creates a new instance of Analytics Engine.

Parameters
outErrorStatus of the operation; is set to noError before this call.
Returns
Pointer to an object that implements DeviceAgent interface, or null in case of failure.

◆ manifest()

virtual const IString* nx::sdk::analytics::IPlugin::manifest ( Error *  outError) const
pure virtual

Provides plugin manifest in JSON format.

Parameters
outErrorStatus of the operation; is set to noError before this call.
Returns
JSON string in UTF-8.

◆ name()

virtual const char* nx::sdk::analytics::IPlugin::name ( ) const
overridepure virtual

Name of the plugin dynamic library, without "lib" prefix and without extension.

Implements nx::sdk::IPlugin.


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