NVIDIA DeepStream SDK API Reference

8.0 Release
deepstream::UserMetadataTemplate< C, N > Class Template Reference

Detailed Description

template<class C, int N>
class deepstream::UserMetadataTemplate< C, N >

Template for customized user metadata.

Custom objects can be attached to user metadata via this template

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

Inheritance diagram for deepstream::UserMetadataTemplate< C, N >:
Collaboration diagram for deepstream::UserMetadataTemplate< C, N >:

Public Types

typedef std::unique_ptr< AbstractIterator< UserMetadata > > Iterator
 
typedef std::unique_ptr< AbstractIterator< UserMetadata > > Iterator
 

Public Member Functions

 UserMetadataTemplate (void *data=nullptr)
 
 UserMetadataTemplate (const UserMetadata &other)
 
virtual ~UserMetadataTemplate ()
 
C & get ()
 
 UserMetadataTemplate (void *data=nullptr)
 
 UserMetadataTemplate (const UserMetadata &other)
 
virtual ~UserMetadataTemplate ()
 
C & get ()
 
virtual operator bool () override
 operator to check if a metadata is void More...
 
virtual operator bool () override
 operator to check if a metadata is void More...
 
int metaType () const
 Get the meta type. More...
 
int metaType () const
 Get the meta type. More...
 
void setMetaType (int type)
 Set the meta type. More...
 
void setMetaType (int type)
 Set the meta type. More...
 
void * userData () const
 Get the user data pointer. More...
 
void * userData () const
 Get the user data pointer. More...
 
void setUserData (void *data, void *(*copy)(void *, void *), void(*release)(void *, void *))
 Set user data with copy and release functions. More...
 
void setUserData (void *data, void *(*copy)(void *, void *), void(*release)(void *, void *))
 Set user data with copy and release functions. More...
 

Static Public Member Functions

static void * copy (void *data, void *user_data)
 
static void free (void *data, void *user_data)
 
static void * copy (void *data, void *user_data)
 
static void free (void *data, void *user_data)
 

Protected Member Functions

void get_ (void *&)
 
void get_ (void *&)
 

Protected Attributes

void * data_
 

Member Typedef Documentation

◆ Iterator [1/2]

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

◆ Iterator [2/2]

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

Constructor & Destructor Documentation

◆ UserMetadataTemplate() [1/4]

template<class C , int N>
deepstream::UserMetadataTemplate< C, N >::UserMetadataTemplate ( void *  data = nullptr)
inline

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

◆ UserMetadataTemplate() [2/4]

template<class C , int N>
deepstream::UserMetadataTemplate< C, N >::UserMetadataTemplate ( const UserMetadata other)
inline

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

◆ ~UserMetadataTemplate() [1/2]

template<class C , int N>
virtual deepstream::UserMetadataTemplate< C, N >::~UserMetadataTemplate ( )
inlinevirtual

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

◆ UserMetadataTemplate() [3/4]

template<class C , int N>
deepstream::UserMetadataTemplate< C, N >::UserMetadataTemplate ( void *  data = nullptr)
inline

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

◆ UserMetadataTemplate() [4/4]

template<class C , int N>
deepstream::UserMetadataTemplate< C, N >::UserMetadataTemplate ( const UserMetadata other)
inline

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

◆ ~UserMetadataTemplate() [2/2]

template<class C , int N>
virtual deepstream::UserMetadataTemplate< C, N >::~UserMetadataTemplate ( )
inlinevirtual

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

Member Function Documentation

◆ copy() [1/2]

template<class C , int N>
static void* deepstream::UserMetadataTemplate< C, N >::copy ( void *  data,
void *  user_data 
)
inlinestatic

◆ copy() [2/2]

template<class C , int N>
static void* deepstream::UserMetadataTemplate< C, N >::copy ( void *  data,
void *  user_data 
)
inlinestatic

◆ free() [1/2]

template<class C , int N>
static void deepstream::UserMetadataTemplate< C, N >::free ( void *  data,
void *  user_data 
)
inlinestatic

◆ free() [2/2]

template<class C , int N>
static void deepstream::UserMetadataTemplate< C, N >::free ( void *  data,
void *  user_data 
)
inlinestatic

◆ get() [1/2]

template<class C , int N>
C& deepstream::UserMetadataTemplate< C, N >::get ( )
inline

◆ get() [2/2]

template<class C , int N>
C& deepstream::UserMetadataTemplate< C, N >::get ( )
inline

◆ get_() [1/2]

◆ get_() [2/2]

void deepstream::UserMetadata::get_ ( void *&  )
protectedinherited

◆ metaType() [1/2]

int deepstream::UserMetadata::metaType ( ) const
inherited

Get the meta type.

◆ metaType() [2/2]

int deepstream::UserMetadata::metaType ( ) const
inherited

Get the meta type.

◆ operator bool() [1/2]

virtual deepstream::UserMetadata::operator bool ( )
inlineoverridevirtualinherited

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

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

References deepstream::Metadata::data_.

◆ operator bool() [2/2]

virtual deepstream::UserMetadata::operator bool ( )
inlineoverridevirtualinherited

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

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

References deepstream::Metadata::data_.

◆ setMetaType() [1/2]

void deepstream::UserMetadata::setMetaType ( int  type)
inherited

Set the meta type.

◆ setMetaType() [2/2]

void deepstream::UserMetadata::setMetaType ( int  type)
inherited

Set the meta type.

◆ setUserData() [1/2]

void deepstream::UserMetadata::setUserData ( void *  data,
void *(*)(void *, void *)  copy,
void(*)(void *, void *)  release 
)
inherited

Set user data with copy and release functions.

Parameters
dataPointer to user data
copyCopy function for the user data (can be NULL)
releaseRelease function for the user data (can be NULL)

◆ setUserData() [2/2]

void deepstream::UserMetadata::setUserData ( void *  data,
void *(*)(void *, void *)  copy,
void(*)(void *, void *)  release 
)
inherited

Set user data with copy and release functions.

Parameters
dataPointer to user data
copyCopy function for the user data (can be NULL)
releaseRelease function for the user data (can be NULL)

◆ userData() [1/2]

void* deepstream::UserMetadata::userData ( ) const
inherited

Get the user data pointer.

◆ userData() [2/2]

void* deepstream::UserMetadata::userData ( ) const
inherited

Get the user data pointer.

Field Documentation

◆ data_

void * deepstream::Metadata::data_
protectedinherited

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