nx_metadata_sdk  1.0
Metadata SDK
Public Types | Public Member Functions | Static Public Member Functions | List of all members
nx::sdk::analytics::IDataPacket Class Referenceabstract

#include <i_data_packet.h>

Inheritance diagram for nx::sdk::analytics::IDataPacket:
nx::sdk::Interface< IDataPacket > nx::sdk::IRefCountable

Public Types

enum  Flags : uint32_t { none = 0, Flags::cameraClockTimestamp = 1 << 0 }
 

Public Member Functions

virtual int64_t timestampUs () const =0
 
- Public Member Functions inherited from nx::sdk::Interface< IDataPacket >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< RefCountablequeryInterface ()
 
Ptr< const RefCountablequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
template<class RefCountable >
Ptr< RefCountablequeryInterface ()
 
template<class RefCountable >
Ptr< const RefCountablequeryInterface () const
 
virtual int addRef () const =0
 
virtual int releaseRef () const =0
 
int refCountThreadUnsafe () const
 

Static Public Member Functions

static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Additional Inherited Members

- Protected Member Functions inherited from nx::sdk::Interface< IDataPacket >
virtual IRefCountablequeryInterface (const IRefCountable::InterfaceId *id) override
 
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 
- Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceIdmakeId (const char(&charArray)[len])
 
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceIdmakeIdForTemplate (const char(&baseIdCharArray)[len])
 
- Static Protected Attributes inherited from nx::sdk::IRefCountable
template<typename RefCountable >
static constexpr bool hasAlternativeInterfaceId = HasAlternativeInterfaceId<RefCountable>::value
 

Detailed Description

Base class for classes that represent the packet of data (e.g. audio, video, metadata).

Member Enumeration Documentation

◆ Flags

Enumerator
cameraClockTimestamp 

Indicates that the timestamp is sampled from a camera's own internal clock and should be translated to VMS System clock.

Member Function Documentation

◆ timestampUs()

virtual int64_t nx::sdk::analytics::IDataPacket::timestampUs ( ) const
pure virtual
Returns
Timestamp of the media data in microseconds since epoch, or 0 if not relevant.

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