NVIDIA DeepStream SDK API Reference

8.0 Release
deepstream::BatchMetadata Class Reference

Detailed Description

Holds information about a formed batch containingframes from different sources.

Iterable via iterators for FrameMetadata and UserMetadata. Support initiaizing sub-metadata including DisplayMetadata, FrameMetadata, ObjectMetadata, EventMessageUserMetadata via acquire method. The aquired metadata objects are set to the default state and the their lifecycle would be managed by the batch metadata automatically.

Definition at line 713 of file service-maker/includes/metadata.hpp.

Inheritance diagram for deepstream::BatchMetadata:
Collaboration diagram for deepstream::BatchMetadata:

Public Member Functions

 BatchMetadata (void *data=nullptr)
 Constructor through opaque data pointer. More...
 
virtual ~BatchMetadata ()
 Destructor. More...
 
unsigned int iterate (const std::function< void(const FrameMetadata &)> &func) const
 Iterate the frame metadata within it. More...
 
void initiateIterator (FrameMetadata::Iterator &) const
 Get the iterator for frame metadata within it. More...
 
unsigned int iterate (const std::function< void(const UserMetadata &)> &func, int meta_type) const
 Iterate the user metadata within it. More...
 
void initiateIterator (UserMetadata::Iterator &, int meta_type) const
 Get the iterator for user metadata within it. More...
 
bool acquire (DisplayMetadata &)
 Initialize an empty display metadata. More...
 
bool acquire (FrameMetadata &)
 Initialize an empty frame metadata. More...
 
bool acquire (ObjectMetadata &)
 Initialize an empty object metadata. More...
 
bool acquire (EventMessageUserMetadata &)
 Initialize an empty event message user metadata. More...
 
bool acquire (PreprocessBatchUserMetadata &)
 Initialize an empty preprocess batch user metadata. More...
 
bool acquire (UserMetadata &)
 Initialize an empty user metadata from pool. More...
 
bool acquire (ObjectReidUserMetadata &)
 Initialize an object ReID user metadata. More...
 
template<class C , int N>
bool acquire (UserMetadataTemplate< C, N > &user_meta)
 Initialize an empty user metadata through template. More...
 
void append (const FrameMetadata &)
 Append a frame metadata to the batch. More...
 
void append (const UserMetadata &)
 Append a user metadata to the batch. More...
 
unsigned int nFrames () const
 Number of frames in the batch. More...
 
 BatchMetadata (void *data=nullptr)
 Constructor through opaque data pointer. More...
 
virtual ~BatchMetadata ()
 Destructor. More...
 
unsigned int iterate (const std::function< void(const FrameMetadata &)> &func) const
 Iterate the frame metadata within it. More...
 
void initiateIterator (FrameMetadata::Iterator &) const
 Get the iterator for frame metadata within it. More...
 
unsigned int iterate (const std::function< void(const UserMetadata &)> &func, int meta_type) const
 Iterate the user metadata within it. More...
 
void initiateIterator (UserMetadata::Iterator &, int meta_type) const
 Get the iterator for user metadata within it. More...
 
bool acquire (DisplayMetadata &)
 Initialize an empty display metadata. More...
 
bool acquire (FrameMetadata &)
 Initialize an empty frame metadata. More...
 
bool acquire (ObjectMetadata &)
 Initialize an empty object metadata. More...
 
bool acquire (EventMessageUserMetadata &)
 Initialize an empty event message user metadata. More...
 
bool acquire (PreprocessBatchUserMetadata &)
 Initialize an empty preprocess batch user metadata. More...
 
bool acquire (UserMetadata &)
 Initialize an empty user metadata from pool. More...
 
bool acquire (ObjectReidUserMetadata &)
 Initialize an object ReID user metadata. More...
 
template<class C , int N>
bool acquire (UserMetadataTemplate< C, N > &user_meta)
 Initialize an empty user metadata through template. More...
 
void append (const FrameMetadata &)
 Append a frame metadata to the batch. More...
 
void append (const UserMetadata &)
 Append a user metadata to the batch. More...
 
unsigned int nFrames () const
 Number of frames in the batch. More...
 
virtual operator bool ()
 operator to check if a metadata is void More...
 
virtual operator bool ()
 operator to check if a metadata is void More...
 

Protected Member Functions

UserMetadata acquireUserMetadata_ (void *data, unsigned int type, void *(*copy)(void *, void *), void(*free)(void *, void *))
 
UserMetadata acquireUserMetadata_ (void *data, unsigned int type, void *(*copy)(void *, void *), void(*free)(void *, void *))
 

Protected Attributes

void * data_
 

Constructor & Destructor Documentation

◆ BatchMetadata() [1/2]

deepstream::BatchMetadata::BatchMetadata ( void *  data = nullptr)

Constructor through opaque data pointer.

By default an empty batch metadata object is created.

◆ ~BatchMetadata() [1/2]

virtual deepstream::BatchMetadata::~BatchMetadata ( )
virtual

Destructor.

◆ BatchMetadata() [2/2]

deepstream::BatchMetadata::BatchMetadata ( void *  data = nullptr)

Constructor through opaque data pointer.

By default an empty batch metadata object is created.

◆ ~BatchMetadata() [2/2]

virtual deepstream::BatchMetadata::~BatchMetadata ( )
virtual

Destructor.

Member Function Documentation

◆ acquire() [1/16]

bool deepstream::BatchMetadata::acquire ( DisplayMetadata )

◆ acquire() [2/16]

bool deepstream::BatchMetadata::acquire ( DisplayMetadata )

Initialize an empty display metadata.

◆ acquire() [3/16]

bool deepstream::BatchMetadata::acquire ( EventMessageUserMetadata )

