nx_metadata_sdk  1.0
Metadata SDK
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
nx::sdk::analytics::ConsumingDeviceAgent Class Referenceabstract

#include <consuming_device_agent.h>

Inheritance diagram for nx::sdk::analytics::ConsumingDeviceAgent:
nx::sdk::RefCountable< IConsumingDeviceAgent > nx::vms_server_plugins::analytics::sample::DeviceAgent nx::vms_server_plugins::analytics::stub::DeviceAgent

Public Member Functions

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

 ConsumingDeviceAgent (const IDeviceInfo *deviceInfo, bool enableOutput)
 
virtual std::string manifestString () const =0
 
virtual bool pushCompressedVideoFrame (const ICompressedVideoPacket *videoFrame)
 
virtual bool pushUncompressedVideoFrame (const IUncompressedVideoFrame *videoFrame)
 
virtual bool pushCustomMetadataPacket (const ICustomMetadataPacket *)
 
virtual bool pullMetadataPackets (std::vector< IMetadataPacket *> *metadataPackets)
 
void pushMetadataPacket (IMetadataPacket *metadataPacket)
 
void pushPluginDiagnosticEvent (IPluginDiagnosticEvent::Level level, std::string caption, std::string description)
 
virtual nx::sdk::Result< const nx::sdk::ISettingsResponse * > settingsReceived ()
 
std::string settingValue (const std::string &settingName) 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 getPluginSideSettings (Result< const ISettingsResponse *> *outResult) const override
 
virtual void getManifest (Result< const IString *> *outResult) const override
 

Protected Attributes

const LogUtils logUtils
 

Detailed Description

Base class for a typical implementation of DeviceAgent which receives a stream and sends back constructed metadata packets. Hides many technical details of Analytics SDK, but may limit DeviceAgent capabilities - use only when suitable.

To use NX_PRINT/NX_OUTPUT in a derived class with the prefix defined by this class, add the following to the derived class .cpp:


    #define NX_PRINT_PREFIX (this->logUtils.printPrefix)
    #include <nx/kit/debug.h>

Constructor & Destructor Documentation

◆ ConsumingDeviceAgent()

nx::sdk::analytics::ConsumingDeviceAgent::ConsumingDeviceAgent ( const IDeviceInfo deviceInfo,
bool  enableOutput 
)
protected
Parameters
enableOutputEnables NX_OUTPUT. Typically, use NX_DEBUG_ENABLE_OUTPUT as a value.

Member Function Documentation

◆ pullMetadataPackets()

bool nx::sdk::analytics::ConsumingDeviceAgent::pullMetadataPackets ( std::vector< IMetadataPacket *> *  metadataPackets)
protectedvirtual

Override to send the newly constructed metadata packets to Server - add the packets to the provided list. Called after pushVideoFrame() to retrieve any metadata packets available to the moment (not necessarily referring to that frame). As an alternative, send metadata to Server by calling pushMetadataPacket() instead of implementing this method.

◆ pushCompressedVideoFrame()

bool nx::sdk::analytics::ConsumingDeviceAgent::pushCompressedVideoFrame ( const ICompressedVideoPacket videoFrame)
protectedvirtual

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 in nx::vms_server_plugins::analytics::stub::DeviceAgent.

◆ pushCustomMetadataPacket()

virtual bool nx::sdk::analytics::ConsumingDeviceAgent::pushCustomMetadataPacket ( const ICustomMetadataPacket )
inlineprotectedvirtual

Override to accept next custom metadata for processing.

Parameters
customMetadataPacketContains a pointer to the custom metadata packet.

Reimplemented in nx::vms_server_plugins::analytics::stub::DeviceAgent.

◆ pushMetadataPacket()

void nx::sdk::analytics::ConsumingDeviceAgent::pushMetadataPacket ( IMetadataPacket metadataPacket)
protected

Send a newly constructed metadata packet to Server. Can be called at any time, from any thread. As an alternative, send metadata to Server by implementing pullMetadataPackets().

◆ pushPluginDiagnosticEvent()

void nx::sdk::analytics::ConsumingDeviceAgent::pushPluginDiagnosticEvent ( IPluginDiagnosticEvent::Level  level,
std::string  caption,
std::string  description 
)
protected

Sends a PluginDiagnosticEvent to the Server. Can be called from any thread, but if called before settingsReceived() was called, will be ignored in case setHandler() was not called yet.

◆ pushUncompressedVideoFrame()

bool nx::sdk::analytics::ConsumingDeviceAgent::pushUncompressedVideoFrame ( const IUncompressedVideoFrame videoFrame)
protectedvirtual

Override to accept next uncompressed video frame for processing.

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

Reimplemented in nx::vms_server_plugins::analytics::stub::DeviceAgent, and nx::vms_server_plugins::analytics::sample::DeviceAgent.

◆ settingsReceived()

virtual nx::sdk::Result<const nx::sdk::ISettingsResponse*> nx::sdk::analytics::ConsumingDeviceAgent::settingsReceived ( )
inlineprotectedvirtual

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 in nx::vms_server_plugins::analytics::stub::DeviceAgent.

◆ settingValue()

std::string nx::sdk::analytics::ConsumingDeviceAgent::settingValue ( const std::string &  settingName) const
protected

Provides access to the DeviceAgent settings stored by the Server for the particular Device.

ATTENTION: If settingsReceived() has not been called yet, it means that the DeviceAgent has not received its settings from the Server yet, and thus this method will yield empty values.

Returns
Setting value, or an empty string if such setting does not exist, having logged the error.

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