stub_analytics_plugin  1.6
Network Optix Video Analytics SDK
Public Member Functions | Protected Member Functions | List of all members
nx::vms_server_plugins::analytics::stub::DeviceAgent Class Reference
Inheritance diagram for nx::vms_server_plugins::analytics::stub::DeviceAgent:
nx::sdk::analytics::VideoFrameProcessingDeviceAgent nx::sdk::RefCountable< IConsumingDeviceAgent >

Public Member Functions

 DeviceAgent (Engine *engine)
 
virtual nx::sdk::Error setNeededMetadataTypes (const nx::sdk::analytics::IMetadataTypes *neededMetadataTypes) override
 
virtual nx::sdk::IStringMappluginSideSettings () const override
 
- Public Member Functions inherited from nx::sdk::analytics::VideoFrameProcessingDeviceAgent
template<typename DerivedEngine >
DerivedEngine * engineCasted () const
 
virtual Error setHandler (IDeviceAgent::IHandler *handler) override
 
virtual Error pushDataPacket (IDataPacket *dataPacket) override
 
virtual const IStringmanifest (Error *error) const override
 
virtual void setSettings (const nx::sdk::IStringMap *settings) override
 
- Public Member Functions inherited from nx::sdk::RefCountable< IConsumingDeviceAgent >
 RefCountable (const RefCountable &)=delete
 
 RefCountable (RefCountable &&)=delete
 
RefCountableoperator= (const RefCountable &)=delete
 
RefCountableoperator= (RefCountable &&)=delete
 
virtual int addRef () const override
 
virtual int releaseRef () const override
 
int refCount () const
 
virtual IRefCountablequeryInterface (InterfaceId id)
 
const IRefCountablequeryInterface (InterfaceId id) const
 
InterfacequeryInterface ()
 
const InterfacequeryInterface () const
 

Protected Member Functions

virtual std::string manifest () const override
 
virtual void settingsReceived () override
 
virtual bool pushCompressedVideoFrame (const nx::sdk::analytics::ICompressedVideoPacket *videoFrame) override
 
virtual bool pushUncompressedVideoFrame (const nx::sdk::analytics::IUncompressedVideoFrame *videoFrame) override
 
virtual bool pullMetadataPackets (std::vector< nx::sdk::analytics::IMetadataPacket *> *metadataPackets) override
 
- Protected Member Functions inherited from nx::sdk::analytics::VideoFrameProcessingDeviceAgent
 VideoFrameProcessingDeviceAgent (IEngine *engine, bool enableOutput, const std::string &printPrefix="")
 
virtual bool pullMetadataPackets (std::vector< IMetadataPacket *> *)
 
void pushMetadataPacket (IMetadataPacket *metadataPacket)
 
void pushPluginEvent (IPluginEvent::Level level, std::string caption, std::string description)
 
std::string getParamValue (const char *paramName)
 

Additional Inherited Members

- Protected Attributes inherited from nx::sdk::analytics::VideoFrameProcessingDeviceAgent
const LogUtils logUtils
 

Member Function Documentation

◆ manifest()

std::string nx::vms_server_plugins::analytics::stub::DeviceAgent::manifest ( ) const
overrideprotectedvirtual

DeviceAgent manifest may declare eventTypes and objectTypes similarly to how an Engine declares them - semantically the set from the Engine manifest is joined with the set from the DeviceAgent manifest. Also this manifest should declare supportedEventTypeIds and supportedObjectTypeIds lists which are treated as white-list filters for the respective set (absent lists are treated as empty lists, thus, disabling all types from the Engine).

Implements nx::sdk::analytics::VideoFrameProcessingDeviceAgent.

◆ pushCompressedVideoFrame()

bool nx::vms_server_plugins::analytics::stub::DeviceAgent::pushCompressedVideoFrame ( const nx::sdk::analytics::ICompressedVideoPacket )
overrideprotectedvirtual

Override to accept next compressed video frame for processing. Should not block the caller thread for long.

Parameters
videoFrameContains a pointer to the compressed video frame raw bytes. The lifetime (validity) of this pointer is the same as of videoFrame. Thus, it can be extended by addRef() or queryInterface() inside this method.

Reimplemented from nx::sdk::analytics::VideoFrameProcessingDeviceAgent.

◆ pushUncompressedVideoFrame()

bool nx::vms_server_plugins::analytics::stub::DeviceAgent::pushUncompressedVideoFrame ( const nx::sdk::analytics::IUncompressedVideoFrame )
overrideprotectedvirtual

Override to accept next uncompressed video frame for processing.

Parameters
videoFrameContains a pointer to the compressed video frame raw bytes. The lifetime (validity) of this pointer is the same as of videoFrame. Thus, it can be extended by addRef() or queryInterface() inside this method.

Reimplemented from nx::sdk::analytics::VideoFrameProcessingDeviceAgent.

◆ settingsReceived()

void nx::vms_server_plugins::analytics::stub::DeviceAgent::settingsReceived ( )
overrideprotectedvirtual

Called when the settings are received from the server (even if the values are not changed). Should perform any required (re)initialization. Called even if the settings model is empty.

Reimplemented from nx::sdk::analytics::VideoFrameProcessingDeviceAgent.


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