NVIDIA DeepStream SDK API Reference

4.0 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
Metadata Extension Structures

Detailed Description

Data Structures

struct  NvDsRect
 Holds rectangle parameters. More...
 
struct  NvDsGeoLocation
 Holds Geo-location parameters. More...
 
struct  NvDsCoordinate
 Hold coordinate parameters. More...
 
struct  NvDsObjectSignature
 Holds object signature. More...
 
struct  NvDsVehicleObject
 Holds vehicle object parameters. More...
 
struct  NvDsPersonObject
 Holds person object parameters. More...
 
struct  NvDsFaceObject
 Holds face parameters. More...
 
struct  NvDsEventMsgMeta
 Holds event message meta data. More...
 
struct  _NvDsEvent
 Holds event information. More...
 
struct  NvDsPayload
 Holds payload meta data. More...
 

Typedefs

typedef enum NvDsEventType NvDsEventType
 Event type flags. More...
 
typedef enum NvDsObjectType NvDsObjectType
 Object type flags. More...
 
typedef enum NvDsPayloadType NvDsPayloadType
 Payload type flags. More...
 
typedef struct NvDsRect NvDsRect
 Holds rectangle parameters. More...
 
typedef struct NvDsGeoLocation NvDsGeoLocation
 Holds Geo-location parameters. More...
 
typedef struct NvDsCoordinate NvDsCoordinate
 Hold coordinate parameters. More...
 
typedef struct NvDsObjectSignature NvDsObjectSignature
 Holds object signature. More...
 
typedef struct NvDsVehicleObject NvDsVehicleObject
 Holds vehicle object parameters. More...
 
typedef struct NvDsPersonObject NvDsPersonObject
 Holds person object parameters. More...
 
typedef struct NvDsFaceObject NvDsFaceObject
 Holds face parameters. More...
 
typedef struct NvDsEventMsgMeta NvDsEventMsgMeta
 Holds event message meta data. More...
 
typedef struct _NvDsEvent NvDsEvent
 Holds event information. More...
 
typedef struct NvDsPayload NvDsPayload
 Holds payload meta data. 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
}
 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_RESERVED = 0x100,
  NVDS_OBJECT_TYPE_CUSTOM = 0x101,
  NVDS_OBEJCT_TYPE_FORCE32 = 0x7FFFFFFF
}
 Object type flags. More...
 
enum  NvDsPayloadType {
  NVDS_PAYLOAD_DEEPSTREAM,
  NVDS_PAYLOAD_DEEPSTREAM_MINIMAL,
  NVDS_PAYLOAD_RESERVED = 0x100,
  NVDS_PAYLOAD_CUSTOM = 0x101,
  NVDS_PAYLOAD_FORCE32 = 0x7FFFFFFF
}
 Payload type flags. More...
 

Typedef Documentation

Hold coordinate parameters.

typedef struct _NvDsEvent NvDsEvent

Holds event information.

Holds event message meta data.

Various types of objects (e.g. Vehicle, Person, Face etc.) can be attached by allocating that object and setting extMsg pointer.

Similarly custom object can also be allocated and set to extMsg and should be handled by meta data parsing module accordingly.

Event type flags.

Holds face parameters.

Holds Geo-location parameters.

Holds object signature.

Object type flags.

typedef struct NvDsPayload NvDsPayload

Holds payload meta data.

Payload type flags.

Holds person object parameters.

typedef struct NvDsRect NvDsRect

Holds rectangle parameters.

Holds vehicle object parameters.

Enumeration Type Documentation

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.

Use value greater than this for custom events.

NVDS_EVENT_CUSTOM 

To support custom event.

NVDS_EVENT_FORCE32 

Definition at line 39 of file nvdsmeta_schema.h.

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_RESERVED 

Reserved for future use.

Use value greater than this for custom objects.

NVDS_OBJECT_TYPE_CUSTOM 

To support custom object.

NVDS_OBEJCT_TYPE_FORCE32 

Definition at line 57 of file nvdsmeta_schema.h.

Payload type flags.

Enumerator
NVDS_PAYLOAD_DEEPSTREAM 
NVDS_PAYLOAD_DEEPSTREAM_MINIMAL 
NVDS_PAYLOAD_RESERVED 

Reserved for future use.

Use value greater than this for custom payloads.

NVDS_PAYLOAD_CUSTOM 

To support custom payload.

User need to implement nvds_msg2p_* interface

NVDS_PAYLOAD_FORCE32 

Definition at line 74 of file nvdsmeta_schema.h.