nx_metadata_sdk  1.0
Metadata SDK
Public Member Functions | Protected Member Functions | List of all members
nx::vms_server_plugins::analytics::sample::DeviceAgent Class Reference
Inheritance diagram for nx::vms_server_plugins::analytics::sample::DeviceAgent:
nx::sdk::analytics::ConsumingDeviceAgent nx::sdk::RefCountable< IConsumingDeviceAgent >

Public Member Functions

 DeviceAgent (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 std::string manifestString () const override
 
virtual bool pushUncompressedVideoFrame (const nx::sdk::analytics::IUncompressedVideoFrame *videoFrame) override
 
virtual bool pullMetadataPackets (std::vector< nx::sdk::analytics::IMetadataPacket *> *metadataPackets) override
 
virtual void doSetNeededMetadataTypes (nx::sdk::Result< void > *outValue, const nx::sdk::analytics::IMetadataTypes *neededMetadataTypes) override
 
- Protected Member Functions inherited from nx::sdk::analytics::ConsumingDeviceAgent
 ConsumingDeviceAgent (const IDeviceInfo *deviceInfo, bool enableOutput, const std::string &pluginInstanceId="")
 
virtual bool pushCompressedVideoFrame (const ICompressedVideoPacket *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
 
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 getPluginSideSettings (Result< const ISettingsResponse *> *outResult) const override
 
virtual void getManifest (Result< const IString *> *outResult) const override
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ DeviceAgent()

nx::vms_server_plugins::analytics::sample::DeviceAgent::DeviceAgent ( const nx::sdk::IDeviceInfo deviceInfo)
Parameters
deviceInfoVarious information about the related device, such as its id, vendor, model, etc.

Member Function Documentation

◆ manifestString()

std::string nx::vms_server_plugins::analytics::sample::DeviceAgent::manifestString ( ) const
overrideprotectedvirtual
Returns
JSON with the particular structure. Note that it is possible to fill in the values that are not known at compile time, but should not depend on the DeviceAgent settings.

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

◆ pushUncompressedVideoFrame()

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

Called when the Server sends a new uncompressed frame from a camera.

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


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