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

#include <plugin.h>

Inheritance diagram for nx::sdk::analytics::Plugin:
nxpl::Plugin2 nxpl::Plugin nxpl::PluginInterface

Public Member Functions

virtual const IStringmanifest (nx::sdk::Error *outError) const =0
 
virtual EnginecreateEngine (Error *outError)=0
 
virtual const char * name () const override=0
 
- Public Member Functions inherited from nxpl::Plugin2
virtual void setPluginContainer (nxpl::PluginInterface *pluginContainer)=0
 
- Public Member Functions inherited from nxpl::Plugin
virtual void setSettings (const nxpl::Setting *settings, int count)=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...
 

Additional Inherited Members

- Public Types inherited from nxpl::Plugin
typedef PluginInterface *(* EntryPoint) ()
 

Detailed Description

Main interface for an analytics::Plugin instance. The only instance is created by a Mediaserver in its start via calls to Plugin* createNxAnalyticsPlugin() which should be exported as extern "C" by the plugin library, and is destroyed (via releaseRef()) on Mediaserver shutdown.

Member Function Documentation

◆ createEngine()

virtual Engine* nx::sdk::analytics::Plugin::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::Plugin::manifest ( nx::sdk::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::Plugin::name ( ) const
overridepure virtual

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

Implements nxpl::Plugin.


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