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 
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 {
52  NVDS_EVENT_FORCE32 = 0x7FFFFFFF
54 
58 typedef enum NvDsObjectType {
74 
78 typedef enum NvDsPayloadType {
87  NVDS_PAYLOAD_FORCE32 = 0x7FFFFFFF
89 
93 typedef struct NvDsRect {
94  float top;
95  float left;
96  float width;
97  float height;
98 } NvDsRect;
99 
103 typedef struct NvDsGeoLocation {
104  gdouble lat;
105  gdouble lon;
106  gdouble alt;
108 
112 typedef struct NvDsCoordinate {
113  gdouble x;
114  gdouble y;
115  gdouble z;
117 
121 typedef struct NvDsObjectSignature {
123  gdouble *signature;
125  guint size;
127 
131 typedef struct NvDsVehicleObject {
132  gchar *type;
133  gchar *make;
134  gchar *model;
135  gchar *color;
136  gchar *region;
137  gchar *license;
139 
143 typedef struct NvDsPersonObject {
144  gchar *gender;
145  gchar *hair;
146  gchar *cap;
148  gchar *apparel;
150  guint age;
152 
156 typedef struct NvDsFaceObject {
157  gchar *gender;
158  gchar *hair;
159  gchar *cap;
161  gchar *glasses;
163  gchar *facialhair;
164  gchar *name;
165  gchar *eyecolor;
166  guint age;
168 
178 typedef struct NvDsEventMsgMeta {
194  gint sensorId;
196  gint moduleId;
198  gint placeId;
202  gint frameId;
204  gdouble confidence;
208  gchar *ts;
210  gchar *objectId;
211 
213  gchar *sensorStr;
216  gchar *otherAttrs;
218  gchar *videoPath;
222  gpointer extMsg;
224  guint extMsgSize;
226 
230 typedef struct _NvDsEvent {
235 } NvDsEvent;
236 
240 typedef struct NvDsPayload {
242  gpointer payload;
244  guint payloadSize;
247  guint componentId;
248 } NvDsPayload;
249 
250 #ifdef __cplusplus
251 }
252 #endif
253 #endif /* NVDSMETA_H_ */
254 
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.
Reserved for future use.
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.
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.
gchar * make
Holds a pointer to the make of the vehicle.
NvDsObjectType
Defines object type flags.
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.
"object" key will be missing in the schema
NvDsGeoLocation location
Holds the object's geolocation.
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.
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.
float height
Holds the rectangle's height in pixels.
float left
Holds the position of rectangle's left side in pixels.
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.
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.
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.
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.
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.
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 * videoPath
Holds a pointer to the name of the video file.
gdouble y
Holds the coordinate's Y position.
Holds an object's signature.
NvDsObjectType objType
Holds the object's type.
NvDsEventType
Defines event type flags.
float width
Holds the rectangle's width in pixels.
gchar * objectId
Holds a pointer to the detected or inferred object's ID.
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.