NVIDIA DeepStream SDK API Reference

4.0.1 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
nvdsmeta_schema.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018, NVIDIA CORPORATION. All rights reserved.
3  *
4  * NVIDIA Corporation and its licensors retain all intellectual property
5  * and proprietary rights in and to this software, related documentation
6  * and any modifications thereto. Any use, reproduction, disclosure or
7  * distribution of this software and related documentation without an express
8  * license agreement from NVIDIA Corporation is strictly prohibited.
9  *
10  */
11 
26 #ifndef NVDSMETA_H_
27 #define NVDSMETA_H_
28 
29 #include <glib.h>
30 
31 #ifdef __cplusplus
32 extern "C"
33 {
34 #endif
35 
39 typedef enum NvDsEventType {
51  NVDS_EVENT_FORCE32 = 0x7FFFFFFF
53 
57 typedef enum NvDsObjectType {
71 
75 typedef enum NvDsPayloadType {
82  NVDS_PAYLOAD_FORCE32 = 0x7FFFFFFF
84 
88 typedef struct NvDsRect {
89  gint top;
90  gint left;
91  gint width;
92  gint height;
93 } NvDsRect;
94 
98 typedef struct NvDsGeoLocation {
99  gdouble lat;
100  gdouble lon;
101  gdouble alt;
103 
107 typedef struct NvDsCoordinate {
108  gdouble x;
109  gdouble y;
110  gdouble z;
112 
116 typedef struct NvDsObjectSignature {
118  gdouble *signature;
120  guint size;
122 
126 typedef struct NvDsVehicleObject {
127  gchar *type;
128  gchar *make;
129  gchar *model;
130  gchar *color;
131  gchar *region;
132  gchar *license;
134 
138 typedef struct NvDsPersonObject {
139  gchar *gender;
140  gchar *hair;
141  gchar *cap;
142  gchar *apparel;
143  guint age;
145 
149 typedef struct NvDsFaceObject {
150  gchar *gender;
151  gchar *hair;
152  gchar *cap;
153  gchar *glasses;
154  gchar *facialhair;
155  gchar *name;
156  gchar *eyecolor;
157  guint age;
159 
169 typedef struct NvDsEventMsgMeta {
185  gint sensorId;
187  gint moduleId;
189  gint placeId;
193  gint frameId;
195  gdouble confidence;
199  gchar *ts;
201  gchar *objectId;
203  gchar *sensorStr;
205  gchar *otherAttrs;
207  gchar *videoPath;
214  gpointer extMsg;
216  guint extMsgSize;
218 
222 typedef struct _NvDsEvent {
227 } NvDsEvent;
228 
232 typedef struct NvDsPayload {
234  gpointer payload;
236  guint payloadSize;
238  guint componentId;
239 } NvDsPayload;
240 
241 #ifdef __cplusplus
242 }
243 #endif
244 #endif /* NVDSMETA_H_ */
245 
gpointer payload
pointer to payload
gdouble * signature
array of signature values.
struct NvDsFaceObject NvDsFaceObject
Holds face parameters.
Holds person object parameters.
Reserved for future use.
guint payloadSize
size of payload
gint objClassId
class id of object
NvDsRect bbox
bounding box of object
To support custom object.
guint extMsgSize
size of custom object
struct NvDsPersonObject NvDsPersonObject
Holds person object parameters.
gint moduleId
id of analytics module that generated the event
NvDsEventType eventType
type of event
NvDsObjectType
Object type flags.
NvDsEventMsgMeta * metadata
pointer of event meta data.
Reserved for future use.
"object" key will be missing in the schema
NvDsGeoLocation location
Geo-location of object.
NvDsPayloadType
Payload type flags.
gint trackingId
tracking id of object
gdouble confidence
confidence of inference
Holds payload meta data.
struct NvDsEventMsgMeta NvDsEventMsgMeta
Holds event message meta data.
gint componentId
id of component that generated this event
Reserved for future use.
struct NvDsObjectSignature NvDsObjectSignature
Holds object signature.
To support custom payload.
gint placeId
id of place related to the object
Holds event message meta data.
gchar * ts
time stamp of generated event
struct NvDsCoordinate NvDsCoordinate
Hold coordinate parameters.
gint sensorId
id of sensor that generated the event
struct NvDsPayload NvDsPayload
Holds payload meta data.
gint frameId
video frame id of this event
To support custom event.
struct NvDsGeoLocation NvDsGeoLocation
Holds Geo-location parameters.
guint componentId
id of component who attached the payload (Optional)
gchar * sensorStr
Identity string of sensor.
struct _NvDsEvent NvDsEvent
Holds event information.
Holds event information.
NvDsEventType type
type of event
Holds vehicle object parameters.
struct NvDsRect NvDsRect
Holds rectangle parameters.
guint size
size of array
Holds Geo-location parameters.
struct NvDsVehicleObject NvDsVehicleObject
Holds vehicle object parameters.
NvDsObjectSignature objSignature
signature of object
NvDsCoordinate coordinate
coordinate of object
gchar * otherAttrs
other attributes associated with the object
Hold coordinate parameters.
Holds rectangle parameters.
gchar * videoPath
name of video file
Holds object signature.
NvDsObjectType objType
type of object
NvDsEventType
Event type flags.
gchar * objectId
label of detected / inferred object
Holds face parameters.
gpointer extMsg
To extend the event message meta data.