NVIDIA DeepStream SDK API Reference

5.0 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-2020, 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 
29 #ifndef NVDSMETA_H_
30 #define NVDSMETA_H_
31 
32 #include <glib.h>
33 
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif
38 
42 typedef enum NvDsEventType {
50 
56  NVDS_EVENT_FORCE32 = 0x7FFFFFFF
58 
62 typedef enum NvDsObjectType {
81 
85 typedef enum NvDsPayloadType {
94  NVDS_PAYLOAD_FORCE32 = 0x7FFFFFFF
96 
100 typedef struct NvDsRect {
101  float top;
102  float left;
103  float width;
104  float height;
105 } NvDsRect;
106 
110 typedef struct NvDsGeoLocation {
111  gdouble lat;
112  gdouble lon;
113  gdouble alt;
115 
119 typedef struct NvDsCoordinate {
120  gdouble x;
121  gdouble y;
122  gdouble z;
124 
128 typedef struct NvDsObjectSignature {
130  gdouble *signature;
132  guint size;
134 
138 typedef struct NvDsVehicleObject {
139  gchar *type;
140  gchar *make;
141  gchar *model;
142  gchar *color;
143  gchar *region;
144  gchar *license;
146 
150 typedef struct NvDsPersonObject {
151  gchar *gender;
152  gchar *hair;
153  gchar *cap;
155  gchar *apparel;
157  guint age;
159 
163 typedef struct NvDsFaceObject {
164  gchar *gender;
165  gchar *hair;
166  gchar *cap;
168  gchar *glasses;
170  gchar *facialhair;
171  gchar *name;
172  gchar *eyecolor;
173  guint age;
175 
179 typedef struct NvDsVehicleObjectExt {
180  gchar *type;
181  gchar *make;
182  gchar *model;
183  gchar *color;
184  gchar *region;
185  gchar *license;
187  GList *mask;
189 
193 typedef struct NvDsPersonObjectExt {
194  gchar *gender;
195  gchar *hair;
196  gchar *cap;
198  gchar *apparel;
200  guint age;
202  GList *mask;
204 
208 typedef struct NvDsFaceObjectWithExt {
209  gchar *gender;
210  gchar *hair;
211  gchar *cap;
213  gchar *glasses;
215  gchar *facialhair;
216  gchar *name;
217  gchar *eyecolor;
218  guint age;
220  GList *mask;
222 
232 typedef struct NvDsEventMsgMeta {
248  gint sensorId;
250  gint moduleId;
252  gint placeId;
256  gint frameId;
258  gdouble confidence;
262  gchar *ts;
264  gchar *objectId;
265 
267  gchar *sensorStr;
270  gchar *otherAttrs;
272  gchar *videoPath;
276  gpointer extMsg;
278  guint extMsgSize;
280 
284 typedef struct _NvDsEvent {
289 } NvDsEvent;
290 
294 typedef struct NvDsPayload {
296  gpointer payload;
298  guint payloadSize;
301  guint componentId;
302 } NvDsPayload;
303 
304 #ifdef __cplusplus
305 }
306 #endif
307 #endif /* NVDSMETA_H_ */
308 
gchar * eyecolor
Holds a pointer to the person's eye color.
gchar * apparel
Holds a pointer to a description of the person's apparel.
gpointer payload
Holds a pointer to the payload.
gdouble * signature
Holds a pointer to an array of signature values.
struct NvDsFaceObject NvDsFaceObject
Holds a face object's parameters.
Holds a person object's parameters.
gchar * eyecolor
Holds a pointer to the person's eye color.
Reserved for future use.
Holds a vehicle object's parameters.
guint payloadSize
Holds the size of the payload.
gint objClassId
Holds the object's class ID.
NvDsRect bbox
Holds the object's bounding box.
Specifies a custom object.
guint extMsgSize
Holds the size of the custom object at extMsg.
guint age
Holds the person's age.
struct NvDsPersonObject NvDsPersonObject
Holds a person object's parameters.
gint moduleId
Holds the ID of the analytics module that generated the event.
gchar * name
Holds a pointer to the person's name.
NvDsEventType eventType
Holds the type of event.
gchar * license
Holds a pointer to the license number of the vehicle.
GList * mask
Holds a list of polygons for face mask.
Holds a person object's parameters.
gchar * make
Holds a pointer to the make of the vehicle.
struct NvDsPersonObjectExt NvDsPersonObjectExt
Holds a person object's parameters.
NvDsObjectType
Defines object type flags.
gchar * model
Holds a pointer to the model of the vehicle.
gchar * facialhair
Holds a pointer to the person's facial hair color.
gdouble alt
Holds the location's altitude.
NvDsEventMsgMeta * metadata
Holds a pointer to event metadata.
Reserved for future use.
gdouble lon
Holds the location's longitude.
gchar * color
Holds a pointer to the color of the vehicle.
struct NvDsFaceObjectWithExt NvDsFaceObjectExt
Holds a face object's parameters.
"object" key will be missing in the schema
NvDsGeoLocation location
Holds the object's geolocation.
gchar * license
Holds a pointer to the license number of the vehicle.
gchar * region
Holds a pointer to the region of the vehicle.
gchar * type
Holds a pointer to the type of the vehicle.
NvDsPayloadType
Defines payload type flags.
gint trackingId
Holds the object's tracking ID.
gdouble confidence
Holds the confidence level of the inference.
Holds payload metadata.
struct NvDsEventMsgMeta NvDsEventMsgMeta
Holds event message meta data.
gchar * glasses
Holds a pointer to the type of glasses the person is wearing, if any.
gint componentId
Holds the ID of the component (plugin) that generated this event.
gchar * glasses
Holds a pointer to the type of glasses the person is wearing, if any.
gchar * color
Holds a pointer to the color of the vehicle.
float height
Holds the rectangle's height in pixels.
gchar * type
Holds a pointer to the type of the vehicle.
gchar * hair
Holds a pointer to the person's hair color.
float left
Holds the position of rectangle's left side in pixels.
gchar * region
Holds a pointer to the region of the vehicle.
gchar * gender
Holds a pointer to the person's gender.
gchar * hair
Holds a pointer to the person's hair color.
Reserved for future use.
struct NvDsObjectSignature NvDsObjectSignature
Holds an object's signature.
gchar * cap
Holds a pointer to the type of cap the person is wearing, if any.
Specifies a custom payload.
gchar * make
Holds a pointer to the make of the vehicle.
gint placeId
Holds the ID of the place related to the object.
Holds event message meta data.
gchar * gender
Holds a pointer to the person's gender.
GList * mask
Holds a list of polygons for person mask.
gchar * ts
Holds a pointer to the generated event's timestamp.
struct NvDsCoordinate NvDsCoordinate
Hold a coordinate's position.
gint sensorId
Holds the ID of the sensor that generated the event.
struct NvDsPayload NvDsPayload
Holds payload metadata.
gint frameId
Holds the video frame ID of this event.
gchar * hair
Holds a pointer to the person's hair color.
gchar * name
Holds a pointer to the person's name.
Specifies a custom event.
struct NvDsGeoLocation NvDsGeoLocation
Holds geolocation parameters.
guint componentId
Holds the ID of the component (plugin) which attached the payload (optional).
gchar * sensorStr
Holds a pointer to a string containing the sensor's identity.
Holds a face object's parameters.
gchar * facialhair
Holds a pointer to the person's facial hair color.
gchar * apparel
Holds a pointer to a description of the person's apparel.
float top
Holds the position of rectangle's top in pixels.
struct _NvDsEvent NvDsEvent
Holds event information.
Holds event information.
NvDsEventType type
Holds the event's type.
Holds a vehicle object's parameters.
struct NvDsRect NvDsRect
Holds a rectangle's position and size.
guint size
Holds the number of signature values in signature.
Holds geolocation parameters.
struct NvDsVehicleObject NvDsVehicleObject
Holds a vehicle object's parameters.
gdouble x
Holds the coordinate's X position.
gchar * cap
Holds a pointer to the type of cap the person is wearing, if any.
GList * mask
Holds a list of polygons for vehicle mask.
NvDsObjectSignature objSignature
Holds the object's signature.
NvDsCoordinate coordinate
Holds the object's coordinates.
gdouble z
Holds the coordinate's Z position.
gchar * otherAttrs
Holds a pointer to a string containing other attributes associated with the object.
Hold a coordinate's position.
guint age
Holds the person's age.
Holds a rectangle's position and size.
gchar * hair
Holds a pointer to the person's hair color.
gchar * gender
Holds a pointer to the person's gender.
gchar * videoPath
Holds a pointer to the name of the video file.
gdouble y
Holds the coordinate's Y position.
Holds an object's signature.
gchar * cap
Holds a pointer to the type of cap the person is wearing, if any.
NvDsObjectType objType
Holds the object's type.
NvDsEventType
Defines event type flags.
float width
Holds the rectangle's width in pixels.
gchar * gender
Holds a pointer to the person's gender.
struct NvDsVehicleObjectExt NvDsVehicleObjectExt
Holds a vehicle object's parameters.
gchar * objectId
Holds a pointer to the detected or inferred object's ID.
gchar * cap
Holds a pointer to the type of cap the person is wearing, if any.
gdouble lat
Holds the location's latitude.
guint age
Holds the person's age.
Holds a face object's parameters.
gchar * model
Holds a pointer to the model of the vehicle.
gpointer extMsg
Holds a pointer to event message meta data.
guint age
Holds the person's age.