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 372 of file metadata.hpp.

Inheritance diagram for deepstream::DisplayMetadata:

Collaboration diagram for deepstream::DisplayMetadata:

Public Types
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...
virtual	operator bool ()
	operator to check if a metadata is void More...

Protected Attributes
void *	data_

Friends
class	FrameMetadata

Member Typedef Documentation

Iterator

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

Definition at line 374 of file metadata.hpp.

Constructor & Destructor Documentation

DisplayMetadata()

deepstream::DisplayMetadata::DisplayMetadata

(

void *

data = nullptr

)

Constructor through opaque data pointer.

By default an empty display metadata object is created.

~DisplayMetadata()

virtual deepstream::DisplayMetadata::~DisplayMetadata ( )

virtual

Destructor.

Member Function Documentation

add() [1/5]

bool deepstream::DisplayMetadata::add

(

NvOSD_ArrowParams &

)

Add an arrow.

add() [2/5]

bool deepstream::DisplayMetadata::add

(

NvOSD_CircleParams &

)

Add a circle.

add() [3/5]

bool deepstream::DisplayMetadata::add

(

NvOSD_LineParams &

)

Add a line.

add() [4/5]

bool deepstream::DisplayMetadata::add

(

NvOSD_RectParams &

)

Add a rectangle.

add() [5/5]

bool deepstream::DisplayMetadata::add

(

NvOSD_TextParams &

)

Add a text label.

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

nArrows()

unsigned int deepstream::DisplayMetadata::nArrows

(

)

const

Number of the arrows.

nCircles()

unsigned int deepstream::DisplayMetadata::nCircles

(

)

const

Number of the circles.

nLabels()

unsigned int deepstream::DisplayMetadata::nLabels

(

)

const

Number of the labels.

nLines()

unsigned int deepstream::DisplayMetadata::nLines

(

)

const

Number of the lines.

nRects()

unsigned int deepstream::DisplayMetadata::nRects

(

)

const

Number of the rectangles.

operator bool()

virtual deepstream::Metadata::operator bool ( )

inlinevirtualinherited

operator to check if a metadata is void

Reimplemented in deepstream::UserMetadata.

Definition at line 51 of file metadata.hpp.

References deepstream::Metadata::data_.

Friends And Related Function Documentation

FrameMetadata

friend class FrameMetadata

friend

Definition at line 408 of file metadata.hpp.

Field Documentation

data_

void* deepstream::Metadata::data_

protectedinherited

Definition at line 54 of file metadata.hpp.

Referenced by deepstream::Metadata::operator bool(), and deepstream::UserMetadata::operator bool().

---

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

• metadata.hpp