libs/gstnvdscustomhelper/gst-nvdscustommessage.h File Reference

Detailed Description

NVIDIA GStreamer DeepStream: Custom Message Functions

Description: This file specifies the NVIDIA DeepStream GStreamer custom message functions.

Definition in file libs/gstnvdscustomhelper/gst-nvdscustommessage.h.

Go to the source code of this file.

Functions
G_BEGIN_DECLS GstMessage *	gst_nvmessage_new_stream_add (GstObject *obj, NvDsSensorInfo *sensor_info)
	Creates a new Stream ADD message - denoting a new stream getting added to nvmultiurisrcbin. More...
gboolean	gst_nvmessage_is_stream_add (GstMessage *message)
	Determines whether a message is a stream ADD message. More...
gboolean	gst_nvmessage_parse_stream_add (GstMessage *message, NvDsSensorInfo *sensor_info)
	Parses the stream ID from a stream ADD message. More...
GstMessage *	gst_nvmessage_new_stream_remove (GstObject *obj, NvDsSensorInfo *sensor_info)
	Creates a new Stream REMOVE message - denoting a new stream getting removed from nvmultiurisrcbin. More...
gboolean	gst_nvmessage_is_stream_remove (GstMessage *message)
	Determines whether a message is a stream REMOVE message. More...
gboolean	gst_nvmessage_parse_stream_remove (GstMessage *message, NvDsSensorInfo *sensor_info)
	Parses the stream ID from a stream REMOVE message. More...
gboolean	gst_nvmessage_parse_fps_stream_add (GstMessage *message, NvDsFPSSensorInfo *sensor_info)
	Parses the stream ID from a stream ADD message. More...
gboolean	gst_nvmessage_parse_fps_stream_remove (GstMessage *message, NvDsFPSSensorInfo *sensor_info)
	Parses the stream ID from a stream REMOVE message. More...
GstMessage *	gst_nvmessage_force_pipeline_eos (GstObject *obj, gboolean force_eos)
	Sends custom message to force-eos on the pipeline. More...
gboolean	gst_nvmessage_parse_force_pipeline_eos (GstMessage *message, gboolean *force_eos)
	Parses the force_eos from a force eos message. More...
gboolean	gst_nvmessage_is_force_pipeline_eos (GstMessage *message)
	Determines whether a message is a force pipeline eos message. More...

Function Documentation

gst_nvmessage_force_pipeline_eos()

GstMessage* gst_nvmessage_force_pipeline_eos	(	GstObject *	obj,
		gboolean	force_eos
	)

Sends custom message to force-eos on the pipeline.

The element on which custom message related to eos is to be sent.

params[in] object A gboject on which custom message to be sent params[in] force_eos A force_eos variable

Returns

A GstMessage; The GstMessage which was successfully sent

gst_nvmessage_is_force_pipeline_eos()

gboolean gst_nvmessage_is_force_pipeline_eos

(

GstMessage *

message

)

Determines whether a message is a force pipeline eos message.

params[in] message A pointer to the message to be checked.

Returns

A Boolean; true if the message is a force pipeline message.

gst_nvmessage_is_stream_add()

gboolean gst_nvmessage_is_stream_add

(

GstMessage *

message

)

Determines whether a message is a stream ADD message.

params[in] message A pointer to the message to be checked.

Returns

A Boolean; true if the message is a stream ADD message.

gst_nvmessage_is_stream_remove()

gboolean gst_nvmessage_is_stream_remove

(

GstMessage *

message

)

Determines whether a message is a stream REMOVE message.

params[in] message A pointer to the message to be checked.

Returns

A Boolean; true if the message is a stream REMOVE message.

gst_nvmessage_new_stream_add()

G_BEGIN_DECLS GstMessage* gst_nvmessage_new_stream_add	(	GstObject *	obj,
		NvDsSensorInfo *	sensor_info
	)

Creates a new Stream ADD message - denoting a new stream getting added to nvmultiurisrcbin.

params[in] obj The GStreamer object creating the message. params[in] sensor_info Sensor info of the stream which is getting added into nvmultiurisrcbin

Returns

A pointer to the new message.

gst_nvmessage_new_stream_remove()

GstMessage* gst_nvmessage_new_stream_remove	(	GstObject *	obj,
		NvDsSensorInfo *	sensor_info
	)

Creates a new Stream REMOVE message - denoting a new stream getting removed from nvmultiurisrcbin.

params[in] obj The GStreamer object creating the message. params[in] sensor_info Sensor info of the stream which is getting removed from nvmultiurisrcbin

Returns

A pointer to the new message.

gst_nvmessage_parse_force_pipeline_eos()

gboolean gst_nvmessage_parse_force_pipeline_eos	(	GstMessage *	message,
		gboolean *	force_eos
	)

Parses the force_eos from a force eos message.

params[in] message A pointer to a force eos message. params[out] force_eos A pointer to force_eos variable

Returns

A Boolean; true if the message was successfully parsed.

gst_nvmessage_parse_fps_stream_add()

gboolean gst_nvmessage_parse_fps_stream_add	(	GstMessage *	message,
		NvDsFPSSensorInfo *	sensor_info
	)

Parses the stream ID from a stream ADD message.

The stream ID is the index of the stream which is getting added to nvmultiurisrcbin

params[in] message A pointer to a stream ADD message. params[out] stream_id A pointer to NvDsSensorInfo The string NvDsFPSSensorInfo->sensor_id should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.

Returns

A Boolean; true if the message was successfully parsed.

gst_nvmessage_parse_fps_stream_remove()

gboolean gst_nvmessage_parse_fps_stream_remove	(	GstMessage *	message,
		NvDsFPSSensorInfo *	sensor_info
	)

Parses the stream ID from a stream REMOVE message.

The stream ID is the index of the stream which is getting removed from nvmultiurisrcbin

params[in] message A pointer to a stream REMOVE message. params[out] stream_id A pointer to NvDsSensorInfo The string NvDsFPSSensorInfo->sensor_id should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.

Returns

A Boolean; true if the message was successfully parsed.

gst_nvmessage_parse_stream_add()

gboolean gst_nvmessage_parse_stream_add	(	GstMessage *	message,
		NvDsSensorInfo *	sensor_info
	)

Parses the stream ID from a stream ADD message.

The stream ID is the index of the stream which is getting added to nvmultiurisrcbin

params[in] message A pointer to a stream ADD message. params[out] stream_id A pointer to NvDsSensorInfo The string NvDsSensorInfo->sensor_id should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.

Returns

A Boolean; true if the message was successfully parsed.

gst_nvmessage_parse_stream_remove()

gboolean gst_nvmessage_parse_stream_remove	(	GstMessage *	message,
		NvDsSensorInfo *	sensor_info
	)

Parses the stream ID from a stream REMOVE message.

The stream ID is the index of the stream which is getting removed from nvmultiurisrcbin

params[in] message A pointer to a stream REMOVE message. params[out] stream_id A pointer to NvDsSensorInfo The string NvDsSensorInfo->sensor_id should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.

Returns

A Boolean; true if the message was successfully parsed.