Detailed Description

A specific signal handler for consuming data.

Users must implement the IDataConsumer interface to create a data receiver. Data receiver can only be attached to elements that supports "new-sample" signal, typically an "appsink".

Definition at line 37 of file service-maker/includes/data_receiver.hpp.

Inheritance diagram for deepstream::DataReceiver:

[legend]

Collaboration diagram for deepstream::DataReceiver:

[legend]

Data Structures
class	IDataConsumer
	required interface for a data receiver More...

Public Member Functions
	DataReceiver (const std::string &name, IDataConsumer *consumer, unsigned int retries=0)
	Constructor. More...

	DataReceiver (const std::string &name, const char factory, IDataConsumer consumer, unsigned int retries=0)
	Constructor. More...

virtual	~DataReceiver ()
	Destructor. More...

int	consume (Buffer buffer)
	Consume a buffer. More...

	DataReceiver (const std::string &name, IDataConsumer *consumer, unsigned int retries=0)
	Constructor. More...

	DataReceiver (const std::string &name, const char factory, IDataConsumer consumer, unsigned int retries=0)
	Constructor. More...

virtual	~DataReceiver ()
	Destructor. More...

int	consume (Buffer buffer)
	Consume a buffer. More...

void *	getCallbackFn (const std::string &name) const
	Return the callback for a specific signal. More...

void *	getCallbackFn (const std::string &name) const
	Return the callback for a specific signal. More...

const std::string	getName () const
	Return the name assigned during the construction. More...

const std::string	getName () const
	Return the name assigned during the construction. More...

	operator bool () const noexcept
	Check if the object is void. More...

	operator bool () const noexcept
	Check if the object is void. More...

bool	operator== (const Object &other) noexcept
	Check if the two objects are the same. More...

bool	operator== (const Object &other) noexcept
	Check if the two objects are the same. More...

GstObject *	give ()
	Give up the ownership and return the opaque pointer. More...

GstObject *	give ()
	Give up the ownership and return the opaque pointer. More...

GstObject *	getGObject ()
	Return the opaque object pointer. More...

GstObject *	getGObject ()
	Return the opaque object pointer. More...

Object &	take (GstObject *object)
	Takes the ownership of a object through the opaque pointer. More...

Object &	take (GstObject *object)
	Takes the ownership of a object through the opaque pointer. More...

Object &	seize (GstObject *object)
	Seize a opaque object to prevent it from being destroyed somewhere. More...

Object &	seize (GstObject *object)
	Seize a opaque object to prevent it from being destroyed somewhere. More...

Object &	set (const YAML::Node &params)
	Set the properties from key/value pairs in the yaml format. More...

Object &	set (const std::string &name, const Value &value)

template<typename T , typename... Args>
Object &	set (const std::string &name, const T &value, const Args &... args)

Object &	set (const YAML::Node &params)
	Set the properties from key/value pairs in the yaml format. More...

Object &	set (const std::string &name, const Value &value)

template<typename T , typename... Args>
Object &	set (const std::string &name, const T &value, const Args &... args)

template<typename T , typename... Args>
Object &	getProperty (const std::string &name, T &value, Args &... args)
	Template for getting multiple properties. More...

template<typename T , typename... Args>
Object &	getProperty (const std::string &name, T &value, Args &... args)
	Template for getting multiple properties. More...

std::vector< std::string >	listSignals (bool is_action)
	List all the supported signals from the object. More...

std::vector< std::string >	listSignals (bool is_action)
	List all the supported signals from the object. More...

bool	connectSignal (const std::string &signal_name, SignalHandler &handler)
	Connect a signal handler to the object. More...

bool	connectSignal (const std::string &signal_name, SignalHandler &handler)
	Connect a signal handler to the object. More...

void	emitSignal (const std::string &signal_name, va_list args)
	Emit a signal. More...

void	emitSignal (const std::string &signal_name, va_list args)
	Emit a signal. More...

Static Public Member Functions
static unsigned long	type ()
	Return the type id assigned to signal handler. More...

static unsigned long	type ()
	Return the type id assigned to signal handler. More...

Protected Member Functions
virtual void	set_ (const std::string &name, const Value &value)

virtual void	set_ (const std::string &name, const YAML::Node &value)

virtual void	set_ (const std::string &name, const Value &value)

virtual void	set_ (const std::string &name, const YAML::Node &value)

virtual Value	get_ (const std::string &name)

