nx_metadata_sdk  1.0
Metadata SDK
Classes | 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::ConsumingDeviceAgent nx::sdk::RefCountable< IConsumingDeviceAgent >

Public Member Functions

 DeviceAgent (Engine *engine, const nx::sdk::IDeviceInfo *deviceInfo)
 
- Public Member Functions inherited from nx::sdk::analytics::ConsumingDeviceAgent
virtual void setHandler (IHandler *handler) 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
 

Protected Member Functions

virtual void getPluginSideSettings (nx::sdk::Result< const nx::sdk::ISettingsResponse *> *outResult) const override
 
virtual void doSetNeededMetadataTypes (nx::sdk::Result< void > *outValue, const nx::sdk::analytics::IMetadataTypes *neededMetadataTypes) override
 
virtual std::string manifestString () const override
 
virtual nx::sdk::Result< const nx::sdk::ISettingsResponse * > settingsReceived () override
 
virtual bool pushCompressedVideoFrame (const nx::sdk::analytics::ICompressedVideoPacket *videoFrame) override
 
virtual bool pushUncompressedVideoFrame (const nx::sdk::analytics::IUncompressedVideoFrame *videoFrame) override
 
virtual bool pushCustomMetadataPacket (const nx::sdk::analytics::ICustomMetadataPacket *customMetadataPacket) override
 
virtual bool pullMetadataPackets (std::vector< nx::sdk::analytics::IMetadataPacket *> *metadataPackets) override
 
- Protected Member Functions inherited from nx::sdk::analytics::ConsumingDeviceAgent
 ConsumingDeviceAgent (const IDeviceInfo *deviceInfo, bool enableOutput)
 
virtual bool pullMetadataPackets (std::vector< IMetadataPacket *> *metadataPackets)
 
void pushMetadataPacket (IMetadataPacket *metadataPacket)
 
void pushPluginDiagnosticEvent (IPluginDiagnosticEvent::Level level, std::string caption, std::string description)
 
std::string settingValue (const std::string &settingName) const
 
std::map< std::string, std::string > currentSettings () const
 
void pushManifest (const std::string &pushManifest)
 
virtual void finalize () override
 
virtual void doPushDataPacket (Result< void > *outResult, IDataPacket *dataPacket) override
 
virtual void doSetSettings (Result< const ISettingsResponse *> *outResult, const IStringMap *settings) override
 
virtual void getManifest (Result< const IString *> *outResult) const override
 

Additional Inherited Members

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

Member Function Documentation

◆ manifestString()

std::string nx::vms_server_plugins::analytics::stub::DeviceAgent::manifestString ( ) 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 from Engine manifest (absent lists are treated as empty lists, thus, disabling all types from the Engine).

Implements nx::sdk::analytics::ConsumingDeviceAgent.

◆ pushCompressedVideoFrame()

bool nx::vms_server_plugins::analytics::stub::DeviceAgent::pushCompressedVideoFrame ( const nx::sdk::analytics::ICompressedVideoPacket videoFrame)
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.

Reimplemented from nx::sdk::analytics::ConsumingDeviceAgent.

◆ pushCustomMetadataPacket()

bool nx::vms_server_plugins::analytics::stub::DeviceAgent::pushCustomMetadataPacket ( const nx::sdk::analytics::ICustomMetadataPacket )
overrideprotectedvirtual

Override to accept next custom metadata for processing.

Parameters
customMetadataPacketContains a pointer to the custom metadata packet.

Reimplemented from nx::sdk::analytics::ConsumingDeviceAgent.

◆ pushUncompressedVideoFrame()

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

Override to accept next uncompressed video frame for processing.

Parameters
videoFrameContains a pointer to the compressed video frame raw bytes.

Reimplemented from nx::sdk::analytics::ConsumingDeviceAgent.

◆ settingsReceived()

Result< const ISettingsResponse * > 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.

Returns
Error messages per setting (if any), as in IDeviceAgent::setSettings().

Reimplemented from nx::sdk::analytics::ConsumingDeviceAgent.


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