Initialize an empty event message user metadata.

◆ acquire() [4/16]

bool deepstream::BatchMetadata::acquire ( EventMessageUserMetadata )

Initialize an empty event message user metadata.

◆ acquire() [5/16]

bool deepstream::BatchMetadata::acquire ( FrameMetadata )

Initialize an empty frame metadata.

◆ acquire() [6/16]

bool deepstream::BatchMetadata::acquire ( FrameMetadata )

Initialize an empty frame metadata.

◆ acquire() [7/16]

bool deepstream::BatchMetadata::acquire ( ObjectMetadata )

Initialize an empty object metadata.

◆ acquire() [8/16]

bool deepstream::BatchMetadata::acquire ( ObjectMetadata )

Initialize an empty object metadata.

◆ acquire() [9/16]

bool deepstream::BatchMetadata::acquire ( ObjectReidUserMetadata )

Initialize an object ReID user metadata.

◆ acquire() [10/16]

bool deepstream::BatchMetadata::acquire ( ObjectReidUserMetadata )

Initialize an object ReID user metadata.

◆ acquire() [11/16]

bool deepstream::BatchMetadata::acquire ( PreprocessBatchUserMetadata )

Initialize an empty preprocess batch user metadata.

◆ acquire() [12/16]

bool deepstream::BatchMetadata::acquire ( PreprocessBatchUserMetadata )

Initialize an empty preprocess batch user metadata.

◆ acquire() [13/16]

bool deepstream::BatchMetadata::acquire ( UserMetadata )

Initialize an empty user metadata from pool.

◆ acquire() [14/16]

bool deepstream::BatchMetadata::acquire ( UserMetadata )

Initialize an empty user metadata from pool.

◆ acquire() [15/16]

template<class C , int N>
bool deepstream::BatchMetadata::acquire ( UserMetadataTemplate< C, N > &  user_meta)
inline

Initialize an empty user metadata through template.

Definition at line 752 of file service-maker/includes/metadata.hpp.

References acquireUserMetadata_().

◆ acquire() [16/16]

template<class C , int N>
bool deepstream::BatchMetadata::acquire ( UserMetadataTemplate< C, N > &  user_meta)
inline

Initialize an empty user metadata through template.

Definition at line 752 of file 9.0/service-maker/includes/metadata.hpp.

References acquireUserMetadata_().

◆ acquireUserMetadata_() [1/2]

UserMetadata deepstream::BatchMetadata::acquireUserMetadata_ ( void *  data,
unsigned int  type,
void *(*)(void *, void *)  copy,
void(*)(void *, void *)  free 
)
protected

Referenced by acquire().

◆ acquireUserMetadata_() [2/2]

UserMetadata deepstream::BatchMetadata::acquireUserMetadata_ ( void *  data,
unsigned int  type,
void *(*)(void *, void *)  copy,
void(*)(void *, void *)  free 
)
protected

◆ append() [1/4]

void deepstream::BatchMetadata::append ( const FrameMetadata )

Append a frame metadata to the batch.

◆ append() [2/4]

void deepstream::BatchMetadata::append ( const FrameMetadata )

Append a frame metadata to the batch.

◆ append() [3/4]

void deepstream::BatchMetadata::append ( const UserMetadata )

Append a user metadata to the batch.

◆ append() [4/4]

void deepstream::BatchMetadata::append ( const UserMetadata )

Append a user metadata to the batch.

◆ initiateIterator() [1/4]

◆ initiateIterator() [2/4]

void deepstream::BatchMetadata::initiateIterator ( FrameMetadata::Iterator ) const

Get the iterator for frame metadata within it.

◆ initiateIterator() [3/4]

void deepstream::BatchMetadata::initiateIterator ( UserMetadata::Iterator ,
int  meta_type 
) const

Get the iterator for user metadata within it.

◆ initiateIterator() [4/4]

void deepstream::BatchMetadata::initiateIterator ( UserMetadata::Iterator ,
int  meta_type 
) const

Get the iterator for user metadata within it.

◆ iterate() [1/4]

unsigned int deepstream::BatchMetadata::iterate ( const std::function< void(const FrameMetadata &)> &  func) const

◆ iterate() [2/4]

unsigned int deepstream::BatchMetadata::iterate ( const std::function< void(const FrameMetadata &)> &  func) const

Iterate the frame metadata within it.

◆ iterate() [3/4]

unsigned int deepstream::BatchMetadata::iterate ( const std::function< void(const UserMetadata &)> &  func,
int  meta_type 
) const

Iterate the user metadata within it.

◆ iterate() [4/4]

unsigned int deepstream::BatchMetadata::iterate ( const std::function< void(const UserMetadata &)> &  func,
int  meta_type 
) const

Iterate the user metadata within it.

◆ nFrames() [1/2]

unsigned int deepstream::BatchMetadata::nFrames ( ) const

Number of frames in the batch.

◆ nFrames() [2/2]

unsigned int deepstream::BatchMetadata::nFrames ( ) const

Number of frames in the batch.

◆ operator bool() [1/2]

virtual deepstream::Metadata::operator bool ( )
inlinevirtualinherited

operator to check if a metadata is void

Reimplemented in deepstream::UserMetadata, and deepstream::UserMetadata.

Definition at line 51 of file 9.0/service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

◆ operator bool() [2/2]

virtual deepstream::Metadata::operator bool ( )
inlinevirtualinherited

operator to check if a metadata is void

Reimplemented in deepstream::UserMetadata, and deepstream::UserMetadata.

Definition at line 51 of file service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

Field Documentation

◆ data_

void * deepstream::Metadata::data_
protectedinherited

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