virtual Value	get_ (const std::string &name)

Protected Attributes
std::unique_ptr< IDataConsumer >	data_consumer_

unsigned int	retries_

std::unique_ptr< IActionProvider >	provider_

std::string	param_spec_
	property spec in YAML format More...

std::map< std::string, Object::Value >	properties_
	property map More...

GstObject *	object_

Constructor & Destructor Documentation

◆ DataReceiver() [1/4]

deepstream::DataReceiver::DataReceiver	(	const std::string &	name,
		IDataConsumer *	consumer,
		unsigned int	retries = `0`
	)

Constructor.

Create a data reciver with a user implemented data provider interface

Parameters

[in]	name	name of the instance
[in]	handler	implementation of the IDataConsumer interface

◆ DataReceiver() [2/4]

deepstream::DataReceiver::DataReceiver	(	const std::string &	name,
		const char *	factory,
		IDataConsumer *	consumer,
		unsigned int	retries = `0`
	)

Constructor.

Create a data reciver with a user implemented data provider interface

Parameters

[in]	name	name of the instance
[in]	factory	name of the factory to create the instance
[in]	handler	implementation of the IDataConsumer interface

◆ ~DataReceiver() [1/2]

virtual deepstream::DataReceiver::~DataReceiver ( )

virtual

Destructor.

◆ DataReceiver() [3/4]

deepstream::DataReceiver::DataReceiver	(	const std::string &	name,
		IDataConsumer *	consumer,
		unsigned int	retries = `0`
	)

Constructor.

Create a data reciver with a user implemented data provider interface

Parameters

[in]	name	name of the instance
[in]	handler	implementation of the IDataConsumer interface

◆ DataReceiver() [4/4]

deepstream::DataReceiver::DataReceiver	(	const std::string &	name,
		const char *	factory,
		IDataConsumer *	consumer,
		unsigned int	retries = `0`
	)

Constructor.

Create a data reciver with a user implemented data provider interface

Parameters

[in]	name	name of the instance
[in]	factory	name of the factory to create the instance
[in]	handler	implementation of the IDataConsumer interface

◆ ~DataReceiver() [2/2]

virtual deepstream::DataReceiver::~DataReceiver ( )

virtual

Destructor.

Member Function Documentation

◆ connectSignal() [1/2]

bool deepstream::Object::connectSignal	(	const std::string &	signal_name,
		SignalHandler &	handler
	)

inherited

Connect a signal handler to the object.

Parameters

[in]	signal_name	name of the signal to be connected
[in]	handler	handler for the signal

◆ connectSignal() [2/2]

bool deepstream::Object::connectSignal	(	const std::string &	signal_name,
		SignalHandler &	handler
	)

inherited

Connect a signal handler to the object.

Parameters

[in]	signal_name	name of the signal to be connected
[in]	handler	handler for the signal

◆ consume() [1/2]

int deepstream::DataReceiver::consume ( Buffer buffer )

Consume a buffer.

The method is called from the pipeline and invokes the its own IDataConsumer interface.

◆ consume() [2/2]

int deepstream::DataReceiver::consume ( Buffer buffer )

Consume a buffer.

The method is called from the pipeline and invokes the its own IDataConsumer interface.

◆ emitSignal() [1/2]

void deepstream::Object::emitSignal	(	const std::string &	signal_name,
		va_list	args
	)

inherited

Emit a signal.

◆ emitSignal() [2/2]

void deepstream::Object::emitSignal	(	const std::string &	signal_name,
		va_list	args
	)

inherited

Emit a signal.

◆ get_() [1/2]

virtual Value deepstream::CustomObject::get_ ( const std::string & name )

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ get_() [2/2]

virtual Value deepstream::CustomObject::get_ ( const std::string & name )

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ getCallbackFn() [1/2]

void* deepstream::SignalHandler::getCallbackFn ( const std::string & name ) const

inherited

Return the callback for a specific signal.

◆ getCallbackFn() [2/2]

void* deepstream::SignalHandler::getCallbackFn ( const std::string & name ) const

inherited

Return the callback for a specific signal.

◆ getGObject() [1/2]

GstObject* deepstream::Object::getGObject ( )

inlineinherited

Return the opaque object pointer.

Definition at line 140 of file service-maker/includes/object.hpp.

References deepstream::Object::object_.

◆ getGObject() [2/2]

GstObject* deepstream::Object::getGObject ( )

