Detailed Description

Specifies GStreamer custom event functions, used to map events to individual sources which are batched together by Gst-nvstreammux.

Data Structures
struct	RoiDimension
	Defines Roi structure for GST_NVCUSTOMEVENT_ROI_UPDATE custom event. More...

Macros
#define	FLAG(name) GST_EVENT_TYPE_##name

#define	FLAG(name) GST_EVENT_TYPE_##name

Typedefs
typedef struct RoiDimension	RoiDimension
	Defines Roi structure for GST_NVCUSTOMEVENT_ROI_UPDATE custom event. More...

Enumerations
enum	GstNvCustomEventType { GST_NVEVENT_ROI_UPDATE = GST_EVENT_MAKE_TYPE (406, FLAG(DOWNSTREAM) \| FLAG(SERIALIZED)), GST_NVEVENT_INFER_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (407, FLAG(DOWNSTREAM) \| FLAG(SERIALIZED)) }
	Defines supported types of custom events. More...

enum	GstNvEventType { GST_NVEVENT_PAD_ADDED = GST_EVENT_MAKE_TYPE (400, FLAG(DOWNSTREAM) \| FLAG(SERIALIZED)), GST_NVEVENT_PAD_DELETED = GST_EVENT_MAKE_TYPE (401, FLAG(DOWNSTREAM) \| FLAG(SERIALIZED)), GST_NVEVENT_STREAM_EOS = GST_EVENT_MAKE_TYPE (402, FLAG(DOWNSTREAM) \| FLAG(SERIALIZED)), GST_NVEVENT_STREAM_SEGMENT = GST_EVENT_MAKE_TYPE (403, FLAG(DOWNSTREAM) \| FLAG(SERIALIZED)), GST_NVEVENT_STREAM_RESET = GST_EVENT_MAKE_TYPE (404, FLAG(DOWNSTREAM) \| FLAG(SERIALIZED)), GST_NVEVENT_STREAM_START = GST_EVENT_MAKE_TYPE (405, FLAG(DOWNSTREAM) \| FLAG(SERIALIZED)) }
	Defines supported types of custom events. More...

Functions
GstEvent *	gst_nvevent_new_roi_update (gchar stream_id, guint roi_count, RoiDimension roi_dim)
	Creates a new "roi-update" event. More...

void	gst_nvevent_parse_roi_update (GstEvent event, gchar stream_id, guint roi_count, RoiDimension **roi_dim)
	Parses a "roi-update" event received on the sinkpad. More...

GstEvent *	gst_nvevent_infer_interval_update (gchar *stream_id, guint interval)
	Creates a new "nv-infer-interval-update" event. More...

void	gst_nvevent_parse_infer_interval_update (GstEvent event, gchar stream_id, guint interval)
	Parses a "nv-infer-interval-update" event received on the sinkpad. More...

GstEvent *	gst_nvevent_new_pad_added (guint source_id)
	Creates a "custom pad added" event for the specified source. More...

GstEvent *	gst_nvevent_new_pad_deleted (guint source_id)
	Creates a "custom pad deleted" event for the specified source. More...

GstEvent *	gst_nvevent_new_stream_eos (guint source_id)
	Creates a "custom EOS" event for the specified source. More...

GstEvent *	gst_nvevent_new_stream_segment (guint source_id, GstSegment *segment)
	Creates a "custom segment" event for the specified source. More...

GstEvent *	gst_nvevent_new_stream_reset (guint source_id)
	Creates a "custom reset" event for the specified source. More...

void	gst_nvevent_parse_pad_added (GstEvent event, guint source_id)
	Parses a "pad added" event received on the sinkpad. More...

void	gst_nvevent_parse_pad_deleted (GstEvent event, guint source_id)
	Parses a "pad deleted" event received on the sinkpad. More...

void	gst_nvevent_parse_stream_eos (GstEvent event, guint source_id)
	Parses a "stream EOS" event received on the sinkpad. More...

void	gst_nvevent_parse_stream_segment (GstEvent event, guint source_id, GstSegment **segment)
	Parses a "stream segment" event received on the sinkpad. More...

void	gst_nvevent_parse_stream_reset (GstEvent event, guint source_id)
	Parses a "stream reset" event received on the sinkpad. More...

GstEvent *	gst_nvevent_new_stream_start (guint source_id, gchar *stream_id)
	Creates a new "stream start" event. More...

void	gst_nvevent_parse_stream_start (GstEvent event, guint source_id, gchar **stream_id)
	Parses a "stream start" event received on the sinkpad. More...

Macro Definition Documentation

◆ FLAG [1/2]

#define FLAG ( name ) GST_EVENT_TYPE_##name

Definition at line 40 of file gst-nvevent.h.

◆ FLAG [2/2]

#define FLAG ( name ) GST_EVENT_TYPE_##name

Definition at line 63 of file gst-nvcustomevent.h.

Typedef Documentation

