nx_server_plugin_sdk 1.0 Server Plugin SDK

Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
nx::sdk::analytics::ICompoundMetadataPacket Class Referenceabstract

`#include <i_compound_metadata_packet.h>`

Inheritance diagram for nx::sdk::analytics::ICompoundMetadataPacket:

## Public Member Functions
virtual int64_t | durationUs () const =0
virtual int | count () const =0
Ptr< const IMetadata > | at (int index) const
Public Member Functions inherited from nx::sdk::Interface< ICompoundMetadataPacket, IMetadataPacket0 >
virtual IRefCountable * | queryInterface (const InterfaceId *id)
Ptr< Interface > | queryInterface ()
Ptr< const Interface > | queryInterface () const

## Static Public Member Functions
static auto | interfaceId ()

## Protected Member Functions
virtual const IMetadata * | getAt (int index) const =0
Protected Member Functions inherited from nx::sdk::Interface< ICompoundMetadataPacket, IMetadataPacket0 >
virtual IRefCountable * | queryInterface (const IRefCountable::InterfaceId *id) override
IRefCountable * | queryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)

## Detailed Description

Packet containing metadata (e.g. events, object detections).

## Member Function Documentation

## ◆ at()

Ptr<const IMetadata> nx::sdk::analytics::ICompoundMetadataPacket::at | ( | int | index | ) | const
| inline

Returns
  Element at the zero-based index, or null if the index is invalid.

## ◆ count()

virtual int nx::sdk::analytics::ICompoundMetadataPacket::count | ( |  | ) | const
| pure virtual

Returns
  Number of elements in the packet.

## ◆ durationUs()

virtual int64_t nx::sdk::analytics::ICompoundMetadataPacket::durationUs | ( |  | ) | const
| pure virtual

Returns
  Validity duration of the metadata in the packet, or 0 if irrelevant.

## ◆ getAt()

virtual const IMetadata* nx::sdk::analytics::ICompoundMetadataPacket::getAt | ( | int | index | ) | const
| protectedpure virtual

Called by at()

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

- src/nx/sdk/analytics/i_compound_metadata_packet.h