inlineinherited

Return the opaque object pointer.

Definition at line 140 of file 9.0/service-maker/includes/object.hpp.

References deepstream::Object::object_.

◆ getName() [1/2]

const std::string deepstream::Object::getName ( ) const

inherited

Return the name assigned during the construction.

◆ getName() [2/2]

const std::string deepstream::Object::getName ( ) const

inherited

Return the name assigned during the construction.

◆ getProperty() [1/2]

template<typename T , typename... Args>

Object& deepstream::Object::getProperty	(	const std::string &	name,
		T &	value,
		Args &...	args
	)

inlineinherited

Template for getting multiple properties.

Definition at line 171 of file 9.0/service-maker/includes/object.hpp.

References deepstream::Object::get_(), and deepstream::Object::getProperty().

◆ getProperty() [2/2]

template<typename T , typename... Args>

Object& deepstream::Object::getProperty	(	const std::string &	name,
		T &	value,
		Args &...	args
	)

inlineinherited

Template for getting multiple properties.

Definition at line 171 of file service-maker/includes/object.hpp.

References deepstream::Object::get_().

Referenced by deepstream::Object::getProperty(), deepstream::CountMarker::handleData(), deepstream::MsgMetaGenerator::handleData(), deepstream::TensorMetaParser::handleData(), deepstream::NvDsKittiDump::handleData(), deepstream::LiDARDataSource::initialize(), deepstream::SmartRecordingAction::onAttached(), and deepstream::FileDataSource::read().

◆ give() [1/2]

GstObject* deepstream::Object::give ( )

inherited

Give up the ownership and return the opaque pointer.

◆ give() [2/2]

GstObject* deepstream::Object::give ( )

inherited

Give up the ownership and return the opaque pointer.

◆ listSignals() [1/2]

std::vector<std::string> deepstream::Object::listSignals ( bool is_action )

inherited

List all the supported signals from the object.

◆ listSignals() [2/2]

std::vector<std::string> deepstream::Object::listSignals ( bool is_action )

inherited

List all the supported signals from the object.

◆ operator bool() [1/2]

deepstream::Object::operator bool ( ) const

inlineexplicitnoexceptinherited

Check if the object is void.

Definition at line 131 of file 9.0/service-maker/includes/object.hpp.

References deepstream::Object::object_.

◆ operator bool() [2/2]

deepstream::Object::operator bool ( ) const

inlineexplicitnoexceptinherited

Check if the object is void.

Definition at line 131 of file service-maker/includes/object.hpp.

References deepstream::Object::object_.

◆ operator==() [1/2]

bool deepstream::Object::operator== ( const Object & other )

inlinenoexceptinherited

Check if the two objects are the same.

Definition at line 134 of file service-maker/includes/object.hpp.

References deepstream::Object::object_.

◆ operator==() [2/2]

bool deepstream::Object::operator== ( const Object & other )

inlinenoexceptinherited

Check if the two objects are the same.

Definition at line 134 of file 9.0/service-maker/includes/object.hpp.

References deepstream::Object::object_.

◆ seize() [1/2]

Object& deepstream::Object::seize ( GstObject * object )

inherited

Seize a opaque object to prevent it from being destroyed somewhere.

◆ seize() [2/2]

Object& deepstream::Object::seize ( GstObject * object )

inherited

Seize a opaque object to prevent it from being destroyed somewhere.

◆ set() [1/6]

template<typename T , typename... Args>

Object& deepstream::Object::set	(	const std::string &	name,
		const T &	value,
		const Args &...	args
	)

inlineinherited

Definition at line 161 of file 9.0/service-maker/includes/object.hpp.

References deepstream::Object::set(), and deepstream::Object::set_().

◆ set() [2/6]

template<typename T , typename... Args>

Object& deepstream::Object::set	(	const std::string &	name,
		const T &	value,
		const Args &...	args
	)

inlineinherited

Definition at line 161 of file service-maker/includes/object.hpp.

References deepstream::Object::set(), and deepstream::Object::set_().

◆ set() [3/6]

Object& deepstream::Object::set	(	const std::string &	name,
		const Value &	value
	)

inlineinherited

Definition at line 154 of file 9.0/service-maker/includes/object.hpp.

References deepstream::Object::set_().

◆ set() [4/6]

Object& deepstream::Object::set	(	const std::string &	name,
		const Value &	value
	)

inlineinherited

