NVIDIA DeepStream SDK API Reference

7.1 Release
Metadata Extension Structures

Detailed Description

Defines metadata structures used to describe metadata objects.

Data Structures

struct  NvDsRect
 Holds a rectangle's position and size. More...
 
struct  NvDsGeoLocation
 Holds geolocation parameters. More...
 
struct  NvDsCoordinate
 Hold a coordinate's position. More...
 
struct  NvDsObjectSignature
 Holds an object's signature. More...
 
struct  NvDsProductObjectExt
 Holds a product object's parameters. More...
 
struct  NvDsVehicleObject
 Holds a vehicle object's parameters. More...
 
struct  NvDsPersonObject
 Holds a person object's parameters. More...
 
struct  NvDsFaceObject
 Holds a face object's parameters. More...
 
struct  NvDsVehicleObjectExt
 Holds a vehicle object's parameters. More...
 
struct  NvDsPersonObjectExt
 Holds a person object's parameters. More...
 
struct  NvDsFaceObjectWithExt
 Holds a face object's parameters. More...
 
struct  NvDsJoint
 Holds a joint's position and confidence. More...
 
struct  NvDsJoints
 Holds a body pose's joint points. More...
 
struct  NvDsEmbedding
 Holds an embedding model's parameters. More...
 
struct  NvDsProductObject
 Holds a product object's parameters. More...
 
struct  NvDsConvexHull
 Holds 2D convex hull metadata. More...
 
struct  NvDs3DTracking
 Holds Single View 3D Tracking metadata. More...
 
struct  NvDsEventMsgMeta
 Holds event message meta data. More...
 
struct  _NvDsEvent
 Holds event information. More...
 
struct  _NvDsCustomMsgInfo
 Holds data for any user defined custom message to be attached to the payload message : custom message to be attached size : size of the custom message. More...
 
struct  NvDsPayload
 Holds payload metadata. More...
 

Typedefs

typedef enum NvDsEventType NvDsEventType
 Defines event type flags. More...
 
typedef enum NvDsObjectType NvDsObjectType
 Defines object type flags. More...
 
typedef enum NvDsPayloadType NvDsPayloadType
 Defines payload type flags. More...
 
typedef struct NvDsRect NvDsRect
 Holds a rectangle's position and size. More...
 
typedef struct NvDsGeoLocation NvDsGeoLocation
 Holds geolocation parameters. More...
 
typedef struct NvDsCoordinate NvDsCoordinate
 Hold a coordinate's position. More...
 
typedef struct NvDsObjectSignature NvDsObjectSignature
 Holds an object's signature. More...
 
typedef struct NvDsProductObjectExt NvDsProductObjectExt
 Holds a product object's parameters. More...
 
typedef struct NvDsVehicleObject NvDsVehicleObject
 Holds a vehicle object's parameters. More...
 
typedef struct NvDsPersonObject NvDsPersonObject
 Holds a person object's parameters. More...
 
typedef struct NvDsFaceObject NvDsFaceObject
 Holds a face object's parameters. More...
 
typedef struct NvDsVehicleObjectExt NvDsVehicleObjectExt
 Holds a vehicle object's parameters. More...
 
typedef struct NvDsPersonObjectExt NvDsPersonObjectExt
 Holds a person object's parameters. More...
 
typedef struct NvDsFaceObjectWithExt NvDsFaceObjectExt
 Holds a face object's parameters. More...
 
typedef struct NvDsJoint NvDsJoint
 Holds a joint's position and confidence. More...
 
typedef struct NvDsJoints NvDsJoints
 Holds a body pose's joint points. More...
 
typedef struct NvDsEmbedding NvDsEmbedding
 Holds an embedding model's parameters. More...
 
typedef struct NvDsProductObject NvDsProductObject
 Holds a product object's parameters. More...
 
typedef struct NvDsConvexHull NvDsConvexHull
 Holds 2D convex hull metadata. More...
 
typedef struct NvDs3DTracking NvDs3DTracking
 Holds Single View 3D Tracking metadata. More...
 
typedef struct NvDsEventMsgMeta NvDsEventMsgMeta
 Holds event message meta data. More...
 
typedef struct _NvDsEvent NvDsEvent
 Holds event information. More...
 
typedef struct _NvDsCustomMsgInfo NvDsCustomMsgInfo
 Holds data for any user defined custom message to be attached to the payload message : custom message to be attached size : size of the custom message. More...
 
typedef struct NvDsPayload NvDsPayload
 Holds payload metadata. More...
 

Enumerations

enum  NvDsEventType {
  NVDS_EVENT_ENTRY,
  NVDS_EVENT_EXIT,
  NVDS_EVENT_MOVING,
  NVDS_EVENT_STOPPED,
  NVDS_EVENT_EMPTY,
  NVDS_EVENT_PARKED,
  NVDS_EVENT_RESET,
  NVDS_EVENT_RESERVED = 0x100,
  NVDS_EVENT_CUSTOM = 0x101,
  NVDS_EVENT_FORCE32 = 0x7FFFFFFF
}
 Defines event type flags. More...
 
enum  NvDsObjectType {
  NVDS_OBJECT_TYPE_VEHICLE,
  NVDS_OBJECT_TYPE_PERSON,
  NVDS_OBJECT_TYPE_FACE,
  NVDS_OBJECT_TYPE_BAG,
  NVDS_OBJECT_TYPE_BICYCLE,
  NVDS_OBJECT_TYPE_ROADSIGN,
  NVDS_OBJECT_TYPE_VEHICLE_EXT,
  NVDS_OBJECT_TYPE_PERSON_EXT,
  NVDS_OBJECT_TYPE_FACE_EXT,
  NVDS_OBJECT_TYPE_PRODUCT,
  NVDS_OBJECT_TYPE_PRODUCT_EXT,
  NVDS_OBJECT_TYPE_RESERVED = 0x100,
  NVDS_OBJECT_TYPE_CUSTOM = 0x101,
  NVDS_OBJECT_TYPE_UNKNOWN = 0x102,
  NVDS_OBEJCT_TYPE_FORCE32 = 0x7FFFFFFF
}
 Defines object type flags. More...
 
