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

#include <device_agent.h>

Inheritance diagram for nx::sdk::analytics::DeviceAgent:
nxpl::PluginInterface nx::sdk::analytics::ConsumingDeviceAgent

Classes

class  IHandler
 

Public Member Functions

virtual Engineengine () const =0
 
virtual void setSettings (const Settings *settings)=0
 
virtual SettingspluginSideSettings () const =0
 
virtual const IStringmanifest (Error *error) const =0
 
virtual Error setHandler (IHandler *handler)=0
 
virtual Error setNeededMetadataTypes (const IMetadataTypes *neededMetadataTypes)=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 used to control the process of fetching metadata from the resource.

All methods are guaranteed to be called without overlappings, even if from different threads, thus, no synchronization is required for the implementation.

Member Function Documentation

◆ engine()

virtual Engine* nx::sdk::analytics::DeviceAgent::engine ( ) const
pure virtual
Returns
Parent Engine.

◆ manifest()

virtual const IString* nx::sdk::analytics::DeviceAgent::manifest ( Error *  error) const
pure virtual

Provides DeviceAgent manifest in JSON format.

Returns
JSON string in UTF-8.

◆ pluginSideSettings()

nx::sdk::Settings * nx::mediaserver_plugins::analytics::stub::DeviceAgent::pluginSideSettings ( ) const
pure virtual

In addition to the settings stored in a Server database, a DeviceAgent can have some settings which are stored somewhere "under the hood" of the Engine, e.g. on a device acting as a DeviceAgent's backend. Such settings do not need to be explicitly marked in the Settings Model, but every time the Server offers the user to edit the values, it calls this method and merges the received values with the ones in its database.

Returns
DeviceAgent settings that are stored on the plugin side.

◆ setHandler()

virtual Error nx::sdk::analytics::DeviceAgent::setHandler ( IHandler handler)
pure virtual
Parameters
handlerProcesses event metadata and object metadata fetched by DeviceAgent. DeviceAgent should fetch events metadata after setNeededMetadataTypes() call. Generic device related events (errors, warning, info messages) might also be reported via this handler.
Returns
noError in case of success, other value otherwise.

◆ setNeededMetadataTypes()

Error nx::mediaserver_plugins::analytics::stub::DeviceAgent::setNeededMetadataTypes ( const IMetadataTypes neededMetadataTypes)
pure virtual

Sets a list of metadata types that are needed by the Server. Empty list means that the Server doesn't need any metadata from this DeviceAgent.

Parameters
neededMetadataTypesLists of type ids of events and objects.

◆ setSettings()

virtual void nx::sdk::analytics::DeviceAgent::setSettings ( const Settings settings)
pure virtual

Called before other methods. Server provides the set of settings stored in its database for the combination of a device instance and an Engine instance.

Parameters
settingsValues of settings declared in the manifest. Never null. Valid only during the call.

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