Definition at line 154 of file service-maker/includes/object.hpp.

References deepstream::Object::set_().

◆ set() [5/6]

Object& deepstream::Object::set ( const YAML::Node & params )

inherited

Set the properties from key/value pairs in the yaml format.

Referenced by deepstream::Pipeline::add(), and deepstream::Object::set().

◆ set() [6/6]

Object& deepstream::Object::set ( const YAML::Node & params )

inherited

Set the properties from key/value pairs in the yaml format.

◆ set_() [1/4]

virtual void deepstream::CustomObject::set_	(	const std::string &	name,
		const Value &	value
	)

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ set_() [2/4]

virtual void deepstream::CustomObject::set_	(	const std::string &	name,
		const Value &	value
	)

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ set_() [3/4]

virtual void deepstream::CustomObject::set_	(	const std::string &	name,
		const YAML::Node &	value
	)

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ set_() [4/4]

virtual void deepstream::CustomObject::set_	(	const std::string &	name,
		const YAML::Node &	value
	)

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ take() [1/2]

Object& deepstream::Object::take ( GstObject * object )

inherited

Takes the ownership of a object through the opaque pointer.

◆ take() [2/2]

Object& deepstream::Object::take ( GstObject * object )

inherited

Takes the ownership of a object through the opaque pointer.

◆ type() [1/2]

static unsigned long deepstream::SignalHandler::type ( )

staticinherited

Return the type id assigned to signal handler.

◆ type() [2/2]

static unsigned long deepstream::SignalHandler::type ( )

staticinherited

Return the type id assigned to signal handler.

Field Documentation

◆ data_consumer_

std::unique_ptr< IDataConsumer > deepstream::DataReceiver::data_consumer_

protected

Definition at line 95 of file service-maker/includes/data_receiver.hpp.

◆ object_

GstObject * deepstream::Object::object_

protectedinherited

Definition at line 198 of file service-maker/includes/object.hpp.

Referenced by deepstream::Object::getGObject(), deepstream::Object::operator bool(), and deepstream::Object::operator==().

◆ param_spec_

std::string deepstream::CustomObject::param_spec_

protectedinherited

property spec in YAML format

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

◆ properties_

std::map< std::string, Object::Value > deepstream::CustomObject::properties_

protectedinherited

property map

Definition at line 53 of file service-maker/includes/custom_object.hpp.

◆ provider_

std::unique_ptr< IActionProvider > deepstream::SignalHandler::provider_

protectedinherited

Definition at line 91 of file service-maker/includes/signal_handler.hpp.

◆ retries_

unsigned int deepstream::DataReceiver::retries_

protected

Definition at line 96 of file service-maker/includes/data_receiver.hpp.

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

service-maker/includes/data_receiver.hpp


NVIDIA DeepStream SDK API Reference	8.0 Release

NVIDIA DeepStream SDK API Reference

8.0 Release

Detailed Description

Data Structures

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ DataReceiver() [1/4]

◆ DataReceiver() [2/4]

◆ ~DataReceiver() [1/2]

◆ DataReceiver() [3/4]

◆ DataReceiver() [4/4]

◆ ~DataReceiver() [2/2]

Member Function Documentation

◆ connectSignal() [1/2]

◆ connectSignal() [2/2]

◆ consume() [1/2]

◆ consume() [2/2]

◆ emitSignal() [1/2]

◆ emitSignal() [2/2]

◆ get_() [1/2]

◆ get_() [2/2]

◆ getCallbackFn() [1/2]

◆ getCallbackFn() [2/2]

◆ getGObject() [1/2]

◆ getGObject() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getProperty() [1/2]

◆ getProperty() [2/2]

◆ give() [1/2]

◆ give() [2/2]

◆ listSignals() [1/2]

◆ listSignals() [2/2]

◆ operator bool() [1/2]

◆ operator bool() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ seize() [1/2]

◆ seize() [2/2]

◆ set() [1/6]

◆ set() [2/6]

◆ set() [3/6]

◆ set() [4/6]

◆ set() [5/6]

◆ set() [6/6]

◆ set_() [1/4]

◆ set_() [2/4]

◆ set_() [3/4]

◆ set_() [4/4]

◆ take() [1/2]

◆ take() [2/2]

◆ type() [1/2]

◆ type() [2/2]

Field Documentation

◆ data_consumer_

◆ object_

◆ param_spec_

◆ properties_

◆ provider_

◆ retries_