◆ RoiDimension

typedef struct RoiDimension RoiDimension

Defines Roi structure for GST_NVCUSTOMEVENT_ROI_UPDATE custom event.

Enumeration Type Documentation

◆ GstNvCustomEventType

enum GstNvCustomEventType

Defines supported types of custom events.

Enumerator
GST_NVEVENT_ROI_UPDATE	Specifies a custom event to indicate ROI update for preprocess of a particular stream in a batch.
GST_NVEVENT_INFER_INTERVAL_UPDATE	Specifies a custom event to indicate infer interval update of a particular stream in a batch.

Definition at line 66 of file gst-nvcustomevent.h.

◆ GstNvEventType

enum GstNvEventType

Defines supported types of custom events.

Enumerator
GST_NVEVENT_PAD_ADDED	Specifies a custom event to indicate Pad Added.
GST_NVEVENT_PAD_DELETED	Specifies a custom event to indicate Pad Deleted.
GST_NVEVENT_STREAM_EOS	Specifies a custom event to indicate EOS of a particular stream in a batch.
GST_NVEVENT_STREAM_SEGMENT	Specifies a custom event to indicate a stream segment.
GST_NVEVENT_STREAM_RESET	Specifies a custom event to indicate reset of a particular stream in a batch.
GST_NVEVENT_STREAM_START	Specifies a custom event to indicate start of a particular stream in a batch.

Definition at line 43 of file gst-nvevent.h.

Function Documentation

◆ gst_nvevent_infer_interval_update()

GstEvent* gst_nvevent_infer_interval_update	(	gchar *	stream_id,
		guint	interval
	)

Creates a new "nv-infer-interval-update" event.

Parameters

[out]	stream_id	Stream ID of the stream for which infer-interval-update is to be sent
[out]	interval	The infer interval obtained corresponding to stream ID for the event.

◆ gst_nvevent_new_pad_added()

GstEvent* gst_nvevent_new_pad_added ( guint source_id )

Creates a "custom pad added" event for the specified source.

Parameters

[in] source_id Source ID of the stream to be added to the pipeline; also the pad ID of the sinkpad of the Gst-nvstreammux plugin for which the source is configured.

Returns: A pointer to the event corresponding to the request if successful, or NULL otherwise.

◆ gst_nvevent_new_pad_deleted()

GstEvent* gst_nvevent_new_pad_deleted ( guint source_id )

Creates a "custom pad deleted" event for the specified source.

Parameters

[in] source_id Source ID of the stream to be removed from the pipeline; also the pad ID of the sinkpad of the Gst-nvstreammux plugin for which the source is configured.

Returns: A pointer to the event corresponding to the request if successful, or NULL otherwise.

◆ gst_nvevent_new_roi_update()

GstEvent* gst_nvevent_new_roi_update	(	gchar *	stream_id,
		guint	roi_count,
		RoiDimension *	roi_dim
	)

Creates a new "roi-update" event.

Parameters

[out]	stream_id	Stream ID of the stream for which nv-roi-update is to be sent
[out]	roi_count	The roi_count obtained corresponding to stream ID for the event.
[out]	roi_dim	The RoiDimension structure of size roi_count.

◆ gst_nvevent_new_stream_eos()

GstEvent* gst_nvevent_new_stream_eos ( guint source_id )

Creates a "custom EOS" event for the specified source.

Parameters

[in] source_id Source ID of the stream for which EOS is to be sent; also the pad ID of the sinkpad of the Gst-nvstreammux plugin for which the source is configured.

Returns: A pointer to the event corresponding to request if sucxessful, or NULL otherwise.

◆ gst_nvevent_new_stream_reset()

GstEvent* gst_nvevent_new_stream_reset ( guint source_id )

Creates a "custom reset" event for the specified source.

Parameters

[in] source_id Source ID of the stream for which reset is to be sent; also the pad ID of the sinkpad of the Gst-nvstreammux plugin for which the source is configured.

Returns: A pointer to the event corresponding to request if sucxessful, or NULL otherwise.

◆ gst_nvevent_new_stream_segment()

GstEvent* gst_nvevent_new_stream_segment	(	guint	source_id,
		GstSegment *	segment
	)

Creates a "custom segment" event for the specified source.

Parameters

[in]	source_id	Source ID of the stream for which a segment event is to be sent; also the pad ID of the sinkpad of the Gst-nvstreammux plugin for which the source is configured.
[in]	segment	A pointer to a copy of the segment to be sent with the event; corresponds to the original segment for the specified source.

Returns: A pointer to the event corresponding to the request if successful, or NULL otherwise.

◆ gst_nvevent_new_stream_start()

GstEvent* gst_nvevent_new_stream_start	(	guint	source_id,
		gchar *	stream_id
	)

Creates a new "stream start" event.

Parameters

[out]	source_id	Source ID of the stream for which stream-start is to be sent
[out]	stream_id	The stream-id string obtained from sink pad with gst_pad_get_stream_id(pad) corresponding to source ID for the event.

