GStreamer event API

Detailed Description

Specifies GStreamer custom event functions.

Macros
#define	FLAG(name)   GST_EVENT_TYPE_##name

Enumerations
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)) }
	Defines the types of custom events supported. More...

Functions
GstEvent *	gst_nvevent_new_pad_added (guint source_id)
	Creates a custom pad added for particular source. More...
GstEvent *	gst_nvevent_new_pad_deleted (guint source_id)
	Creates a custom pad deleted event for particular source. More...
GstEvent *	gst_nvevent_new_stream_eos (guint source_id)
	Create a custom EOS event for a particular source_id. More...
GstEvent *	gst_nvevent_new_stream_segment (guint source_id, GstSegment *segment)
	Create a custom segment event for a particular source. More...
void	gst_nvevent_parse_pad_added (GstEvent *event, guint *source_id)
	Parse the pad added event received on sinkpad. More...
void	gst_nvevent_parse_pad_deleted (GstEvent *event, guint *source_id)
	Parse the pad deleted event received on sinkpad. More...
void	gst_nvevent_parse_stream_eos (GstEvent *event, guint *source_id)
	Parse the stream EOS event received on sinkpad. More...
void	gst_nvevent_parse_stream_segment (GstEvent *event, guint *source_id, GstSegment **segment)
	Parse the stream segment event received on sinkpad. More...

Macro Definition Documentation

#define FLAG

(

name

)

GST_EVENT_TYPE_##name

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

Enumeration Type Documentation

enum GstNvEventType

Defines the types of custom events supported.

Enumerator
GST_NVEVENT_PAD_ADDED	Custom event to indicate Pad Added.
GST_NVEVENT_PAD_DELETED	Custom event to indicate Pad Deleted.
GST_NVEVENT_STREAM_EOS	Custom event to indicate EOS of particular stream in a batch.
GST_NVEVENT_STREAM_SEGMENT	Custom event to indicate stream segment.

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

Function Documentation

GstEvent* gst_nvevent_new_pad_added

(

guint

source_id

)

Creates a custom pad added for particular source.

source_id[in] source_id of the stream added, which is also the pad_id of the sinkpad of nvstreammux for which the source is configured

Returns

GstEvent corresponding to request else NULL

GstEvent* gst_nvevent_new_pad_deleted

(

guint

source_id

)

Creates a custom pad deleted event for particular source.

source_id[in] source_id of the stream to be removed from pipeline, which also the pad_id of the sinkpad of the nvstreammux for which the source is configured

Returns

GstEvent corresponding to request or else NULL

GstEvent* gst_nvevent_new_stream_eos

(

guint

source_id

)

Create a custom EOS event for a particular source_id.

source_id[in] source_id for which EOS is to be sent, which is also the pad_id of the sinkpad of the nvstreammux for which the source is configured.

Returns

GstEvent corresponding to request or else NULL

GstEvent* gst_nvevent_new_stream_segment	(	guint	source_id,
		GstSegment *	segment
	)

Create a custom segment event for a particular source.

source_id[in] source_id for which a segment event is to be sent, which is also the pad_id of the sinkpad of the nvstreammux for which the source is configured. segment[in] Copy of the segment which needs to be sent along with the custom event, which corresponds to original segment for the particular source

Returns

GstEvent corresponding to request or else NULL

void gst_nvevent_parse_pad_added	(	GstEvent *	event,
		guint *	source_id
	)

Parse the pad added event received on sinkpad.

event[in] The event received on the sinkpad when a particular pad is added to nvstreammux

source_id[out] parsed source_id for which the event is sent

Returns

void.

void gst_nvevent_parse_pad_deleted	(	GstEvent *	event,
		guint *	source_id
	)

Parse the pad deleted event received on sinkpad.

event[in] The event received on the sinkpad when a particular pad is deleted from nvstreammux

source_id[out] parsed source_id for which the event is sent

Returns

void.

void gst_nvevent_parse_stream_eos	(	GstEvent *	event,
		guint *	source_id
	)

Parse the stream EOS event received on sinkpad.

event[in] The event received on the sinkpad when a particular source_id sends a EOS event

source_id[out] parsed source_id for which the event is sent

Returns

void.

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

Parse the stream segment event received on sinkpad.

event[in] The event received on the sinkpad when a particular source_id sends a segment event

source_id[out] parsed source_id for which the event is sent

segment [out] parsed segment corresponding to source _id for which the event is sent

Returns

void.