enum  NvDsPayloadType {
  NVDS_PAYLOAD_DEEPSTREAM,
  NVDS_PAYLOAD_DEEPSTREAM_MINIMAL,
  NVDS_PAYLOAD_DEEPSTREAM_PROTOBUF,
  NVDS_PAYLOAD_RESERVED = 0x100,
  NVDS_PAYLOAD_CUSTOM = 0x101,
  NVDS_PAYLOAD_FORCE32 = 0x7FFFFFFF
}
 Defines payload type flags. More...
 

Typedef Documentation

◆ NvDs3DTracking

Holds Single View 3D Tracking metadata.

◆ NvDsConvexHull

Holds 2D convex hull metadata.

◆ NvDsCoordinate

Hold a coordinate's position.

◆ NvDsCustomMsgInfo

Holds data for any user defined custom message to be attached to the payload message : custom message to be attached size : size of the custom message.

◆ NvDsEmbedding

typedef struct NvDsEmbedding NvDsEmbedding

Holds an embedding model's parameters.

◆ NvDsEvent

typedef struct _NvDsEvent NvDsEvent

Holds event information.

◆ NvDsEventMsgMeta

Holds event message meta data.

You can attach various types of objects (vehicle, person, face, etc.) to an event by setting a pointer to the object in extMsg.

Similarly, you can attach a custom object to an event by setting a pointer to the object in extMsg. A custom object must be handled by the metadata parsing module accordingly.

◆ NvDsEventType

Defines event type flags.

◆ NvDsFaceObject

Holds a face object's parameters.

◆ NvDsFaceObjectExt

Holds a face object's parameters.

◆ NvDsGeoLocation

Holds geolocation parameters.

◆ NvDsJoint

typedef struct NvDsJoint NvDsJoint

Holds a joint's position and confidence.

◆ NvDsJoints

typedef struct NvDsJoints NvDsJoints

Holds a body pose's joint points.

◆ NvDsObjectSignature

Holds an object's signature.

◆ NvDsObjectType

Defines object type flags.

◆ NvDsPayload

typedef struct NvDsPayload NvDsPayload

Holds payload metadata.

◆ NvDsPayloadType

Defines payload type flags.

◆ NvDsPersonObject

Holds a person object's parameters.

◆ NvDsPersonObjectExt

Holds a person object's parameters.

◆ NvDsProductObject

Holds a product object's parameters.

◆ NvDsProductObjectExt

Holds a product object's parameters.

◆ NvDsRect

typedef struct NvDsRect NvDsRect

Holds a rectangle's position and size.

◆ NvDsVehicleObject

Holds a vehicle object's parameters.

◆ NvDsVehicleObjectExt

Holds a vehicle object's parameters.

Enumeration Type Documentation

◆ NvDsEventType

Defines event type flags.

Enumerator
NVDS_EVENT_ENTRY 
NVDS_EVENT_EXIT 
NVDS_EVENT_MOVING 
NVDS_EVENT_STOPPED 
NVDS_EVENT_EMPTY 
NVDS_EVENT_PARKED 
NVDS_EVENT_RESET 
NVDS_EVENT_RESERVED 

Reserved for future use.

Custom events must be assigned values greater than this.

NVDS_EVENT_CUSTOM 

Specifies a custom event.

NVDS_EVENT_FORCE32 

Definition at line 43 of file nvdsmeta_schema.h.

◆ NvDsObjectType

Defines object type flags.

Enumerator
NVDS_OBJECT_TYPE_VEHICLE 
NVDS_OBJECT_TYPE_PERSON 
NVDS_OBJECT_TYPE_FACE 
NVDS_OBJECT_TYPE_BAG 
NVDS_OBJECT_TYPE_BICYCLE 
NVDS_OBJECT_TYPE_ROADSIGN 
NVDS_OBJECT_TYPE_VEHICLE_EXT 
NVDS_OBJECT_TYPE_PERSON_EXT 
NVDS_OBJECT_TYPE_FACE_EXT 
NVDS_OBJECT_TYPE_PRODUCT 
NVDS_OBJECT_TYPE_PRODUCT_EXT 

New Object Type for Product.

NVDS_OBJECT_TYPE_RESERVED 

New Object Type for Product.

Reserved for future use. Custom objects must be assigned values greater than this.

NVDS_OBJECT_TYPE_CUSTOM 

Specifies a custom object.

NVDS_OBJECT_TYPE_UNKNOWN 

"object" key will be missing in the schema

NVDS_OBEJCT_TYPE_FORCE32 

Definition at line 63 of file nvdsmeta_schema.h.

◆ NvDsPayloadType

Defines payload type flags.

Enumerator
NVDS_PAYLOAD_DEEPSTREAM 
NVDS_PAYLOAD_DEEPSTREAM_MINIMAL 
NVDS_PAYLOAD_DEEPSTREAM_PROTOBUF 
NVDS_PAYLOAD_RESERVED 

Reserved for future use.

Custom payloads must be assigned values greater than this.

NVDS_PAYLOAD_CUSTOM 

Specifies a custom payload.

You must implement the nvds_msg2p_* interface.

NVDS_PAYLOAD_FORCE32 

Definition at line 88 of file nvdsmeta_schema.h.