stub_analytics_plugin  1.6
Network Optix Video Analytics SDK
Classes | Public Member Functions | Static Public Member Functions | List of all members
nx::sdk::analytics::IObjectMetadata Class Referenceabstract

#include <i_object_metadata.h>

Inheritance diagram for nx::sdk::analytics::IObjectMetadata:
nx::sdk::Interface< IObjectMetadata, IMetadata >

Classes

struct  Rect
 

Public Member Functions

virtual Uuid id () const =0
 
virtual const char * subtype () const =0
 
virtual const IAttributeattribute (int index) const =0
 
virtual int attributeCount () const =0
 
virtual const char * auxiliaryData () const =0
 
virtual Rect boundingBox () const =0
 
- Public Member Functions inherited from nx::sdk::Interface< IObjectMetadata, IMetadata >
virtual IRefCountablequeryInterface (IRefCountable::InterfaceId id) override
 
virtual IRefCountablequeryInterface (InterfaceId id)
 
const IRefCountablequeryInterface (InterfaceId id) const
 
InterfacequeryInterface ()
 
const InterfacequeryInterface () const
 

Static Public Member Functions

static auto interfaceId ()
 

Additional Inherited Members

- Protected Member Functions inherited from nx::sdk::Interface< IObjectMetadata, IMetadata >
IRefCountablequeryInterfaceSupportingDeprecatedId (IRefCountable::InterfaceId id, const Uuid &deprecatedInterfaceId)
 

Detailed Description

A single object detected on the scene.

Member Function Documentation

◆ attribute()

virtual const IAttribute* nx::sdk::analytics::IObjectMetadata::attribute ( int  index) const
pure virtual

Provides values of so-called Object Attributes - typically, some object properties (e.g. age or color), represented as a name-value map.

Parameters
index0-based index of the attribute.
Returns
Item of an attribute array, or null if index is out of range.

◆ attributeCount()

virtual int nx::sdk::analytics::IObjectMetadata::attributeCount ( ) const
pure virtual
Returns
Number of items in the attribute array.

◆ auxiliaryData()

virtual const char* nx::sdk::analytics::IObjectMetadata::auxiliaryData ( ) const
pure virtual

Arbitrary data (in json format) associated with the object.

Returns
JSON string in UTF-8.

◆ boundingBox()

virtual Rect nx::sdk::analytics::IObjectMetadata::boundingBox ( ) const
pure virtual
Returns
Bounding box of an object detected in a video frame.

◆ id()

virtual Uuid nx::sdk::analytics::IObjectMetadata::id ( ) const
pure virtual

Id of the object. If the object (e.g. a particular person) is detected on multiple frames, this parameter should be the same each time.

◆ subtype()

virtual const char* nx::sdk::analytics::IObjectMetadata::subtype ( ) const
pure virtual
Returns
Subclass of the object (e.g. vehicle type: truck, car, etc.).

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