◆ gst_nvevent_parse_infer_interval_update()

void gst_nvevent_parse_infer_interval_update	(	GstEvent *	event,
		gchar **	stream_id,
		guint *	interval
	)

Parses a "nv-infer-interval-update" event received on the sinkpad.

Parameters

[in]	event	The event received on the sinkpad when the stream ID sends a infer-interval-update event.
[out]	stream_id	A pointer to the parsed stream ID for which the event is sent.
[out]	interval	A pointer to the parsed interval corresponding to stream ID for the event.

◆ gst_nvevent_parse_pad_added()

void gst_nvevent_parse_pad_added	(	GstEvent *	event,
		guint *	source_id
	)

Parses a "pad added" event received on the sinkpad.

Parameters

[in]	event	A pointer to the event received on the sinkpad when the pad is added to Gst-nvstreammux.
[out]	source_id	A pointer to the parsed source ID for the event.

◆ gst_nvevent_parse_pad_deleted()

void gst_nvevent_parse_pad_deleted	(	GstEvent *	event,
		guint *	source_id
	)

Parses a "pad deleted" event received on the sinkpad.

Parameters

[in]	event	A pointer to the event received on the sinkpad when the pad is deleted from Gst-nvstreammux.
[out]	source_id	A pointer to the parsed source ID for the event.

◆ gst_nvevent_parse_roi_update()

void gst_nvevent_parse_roi_update	(	GstEvent *	event,
		gchar **	stream_id,
		guint *	roi_count,
		RoiDimension **	roi_dim
	)

Parses a "roi-update" event received on the sinkpad.

Parameters

[in]	event	The event received on the sinkpad when the stream ID sends a nv-roi-update event.
[out]	stream_id	A pointer to the parsed stream ID for which the event is sent.
[out]	roi_count	A pointer to the parsed number of roi(s) corresponding to stream ID for the event.
[out]	roi_dim	A double pointer to the parsed RoiDimension structure of size roi_count. User MUST free roi_dim memory using g_free post usage.

◆ gst_nvevent_parse_stream_eos()

void gst_nvevent_parse_stream_eos	(	GstEvent *	event,
		guint *	source_id
	)

Parses a "stream EOS" event received on the sinkpad.

Parameters

[in]	event	A pointer to the event received on the sinkpad when the source ID sends the EOS event.
[out]	source_id	A pointer to the parsed source ID for the event.

◆ gst_nvevent_parse_stream_reset()

void gst_nvevent_parse_stream_reset	(	GstEvent *	event,
		guint *	source_id
	)

Parses a "stream reset" event received on the sinkpad.

Parameters

[in]	event	A pointer to the event received on the sinkpad when the source ID sends the reset event.
[out]	source_id	A pointer to the parsed source ID for the event.

◆ gst_nvevent_parse_stream_segment()

void gst_nvevent_parse_stream_segment	(	GstEvent *	event,
		guint *	source_id,
		GstSegment **	segment
	)

Parses a "stream segment" event received on the sinkpad.

Parameters

[in]	event	The event received on the sinkpad when the source ID sends a segment event.
[out]	source_id	A pointer to the parsed source ID for which the event is sent.
[out]	segment	A double pointer to the parsed segment corresponding to source ID for the event.

◆ gst_nvevent_parse_stream_start()

void gst_nvevent_parse_stream_start	(	GstEvent *	event,
		guint *	source_id,
		gchar **	stream_id
	)

Parses a "stream start" event received on the sinkpad.

Parameters

[in]	event	The event received on the sinkpad when the source ID sends a stream-start event.
[out]	source_id	A pointer to the parsed source ID for which the event is sent.
[out]	segment	A double pointer to the parsed stream-id corresponding to source ID for the event.

NVIDIA DeepStream SDK API Reference

6.2 Release

Detailed Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ FLAG [1/2]

◆ FLAG [2/2]

Typedef Documentation

◆ RoiDimension

Enumeration Type Documentation

◆ GstNvCustomEventType

◆ GstNvEventType

Function Documentation

◆ gst_nvevent_infer_interval_update()

◆ gst_nvevent_new_pad_added()

◆ gst_nvevent_new_pad_deleted()

◆ gst_nvevent_new_roi_update()

◆ gst_nvevent_new_stream_eos()

◆ gst_nvevent_new_stream_reset()

◆ gst_nvevent_new_stream_segment()

◆ gst_nvevent_new_stream_start()

◆ gst_nvevent_parse_infer_interval_update()

◆ gst_nvevent_parse_pad_added()

◆ gst_nvevent_parse_pad_deleted()

◆ gst_nvevent_parse_roi_update()

◆ gst_nvevent_parse_stream_eos()

◆ gst_nvevent_parse_stream_reset()

◆ gst_nvevent_parse_stream_segment()

◆ gst_nvevent_parse_stream_start()