stub_analytics_plugin  1.6
Network Optix Video Analytics SDK
Public Member Functions | Protected Member Functions | List of all members
nx::mediaserver_plugins::analytics::stub::DeviceAgent Class Reference
Inheritance diagram for nx::mediaserver_plugins::analytics::stub::DeviceAgent:
nx::sdk::analytics::CommonVideoFrameProcessingDeviceAgent nxpt::CommonRefCounter< ConsumingDeviceAgent >

Public Member Functions

 DeviceAgent (Engine *engine)
 
virtual nx::sdk::Error setNeededMetadataTypes (const nx::sdk::analytics::IMetadataTypes *neededMetadataTypes) override
 
virtual nx::sdk::SettingspluginSideSettings () const override
 
- Public Member Functions inherited from nx::sdk::analytics::CommonVideoFrameProcessingDeviceAgent
template<typename DerivedEngine >
DerivedEngine * engineCasted () const
 
virtual void * queryInterface (const nxpl::NX_GUID &interfaceId) override
 
virtual Error setHandler (DeviceAgent::IHandler *handler) override
 
virtual Error pushDataPacket (DataPacket *dataPacket) override
 
virtual const IStringmanifest (Error *error) const override
 
virtual void setSettings (const nx::sdk::Settings *settings) override
 
- Public Member Functions inherited from nxpt::CommonRefCounter< ConsumingDeviceAgent >
 CommonRefCounter (const CommonRefCounter &)=delete
 
 CommonRefCounter (CommonRefCounter &&)=delete
 
CommonRefCounteroperator= (const CommonRefCounter &)=delete
 
CommonRefCounteroperator= (CommonRefCounter &&)=delete
 
virtual unsigned int addRef () override
 
virtual unsigned int releaseRef () override
 
unsigned int refCount () const
 

Protected Member Functions

virtual std::string manifest () const override
 
virtual void settingsReceived () override
 
virtual bool pushCompressedVideoFrame (const nx::sdk::analytics::CompressedVideoPacket *videoFrame) override
 
virtual bool pushUncompressedVideoFrame (const nx::sdk::analytics::UncompressedVideoFrame *videoFrame) override
 
virtual bool pullMetadataPackets (std::vector< nx::sdk::analytics::MetadataPacket *> *metadataPackets) override
 
- Protected Member Functions inherited from nx::sdk::analytics::CommonVideoFrameProcessingDeviceAgent
 CommonVideoFrameProcessingDeviceAgent (Engine *engine, bool enableOutput, const std::string &printPrefix="")
 
virtual bool pullMetadataPackets (std::vector< MetadataPacket *> *)
 
void pushMetadataPacket (MetadataPacket *metadataPacket)
 
void pushPluginEvent (IPluginEvent::Level level, std::string caption, std::string description)
 
std::string getParamValue (const char *paramName)
 
- Protected Member Functions inherited from nxpt::CommonRefCounter< ConsumingDeviceAgent >
 CommonRefCounter (CommonRefManager *refManager)
 

Additional Inherited Members

- Protected Attributes inherited from nx::sdk::analytics::CommonVideoFrameProcessingDeviceAgent
const nx::sdk::Utils utils
 
- Protected Attributes inherited from nxpt::CommonRefCounter< ConsumingDeviceAgent >
CommonRefManager m_refManager
 

Member Function Documentation

◆ pushCompressedVideoFrame()

bool nx::mediaserver_plugins::analytics::stub::DeviceAgent::pushCompressedVideoFrame ( const nx::sdk::analytics::CompressedVideoPacket )
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::CommonVideoFrameProcessingDeviceAgent.

◆ pushUncompressedVideoFrame()

bool nx::mediaserver_plugins::analytics::stub::DeviceAgent::pushUncompressedVideoFrame ( const nx::sdk::analytics::UncompressedVideoFrame )
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::CommonVideoFrameProcessingDeviceAgent.

◆ settingsReceived()

void nx::mediaserver_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::CommonVideoFrameProcessingDeviceAgent.


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