NVIDIA DeepStream SDK API Reference

4.0.2 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 
20 #ifndef NVDSMETA_H_
21 #define NVDSMETA_H_
22 
23 #include <glib.h>
24 
25 #ifdef __cplusplus
26 extern "C"
27 {
28 #endif
29 
33 typedef enum NvDsEventType {
45  NVDS_EVENT_FORCE32 = 0x7FFFFFFF
47 
51 typedef enum NvDsObjectType {
65 
69 typedef enum NvDsPayloadType {
76  NVDS_PAYLOAD_FORCE32 = 0x7FFFFFFF
78 
82 typedef struct NvDsRect {
83  gint top;
84  gint left;
85  gint width;
86  gint height;
87 } NvDsRect;
88 
92 typedef struct NvDsGeoLocation {
93  gdouble lat;
94  gdouble lon;
95  gdouble alt;
97 
101 typedef struct NvDsCoordinate {
102  gdouble x;
103  gdouble y;
104  gdouble z;
106 
110 typedef struct NvDsObjectSignature {
112  gdouble *signature;
114  guint size;
116 
120 typedef struct NvDsVehicleObject {
121  gchar *type;
122  gchar *make;
123  gchar *model;
124  gchar *color;
125  gchar *region;
126  gchar *license;
128 
132 typedef struct NvDsPersonObject {
133  gchar *gender;
134  gchar *hair;
135  gchar *cap;
136  gchar *apparel;
137  guint age;
139 
143 typedef struct NvDsFaceObject {
144  gchar *gender;
145  gchar *hair;
146  gchar *cap;
147  gchar *glasses;
148  gchar *facialhair;
149  gchar *name;
150  gchar *eyecolor;
151  guint age;
153 
163 typedef struct NvDsEventMsgMeta {
179  gint sensorId;
181  gint moduleId;
183  gint placeId;
187  gint frameId;
189  gdouble confidence;
193  gchar *ts;
195  gchar *objectId;
197  gchar *sensorStr;
199  gchar *otherAttrs;
201  gchar *videoPath;
208  gpointer extMsg;
210  guint extMsgSize;
212 
216 typedef struct _NvDsEvent {
221 } NvDsEvent;
222 
226 typedef struct NvDsPayload {
228  gpointer payload;
230  guint payloadSize;
232  guint componentId;
233 } NvDsPayload;
234 
235 #ifdef __cplusplus
236 }
237 #endif
238 #endif /* NVDSMETA_H_ */
gpointer payload
pointer to payload
"object" key will be missing in the schema
gdouble * signature
array of signature values.
Holds person object parameters.
guint payloadSize
size of payload
gint objClassId
class id of object
NvDsRect bbox
bounding box of object
guint extMsgSize
size of custom object
struct NvDsFaceObject NvDsFaceObject
Holds face parameters.
NvDsObjectType
Object type flags.
gint moduleId
id of analytics module that generated the event
To support custom event.
NvDsEventType eventType
type of event
Reserved for future use.
To support custom payload.
NvDsEventMsgMeta * metadata
pointer of event meta data.
NvDsGeoLocation location
Geo-location of object.
struct NvDsPayload NvDsPayload
Holds payload meta data.
struct NvDsObjectSignature NvDsObjectSignature
Holds object signature.
struct NvDsCoordinate NvDsCoordinate
Hold coordinate parameters.
gint trackingId
tracking id of object
gdouble confidence
confidence of inference
Holds payload meta data.
gint componentId
id of component that generated this event
struct NvDsVehicleObject NvDsVehicleObject
Holds vehicle object parameters.
NvDsPayloadType
Payload type flags.
NvDsEventType
Event type flags.
Reserved for future use.
gint placeId
id of place related to the object
Holds event message meta data.
Reserved for future use.
gchar * ts
time stamp of generated event
gint sensorId
id of sensor that generated the event
gint frameId
video frame id of this event
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.
guint size
size of array
Holds Geo-location 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.
struct NvDsGeoLocation NvDsGeoLocation
Holds Geo-location parameters.
gchar * videoPath
name of video file
Holds object signature.
NvDsObjectType objType
type of object
To support custom object.
struct NvDsPersonObject NvDsPersonObject
Holds person object parameters.
gchar * objectId
label of detected / inferred object
Holds face parameters.
gpointer extMsg
To extend the event message meta data.
struct NvDsEventMsgMeta NvDsEventMsgMeta
Holds event message meta data.
struct NvDsRect NvDsRect
Holds rectangle parameters.