Custom Message Functions APIΒΆ

group gst_message_plugin

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

DeepStream GStreamer plugins post the following custom messages:

  • Stream EOS - Posted by the NvStreamMuxer element when it recieves EOS on one of its sink pads.

Functions

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 Stream ID of the stream for which EOS has been received.

Return

A pointer to the new message.

gboolean gst_nvmessage_is_stream_eos(GstMessage *message)

Determines whether a message is a stream EOS message.

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

Return

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

gboolean gst_nvmessage_parse_stream_eos(GstMessage *message, guint *eos_stream_id)

Parses the stream ID from a stream EOS message.

The stream ID is the index of the stream which sent the EOS event to Gst-streammux.

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

Return

A Boolean; true if the message was successfully parsed.