NVIDIA DeepStream SDK API Reference

9.2 Release
sources/libs/gstnvdscustomhelper/gst-nvdscustomevent.h File Reference

Detailed Description

NVIDIA GStreamer DeepStream: Custom Events

Description: This file specifies the NVIDIA DeepStream GStreamer custom event functions, used to map events to individual sources which are batched together by Gst-nvstreammux.

Definition in file sources/libs/gstnvdscustomhelper/gst-nvdscustomevent.h.

Go to the source code of this file.

Data Structures

struct  RoiDimension
 Defines Roi structure for GST_NVCUSTOMEVENT_ROI_UPDATE custom event. More...
 

Macros

#define FLAG(name)   GST_EVENT_TYPE_##name
 

Typedefs

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_ANALYTICS_RELOAD_CONFIG_UPDATE = GST_EVENT_MAKE_TYPE (409, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_NVTRACKER_CONFIG_UPDATE = GST_EVENT_MAKE_TYPE (410, 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)),
  GST_NVEVENT_ANALYTICS_RELOAD_CONFIG_UPDATE = GST_EVENT_MAKE_TYPE (409, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_NVTRACKER_CONFIG_UPDATE = GST_EVENT_MAKE_TYPE (410, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_MODEL_LOAD = GST_EVENT_MAKE_TYPE (411, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_MODEL_UNLOAD = GST_EVENT_MAKE_TYPE (412, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_MODEL_UPDATE = GST_EVENT_MAKE_TYPE (413, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_STREAM_MODEL_BIND = GST_EVENT_MAKE_TYPE (414, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_MODEL_ROUTING = GST_EVENT_MAKE_TYPE (415, 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)),
  GST_NVEVENT_ANALYTICS_RELOAD_CONFIG_UPDATE = GST_EVENT_MAKE_TYPE (409, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_NVTRACKER_CONFIG_UPDATE = GST_EVENT_MAKE_TYPE (410, 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)),
  GST_NVEVENT_ANALYTICS_RELOAD_CONFIG_UPDATE = GST_EVENT_MAKE_TYPE (409, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_NVTRACKER_CONFIG_UPDATE = GST_EVENT_MAKE_TYPE (410, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_MODEL_LOAD = GST_EVENT_MAKE_TYPE (411, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_MODEL_UNLOAD = GST_EVENT_MAKE_TYPE (412, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_MODEL_UPDATE = GST_EVENT_MAKE_TYPE (413, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_STREAM_MODEL_BIND = GST_EVENT_MAKE_TYPE (414, FLAG (DOWNSTREAM) | FLAG (SERIALIZED)),
  GST_NVEVENT_MODEL_ROUTING = GST_EVENT_MAKE_TYPE (415, FLAG (DOWNSTREAM) | FLAG (SERIALIZED))
}
 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_nvtracker_config_update (gchar *stream_id, gchar *configStr)
 Creates a new "nv-tracker-config-update" event. More...
 
void gst_nvevent_parse_nvtracker_config_update (GstEvent *event, gchar **stream_id, gchar **configStr)
 Parses a "nv-tracker-config-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_analytics_reload_config_update (gchar *config_file_path)
 Creates a new "nv-analytics-reload_config-update" event. More...
 
void gst_nvevent_parse_analytics_reload_config_update (GstEvent *event, gchar **config_file_path)
 Parses a "nv-analytics-reload_config-update" event. More...
 
GstEvent * gst_nvevent_new_model_load (const gchar *value_json)
 Model-plane + stream-routing control events carry ONE payload: the request "value" object as verbatim JSON (the same document a REST client POSTs and an action-signal caller passes). More...
 
void gst_nvevent_parse_model_load (GstEvent *event, gchar **value_json)
 Parses a "nv-model-load" event. More...
 
GstEvent * gst_nvevent_new_model_unload (const gchar *value_json)
 Creates a new "nv-model-unload" event (verbatim JSON payload). More...
 
void gst_nvevent_parse_model_unload (GstEvent *event, gchar **value_json)
 Parses a "nv-model-unload" event. More...
 
GstEvent * gst_nvevent_new_model_update (const gchar *value_json)
 Creates a new "nv-model-update" event: IN-PLACE checkpoint transition (model plane only – never routes streams). More...
 
void gst_nvevent_parse_model_update (GstEvent *event, gchar **value_json)
 Parses a "nv-model-update" event. More...
 
GstEvent * gst_nvevent_new_model_routing (const gchar *value_json)
 Creates a new "nv-model-routing" event: the declarative routing document (routes[] + default{}), each route augmented with resolved source_ids by nvmultiurisrcbin. More...
 
void gst_nvevent_parse_model_routing (GstEvent *event, gchar **value_json)
 Parses a "nv-model-routing" event. More...
 
GstEvent * gst_nvevent_new_stream_model_bind (guint source_id, const gchar *camera_id, const gchar *camera_name, const gchar *metadata_json)
 Creates a new "nv-stream-model-bind" event carrying a stream/add's per-stream binding: the assigned source_id, camera_id, camera_name (display name) and the raw metadata JSON (which may name primary/shadow models). More...
 
void gst_nvevent_parse_stream_model_bind (GstEvent *event, guint *source_id, gchar **camera_id, gchar **camera_name, gchar **metadata_json)
 Parses a "nv-stream-model-bind" event. More...