NVIDIA DeepStream SDK API Reference

8.0 Release
deepstream::DisplayMetadata Class Reference

Detailed Description

Metadata for overlay display on a frame.

The metadata is for nvosd element display various shapes on the curernt frame.

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

Inheritance diagram for deepstream::DisplayMetadata:
Collaboration diagram for deepstream::DisplayMetadata:

Public Types

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

Public Member Functions

 DisplayMetadata (void *data=nullptr)
 Constructor through opaque data pointer. More...
 
virtual ~DisplayMetadata ()
 Destructor. More...
 
unsigned int nRects () const
 Number of the rectangles. More...
 
unsigned int nLabels () const
 Number of the labels. More...
 
unsigned int nLines () const
 Number of the lines. More...
 
unsigned int nArrows () const
 Number of the arrows. More...
 
unsigned int nCircles () const
 Number of the circles. More...
 
bool add (NvOSD_TextParams &)
 Add a text label. More...
 
bool add (NvOSD_RectParams &)
 Add a rectangle. More...
 
bool add (NvOSD_LineParams &)
 Add a line. More...
 
bool add (NvOSD_ArrowParams &)
 Add an arrow. More...
 
bool add (NvOSD_CircleParams &)
 Add a circle. More...
 
 DisplayMetadata (void *data=nullptr)
 Constructor through opaque data pointer. More...
 
virtual ~DisplayMetadata ()
 Destructor. More...
 
unsigned int nRects () const
 Number of the rectangles. More...
 
unsigned int nLabels () const
 Number of the labels. More...
 
unsigned int nLines () const
 Number of the lines. More...
 
unsigned int nArrows () const
 Number of the arrows. More...
 
unsigned int nCircles () const
 Number of the circles. More...
 
bool add (NvOSD_TextParams &)
 Add a text label. More...
 
bool add (NvOSD_RectParams &)
 Add a rectangle. More...
 
bool add (NvOSD_LineParams &)
 Add a line. More...
 
bool add (NvOSD_ArrowParams &)
 Add an arrow. More...
 
bool add (NvOSD_CircleParams &)
 Add a circle. 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 Attributes

void * data_
 

Friends

class FrameMetadata
 

Member Typedef Documentation

◆ Iterator [1/2]

◆ Iterator [2/2]

Constructor & Destructor Documentation

◆ DisplayMetadata() [1/2]

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

Constructor through opaque data pointer.

By default an empty display metadata object is created.

◆ ~DisplayMetadata() [1/2]

virtual deepstream::DisplayMetadata::~DisplayMetadata ( )
virtual

Destructor.

◆ DisplayMetadata() [2/2]

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

Constructor through opaque data pointer.

By default an empty display metadata object is created.

◆ ~DisplayMetadata() [2/2]

virtual deepstream::DisplayMetadata::~DisplayMetadata ( )
virtual

Destructor.

Member Function Documentation

◆ add() [1/10]

bool deepstream::DisplayMetadata::add ( NvOSD_ArrowParams )

Add an arrow.

◆ add() [2/10]

bool deepstream::DisplayMetadata::add ( NvOSD_ArrowParams )

Add an arrow.

◆ add() [3/10]

bool deepstream::DisplayMetadata::add ( NvOSD_CircleParams )

Add a circle.

◆ add() [4/10]

bool deepstream::DisplayMetadata::add ( NvOSD_CircleParams )

Add a circle.

◆ add() [5/10]

bool deepstream::DisplayMetadata::add ( NvOSD_LineParams )

Add a line.

◆ add() [6/10]

bool deepstream::DisplayMetadata::add ( NvOSD_LineParams )

Add a line.

◆ add() [7/10]

bool deepstream::DisplayMetadata::add ( NvOSD_RectParams )

Add a rectangle.

◆ add() [8/10]

bool deepstream::DisplayMetadata::add ( NvOSD_RectParams )

Add a rectangle.

◆ add() [9/10]

bool deepstream::DisplayMetadata::add ( NvOSD_TextParams )

Add a text label.

◆ add() [10/10]

bool deepstream::DisplayMetadata::add ( NvOSD_TextParams )

Add a text label.

Referenced by deepstream::CountMarker::handleData().

◆ nArrows() [1/2]

unsigned int deepstream::DisplayMetadata::nArrows ( ) const

Number of the arrows.

◆ nArrows() [2/2]

unsigned int deepstream::DisplayMetadata::nArrows ( ) const

Number of the arrows.

◆ nCircles() [1/2]

unsigned int deepstream::DisplayMetadata::nCircles ( ) const

Number of the circles.

◆ nCircles() [2/2]

unsigned int deepstream::DisplayMetadata::nCircles ( ) const

Number of the circles.

◆ nLabels() [1/2]

unsigned int deepstream::DisplayMetadata::nLabels ( ) const

Number of the labels.

◆ nLabels() [2/2]

unsigned int deepstream::DisplayMetadata::nLabels ( ) const

Number of the labels.

◆ nLines() [1/2]

unsigned int deepstream::DisplayMetadata::nLines ( ) const

Number of the lines.

◆ nLines() [2/2]

unsigned int deepstream::DisplayMetadata::nLines ( ) const

Number of the lines.

◆ nRects() [1/2]

unsigned int deepstream::DisplayMetadata::nRects ( ) const

Number of the rectangles.

◆ nRects() [2/2]

unsigned int deepstream::DisplayMetadata::nRects ( ) const

Number of the rectangles.

◆ 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 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 9.0/service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

Friends And Related Function Documentation

◆ FrameMetadata

FrameMetadata
friend

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

Field Documentation

◆ data_

void * deepstream::Metadata::data_
protectedinherited

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