Events: Custom Events API

Detailed Description

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

Specifies GStreamer custom event functions.

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
#define	FLAG(name)   GST_EVENT_TYPE_##name
#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...
typedef struct RoiDimension	RoiDimension
	Defines Roi structure for GST_NVCUSTOMEVENT_ROI_UPDATE custom event. More...

Enumerations
enum	GstNvDsCustomEventType {   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)),   GST_NVEVENT_OSD_PROCESS_MODE_UPDATE = GST_EVENT_MAKE_TYPE (408, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),   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)),   GST_NVEVENT_OSD_PROCESS_MODE_UPDATE = GST_EVENT_MAKE_TYPE (408, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)) }
	Defines supported types of custom events. More...
enum	GstNvCustomEventType {   GST_NVEVENT_DEC_DROP_FRAME_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (500, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_SKIP_FRAME_UPDATE = GST_EVENT_MAKE_TYPE (501, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_ENABLE_LOW_LATENCY_MODE = GST_EVENT_MAKE_TYPE (502, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_BITRATE_UPDATE = GST_EVENT_MAKE_TYPE (503, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_FORCE_IDR = GST_EVENT_MAKE_TYPE (504, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_FORCE_INTRA = GST_EVENT_MAKE_TYPE (505, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_IFRAME_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (506, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_DROP_FRAME_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (500, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_SKIP_FRAME_UPDATE = GST_EVENT_MAKE_TYPE (501, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_ENABLE_LOW_LATENCY_MODE = GST_EVENT_MAKE_TYPE (502, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_BITRATE_UPDATE = GST_EVENT_MAKE_TYPE (503, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_FORCE_IDR = GST_EVENT_MAKE_TYPE (504, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_FORCE_INTRA = GST_EVENT_MAKE_TYPE (505, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_IFRAME_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (506, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)) }
	Defines supported types of custom events. More...
enum	GstNvCustomEventType {   GST_NVEVENT_DEC_DROP_FRAME_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (500, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_SKIP_FRAME_UPDATE = GST_EVENT_MAKE_TYPE (501, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_ENABLE_LOW_LATENCY_MODE = GST_EVENT_MAKE_TYPE (502, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_BITRATE_UPDATE = GST_EVENT_MAKE_TYPE (503, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_FORCE_IDR = GST_EVENT_MAKE_TYPE (504, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_FORCE_INTRA = GST_EVENT_MAKE_TYPE (505, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_IFRAME_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (506, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_DROP_FRAME_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (500, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_SKIP_FRAME_UPDATE = GST_EVENT_MAKE_TYPE (501, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_DEC_ENABLE_LOW_LATENCY_MODE = GST_EVENT_MAKE_TYPE (502, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_BITRATE_UPDATE = GST_EVENT_MAKE_TYPE (503, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_FORCE_IDR = GST_EVENT_MAKE_TYPE (504, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_FORCE_INTRA = GST_EVENT_MAKE_TYPE (505, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),   GST_NVEVENT_ENC_IFRAME_INTERVAL_UPDATE = GST_EVENT_MAKE_TYPE (506, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)) }
	Defines supported types of custom events. More...
enum	GstNvDsCustomEventType {   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)),   GST_NVEVENT_OSD_PROCESS_MODE_UPDATE = GST_EVENT_MAKE_TYPE (408, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),   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)),   GST_NVEVENT_OSD_PROCESS_MODE_UPDATE = GST_EVENT_MAKE_TYPE (408, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)) }
	Defines supported types of custom events. More...
enum	GstNvEventType {   GST_NVEVENT_PAD_ADDED,   GST_NVEVENT_PAD_DELETED,   GST_NVEVENT_STREAM_EOS,   GST_NVEVENT_STREAM_SEGMENT,   GST_NVEVENT_STREAM_RESET,   GST_NVEVENT_STREAM_START }
	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_osd_process_mode_update (gchar *stream_id, guint process_mode)
	Creates a new "nv-osd-process-mode-update" event. More...
void	gst_nvevent_parse_osd_process_mode_update (GstEvent *event, gchar **stream_id, guint *process_mode)
	Parses a "nv-osd-process-mode-update" event received on the sinkpad. More...
GstEvent *	gst_nvevent_dec_drop_frame_interval_update (gchar *stream_id, guint interval)
	Creates a new "nv-dec-drop-frame-interval-update" event. More...
void	gst_nvevent_parse_dec_drop_frame_interval_update (GstEvent *event, gchar **stream_id, guint *interval)
	Parses a "nv-dec-drop-frame-interval-update" event received on the sinkpad. More...
GstEvent *	gst_nvevent_dec_skip_frame_update (gchar *stream_id, guint frame_type)
	Creates a new "nv-dec-skip-frame-update" event. More...
void	gst_nvevent_parse_dec_skip_frame_update (GstEvent *event, gchar **stream_id, guint *frame_type)
	Parses a "nv-dec-skip-frame-update" event received on the sinkpad. More...
GstEvent *	gst_nvevent_dec_enable_low_latency_mode (gchar *stream_id, gint enable)
	Creates a new "nv-dec-enable-low-latency-mode" event. More...
void	gst_nvevent_parse_dec_enable_low_latency_mode (GstEvent *event, gchar **stream_id, gint *enable)
	Parses a "nv-dec-enable-low-latency-mode" event received on the sinkpad. More...
GstEvent *	gst_nvevent_enc_bitrate_update (gchar *stream_id, guint bitrate)
	Creates a new "nv-enc-bitrate-update" event. More...
void	gst_nvevent_parse_enc_bitrate_update (GstEvent *event, gchar **stream_id, guint *bitrate)
	Parses a "nv-enc-bitrate-update" event received on the sinkpad. More...
GstEvent *	gst_nvevent_enc_force_idr (gchar *stream_id, gint force)
	Creates a new "nv-enc-force-idr" event. More...
void	gst_nvevent_parse_enc_force_idr (GstEvent *event, gchar **stream_id, gint *force)
	Parses a "nv-enc-force-idr" event received on the sinkpad. More...
GstEvent *	gst_nvevent_enc_force_intra (gchar *stream_id, gint force)
	Creates a new "nv-enc-force-intra" event. More...
void	gst_nvevent_parse_enc_force_intra (GstEvent *event, gchar **stream_id, gint *force)
	Parses a "nv-enc-force-intra" event received on the sinkpad. More...
GstEvent *	gst_nvevent_enc_iframeinterval_update (gchar *stream_id, guint interval)
	Creates a new "nv-enc-iframeinterval-update" event. More...
void	gst_nvevent_parse_enc_iframeinterval_update (GstEvent *event, gchar **stream_id, guint *interval)
	Parses a "nv-enc-iframeinterval-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/5]

#define FLAG

(

name

)

GST_EVENT_TYPE_##name

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

FLAG [2/5]

#define FLAG

(

name

)

GST_EVENT_TYPE_##name

Definition at line 51 of file includes/gst-nvcustomevent.h.

FLAG [3/5]

#define FLAG

(

name

)

GST_EVENT_TYPE_##name

Definition at line 51 of file libs/gstnvcustomhelper/gst-nvcustomevent.h.

FLAG [4/5]

#define FLAG

(

name

)

GST_EVENT_TYPE_##name

Definition at line 65 of file includes/gst-nvdscustomevent.h.

FLAG [5/5]

#define FLAG

(

name

)

GST_EVENT_TYPE_##name

Definition at line 65 of file libs/gstnvdscustomhelper/gst-nvdscustomevent.h.

Typedef Documentation

RoiDimension [1/2]

typedef struct RoiDimension RoiDimension

Defines Roi structure for GST_NVCUSTOMEVENT_ROI_UPDATE custom event.

RoiDimension [2/2]

typedef struct RoiDimension RoiDimension

Defines Roi structure for GST_NVCUSTOMEVENT_ROI_UPDATE custom event.

Enumeration Type Documentation

GstNvCustomEventType [1/2]

enum GstNvCustomEventType

Defines supported types of custom events.

Enumerator
GST_NVEVENT_DEC_DROP_FRAME_INTERVAL_UPDATE	Specifies a custom event to indicate decoder drop frame interval update of a particular stream.
GST_NVEVENT_DEC_SKIP_FRAME_UPDATE	Specifies a custom event to indicate decoder skip frame update of a particular stream.
GST_NVEVENT_DEC_ENABLE_LOW_LATENCY_MODE	Specifies a custom event to enable decoder low-latency-mode of a particular stream.
GST_NVEVENT_ENC_BITRATE_UPDATE	Specifies a custom event to indicate encoder bitrate update of a particular stream.
GST_NVEVENT_ENC_FORCE_IDR	Specifies a custom event to indicate encoder force IDR frame of a particular stream.
GST_NVEVENT_ENC_FORCE_INTRA	Specifies a custom event to indicate encoder force Intra frame of a particular stream.
GST_NVEVENT_ENC_IFRAME_INTERVAL_UPDATE	Specifies a custom event to indicate iframe interval update of a particular stream.
GST_NVEVENT_DEC_DROP_FRAME_INTERVAL_UPDATE	Specifies a custom event to indicate decoder drop frame interval update of a particular stream.
GST_NVEVENT_DEC_SKIP_FRAME_UPDATE	Specifies a custom event to indicate decoder skip frame update of a particular stream.
GST_NVEVENT_DEC_ENABLE_LOW_LATENCY_MODE	Specifies a custom event to enable decoder low-latency-mode of a particular stream.
GST_NVEVENT_ENC_BITRATE_UPDATE	Specifies a custom event to indicate encoder bitrate update of a particular stream.
GST_NVEVENT_ENC_FORCE_IDR	Specifies a custom event to indicate encoder force IDR frame of a particular stream.
GST_NVEVENT_ENC_FORCE_INTRA	Specifies a custom event to indicate encoder force Intra frame of a particular stream.
GST_NVEVENT_ENC_IFRAME_INTERVAL_UPDATE	Specifies a custom event to indicate iframe interval update of a particular stream.

Definition at line 54 of file includes/gst-nvcustomevent.h.

GstNvCustomEventType [2/2]

enum GstNvCustomEventType

Defines supported types of custom events.

Enumerator
GST_NVEVENT_DEC_DROP_FRAME_INTERVAL_UPDATE	Specifies a custom event to indicate decoder drop frame interval update of a particular stream.
GST_NVEVENT_DEC_SKIP_FRAME_UPDATE	Specifies a custom event to indicate decoder skip frame update of a particular stream.
GST_NVEVENT_DEC_ENABLE_LOW_LATENCY_MODE	Specifies a custom event to enable decoder low-latency-mode of a particular stream.
GST_NVEVENT_ENC_BITRATE_UPDATE	Specifies a custom event to indicate encoder bitrate update of a particular stream.
GST_NVEVENT_ENC_FORCE_IDR	Specifies a custom event to indicate encoder force IDR frame of a particular stream.
GST_NVEVENT_ENC_FORCE_INTRA	Specifies a custom event to indicate encoder force Intra frame of a particular stream.
GST_NVEVENT_ENC_IFRAME_INTERVAL_UPDATE	Specifies a custom event to indicate iframe interval update of a particular stream.
GST_NVEVENT_DEC_DROP_FRAME_INTERVAL_UPDATE	Specifies a custom event to indicate decoder drop frame interval update of a particular stream.
GST_NVEVENT_DEC_SKIP_FRAME_UPDATE	Specifies a custom event to indicate decoder skip frame update of a particular stream.
GST_NVEVENT_DEC_ENABLE_LOW_LATENCY_MODE	Specifies a custom event to enable decoder low-latency-mode of a particular stream.
GST_NVEVENT_ENC_BITRATE_UPDATE	Specifies a custom event to indicate encoder bitrate update of a particular stream.
GST_NVEVENT_ENC_FORCE_IDR	Specifies a custom event to indicate encoder force IDR frame of a particular stream.
GST_NVEVENT_ENC_FORCE_INTRA	Specifies a custom event to indicate encoder force Intra frame of a particular stream.
GST_NVEVENT_ENC_IFRAME_INTERVAL_UPDATE	Specifies a custom event to indicate iframe interval update of a particular stream.

Definition at line 54 of file libs/gstnvcustomhelper/gst-nvcustomevent.h.

GstNvDsCustomEventType [1/2]

enum GstNvDsCustomEventType

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.
GST_NVEVENT_OSD_PROCESS_MODE_UPDATE	Specifies a custom event to indicate osd process mode update of a particular stream in a batch.
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.
GST_NVEVENT_OSD_PROCESS_MODE_UPDATE	Specifies a custom event to indicate osd process mode update of a particular stream in a batch.

Definition at line 68 of file includes/gst-nvdscustomevent.h.

GstNvDsCustomEventType [2/2]

enum GstNvDsCustomEventType

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.
GST_NVEVENT_OSD_PROCESS_MODE_UPDATE	Specifies a custom event to indicate osd process mode update of a particular stream in a batch.
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.
GST_NVEVENT_OSD_PROCESS_MODE_UPDATE	Specifies a custom event to indicate osd process mode update of a particular stream in a batch.

Definition at line 68 of file libs/gstnvdscustomhelper/gst-nvdscustomevent.h.

GstNvEventType

enum GstNvEventType

Defines supported types of custom events.

STICKY and STICKY_MULTI flags are used to ensure that events are not dropped in case of leaky queue.

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 47 of file gst-nvevent.h.

Function Documentation

gst_nvevent_dec_drop_frame_interval_update()

GstEvent * gst_nvevent_dec_drop_frame_interval_update	(	gchar *	stream_id,
		guint	interval
	)

Creates a new "nv-dec-drop-frame-interval-update" event.

Parameters

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

gst_nvevent_dec_enable_low_latency_mode()

GstEvent * gst_nvevent_dec_enable_low_latency_mode	(	gchar *	stream_id,
		gint	enable
	)

Creates a new "nv-dec-enable-low-latency-mode" event.

Parameters

[out]	stream_id	Stream ID of the stream for which decoder-low-latenct-mode is to be sent
[out]	enable	The decoder low latency mode to be enabled corresponding to stream ID for the event.

gst_nvevent_dec_skip_frame_update()

GstEvent * gst_nvevent_dec_skip_frame_update	(	gchar *	stream_id,
		guint	frame_type
	)

Creates a new "nv-dec-skip-frame-update" event.

Parameters

[out]	stream_id	Stream ID of the stream for which decoder-skip-frame-update is to be sent
[out]	frame_type	The decoder frame-type to be skipped obtained corresponding to stream ID for the event.

gst_nvevent_enc_bitrate_update()

GstEvent * gst_nvevent_enc_bitrate_update	(	gchar *	stream_id,
		guint	bitrate
	)

Creates a new "nv-enc-bitrate-update" event.

Parameters

[out]	stream_id	Stream ID of the stream for which encoder-bitrate-update is to be sent
[out]	bitrate	The encoder bitrate to be set corresponding to stream ID for the event.

gst_nvevent_enc_force_idr()

GstEvent * gst_nvevent_enc_force_idr	(	gchar *	stream_id,
		gint	force
	)

Creates a new "nv-enc-force-idr" event.

Parameters

[out]	stream_id	Stream ID of the stream for which encoder-force-idr is to be sent
[out]	force	The encoder force IDR frame corresponding to stream ID for the event.

gst_nvevent_enc_force_intra()

GstEvent * gst_nvevent_enc_force_intra	(	gchar *	stream_id,
		gint	force
	)

Creates a new "nv-enc-force-intra" event.

Parameters

[out]	stream_id	Stream ID of the stream for which encoder-force-intra is to be sent
[out]	force	The encoder force Intra frame corresponding to stream ID for the event.

gst_nvevent_enc_iframeinterval_update()

GstEvent * gst_nvevent_enc_iframeinterval_update	(	gchar *	stream_id,
		guint	interval
	)

Creates a new "nv-enc-iframeinterval-update" event.

Parameters

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

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_osd_process_mode_update()

GstEvent * gst_nvevent_osd_process_mode_update	(	gchar *	stream_id,
		guint	process_mode
	)

Creates a new "nv-osd-process-mode-update" event.

Parameters

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

gst_nvevent_parse_dec_drop_frame_interval_update()

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

Parses a "nv-dec-drop-frame-interval-update" event received on the sinkpad.

Parameters

[in]	event	The event received on the sinkpad when the stream ID sends a dec-drop-frame-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_dec_enable_low_latency_mode()

void gst_nvevent_parse_dec_enable_low_latency_mode	(	GstEvent *	event,
		gchar **	stream_id,
		gint *	enable
	)

Parses a "nv-dec-enable-low-latency-mode" event received on the sinkpad.

Parameters

[in]	event	The event received on the sinkpad when the stream ID sends a enable-low-latency-mode event.
[out]	stream_id	A pointer to the parsed stream ID for which the event is sent.
[out]	enable	A pointer to the parsed enable flag corresponding to stream ID for the event.

gst_nvevent_parse_dec_skip_frame_update()

void gst_nvevent_parse_dec_skip_frame_update	(	GstEvent *	event,
		gchar **	stream_id,
		guint *	frame_type
	)

Parses a "nv-dec-skip-frame-update" event received on the sinkpad.

Parameters

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

gst_nvevent_parse_enc_bitrate_update()

void gst_nvevent_parse_enc_bitrate_update	(	GstEvent *	event,
		gchar **	stream_id,
		guint *	bitrate
	)

Parses a "nv-enc-bitrate-update" event received on the sinkpad.

Parameters

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

gst_nvevent_parse_enc_force_idr()

void gst_nvevent_parse_enc_force_idr	(	GstEvent *	event,
		gchar **	stream_id,
		gint *	force
	)

Parses a "nv-enc-force-idr" event received on the sinkpad.

Parameters

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

gst_nvevent_parse_enc_force_intra()

void gst_nvevent_parse_enc_force_intra	(	GstEvent *	event,
		gchar **	stream_id,
		gint *	force
	)

Parses a "nv-enc-force-intra" event received on the sinkpad.

Parameters

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

gst_nvevent_parse_enc_iframeinterval_update()

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

Parses a "nv-enc-iframeinterval-update" event received on the sinkpad.

Parameters

[in]	event	The event received on the sinkpad when the stream ID sends a iframeinterval-update event.
[out]	stream_id	A pointer to the parsed stream ID for which the event is sent.
[out]	bitrate	A pointer to the parsed interval value corresponding to stream 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_osd_process_mode_update()

void gst_nvevent_parse_osd_process_mode_update	(	GstEvent *	event,
		gchar **	stream_id,
		guint *	process_mode
	)

Parses a "nv-osd-process-mode-update" event received on the sinkpad.

Parameters

[in]	event	The event received on the sinkpad when the stream ID sends a osd-process-mode-update event.
[out]	stream_id	A pointer to the parsed stream ID for which the event is sent.
[out]	process_mode	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.