NVIDIA DeepStream SDK API Reference

5.0 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Messages: Custom Message Functions API

Detailed Description

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

DeepStream GStreamer plugins post the following custom messages:

Functions

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 A pointer to the nessage to be checked.

Returns
A Boolean; true if the message is a stream EOS message.
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.

Returns
A pointer to the new 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.

Returns
A Boolean; true if the message was successfully parsed.