Custom message functions

Detailed Description

Helper functions for custom GStreamer messages posted by DeepStream GStreamer plugins.

DeepStream GStreamer plugins post the following custom messages:

• Stream EOS - Posted by Gst-nvstreammux when it recieves EOS on one of its sink pads.

Functions
G_BEGIN_DECLS GstMessage *	gst_nvmessage_new_stream_eos (GstObject *obj, guint eos_stream_id)
	Creates a new Stream EOS message. More...
gboolean	gst_nvmessage_is_stream_eos (GstMessage *message)
	Determines whether a message is a Stream EOS message. More...
gboolean	gst_nvmessage_parse_stream_eos (GstMessage *message, guint *eos_stream_id)
	Parses the stream ID from a Stream EOS message. More...

Function Documentation

gboolean gst_nvmessage_is_stream_eos

(

GstMessage *

message

)

Determines whether a message is a Stream EOS message.

params[in] message The GstMessage to be checked.

Returns

A boolean indicating whether the message is a stream eos message.

G_BEGIN_DECLS GstMessage* gst_nvmessage_new_stream_eos	(	GstObject *	obj,
		guint	eos_stream_id
	)

Creates a new Stream EOS message.

params[in] obj The GStreamer object creating the message. params[in] eos_stream_id ID of stream for which EOS has been received.

Returns

A pointer to the newly created message.

gboolean gst_nvmessage_parse_stream_eos	(	GstMessage *	message,
		guint *	eos_stream_id
	)

Parses the stream ID from a Stream EOS message.

This ID is the index of the stream which sent the EOS event to the stream muxer.

params[in] message A Stream EOS message. params[out] eos_stream_id A pointer to an unsigned integer in which the function is to place the stream ID.

return A boolean indicating whether the message was successfully parsed.