Metadata Extensions¶

group metadata_extensions

Defines metadata structures used to describe metadata objects.

Typedefs

typedef enum NvDsEventType NvDsEventType: Defines event type flags.

typedef enum NvDsObjectType NvDsObjectType: Defines object type flags.

typedef enum NvDsPayloadType NvDsPayloadType: Defines payload type flags.

typedef struct NvDsRect NvDsRect: Holds a rectangle’s position and size.

typedef struct NvDsGeoLocation NvDsGeoLocation: Holds geolocation parameters.

typedef struct NvDsCoordinate NvDsCoordinate: Hold a coordinate’s position.

typedef struct NvDsObjectSignature NvDsObjectSignature: Holds an object’s signature.

typedef struct NvDsVehicleObject NvDsVehicleObject: Holds a vehicle object’s parameters.

typedef struct NvDsPersonObject NvDsPersonObject: Holds a person object’s parameters.

typedef struct NvDsFaceObject NvDsFaceObject: Holds a face object’s parameters.

typedef struct NvDsVehicleObjectExt NvDsVehicleObjectExt: Holds a vehicle object’s parameters.

typedef struct NvDsPersonObjectExt NvDsPersonObjectExt: Holds a person object’s parameters.

typedef struct NvDsFaceObjectWithExt NvDsFaceObjectExt¶: Holds a face object’s parameters.

typedef struct NvDsEventMsgMeta 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.

typedef struct _NvDsEvent NvDsEvent¶: Holds event information.

typedef struct NvDsPayload NvDsPayload: Holds payload metadata.

Enums

enum NvDsEventType¶

Defines event type flags.

Values:

enumerator NVDS_EVENT_ENTRY¶

enumerator NVDS_EVENT_EXIT¶

enumerator NVDS_EVENT_MOVING¶

enumerator NVDS_EVENT_STOPPED¶

enumerator NVDS_EVENT_EMPTY¶

enumerator NVDS_EVENT_PARKED¶

enumerator NVDS_EVENT_RESET¶

enumerator NVDS_EVENT_RESERVED¶

Reserved for future use.

Custom events must be assigned values greater than this.

enumerator NVDS_EVENT_CUSTOM¶: Specifies a custom event.

enumerator NVDS_EVENT_FORCE32¶

enum NvDsObjectType¶

Defines object type flags.

Values:

enumerator NVDS_OBJECT_TYPE_VEHICLE¶

enumerator NVDS_OBJECT_TYPE_PERSON¶

enumerator NVDS_OBJECT_TYPE_FACE¶

enumerator NVDS_OBJECT_TYPE_BAG¶

enumerator NVDS_OBJECT_TYPE_BICYCLE¶

enumerator NVDS_OBJECT_TYPE_ROADSIGN¶

enumerator NVDS_OBJECT_TYPE_VEHICLE_EXT¶

enumerator NVDS_OBJECT_TYPE_PERSON_EXT¶

enumerator NVDS_OBJECT_TYPE_FACE_EXT¶

enumerator NVDS_OBJECT_TYPE_RESERVED¶

Reserved for future use.

Custom objects must be assigned values greater than this.

enumerator NVDS_OBJECT_TYPE_CUSTOM¶: Specifies a custom object.

enumerator NVDS_OBJECT_TYPE_UNKNOWN¶: “object” key will be missing in the schema

enumerator NVDS_OBEJCT_TYPE_FORCE32¶

enum NvDsPayloadType¶

Defines payload type flags.

Values:

enumerator NVDS_PAYLOAD_DEEPSTREAM¶

enumerator NVDS_PAYLOAD_DEEPSTREAM_MINIMAL¶

enumerator NVDS_PAYLOAD_RESERVED¶

Reserved for future use.

Custom payloads must be assigned values greater than this.

enumerator NVDS_PAYLOAD_CUSTOM¶

Specifies a custom payload.

You must implement the nvds_msg2p_* interface.

enumerator NVDS_PAYLOAD_FORCE32¶

struct NvDsRect: #include <nvdsmeta_schema.h>
Holds a rectangle’s position and size.

struct NvDsGeoLocation: #include <nvdsmeta_schema.h>
Holds geolocation parameters.

struct NvDsCoordinate: #include <nvdsmeta_schema.h>
Hold a coordinate’s position.

struct NvDsObjectSignature: #include <nvdsmeta_schema.h>
Holds an object’s signature.

struct NvDsVehicleObject: #include <nvdsmeta_schema.h>
Holds a vehicle object’s parameters.

struct NvDsPersonObject: #include <nvdsmeta_schema.h>
Holds a person object’s parameters.

struct NvDsFaceObject: #include <nvdsmeta_schema.h>
Holds a face object’s parameters.

struct NvDsVehicleObjectExt: #include <nvdsmeta_schema.h>
Holds a vehicle object’s parameters.

struct NvDsPersonObjectExt: #include <nvdsmeta_schema.h>
Holds a person object’s parameters.

struct NvDsFaceObjectWithExt: #include <nvdsmeta_schema.h>
Holds a face object’s parameters.

struct NvDsEventMsgMeta

#include <nvdsmeta_schema.h>

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.

struct _NvDsEvent: #include <nvdsmeta_schema.h>
Holds event information.

struct NvDsPayload: #include <nvdsmeta_schema.h>
Holds payload metadata.