Object Encoder API

Detailed Description

Defines APIs for Object Encoder.

Data Structures
struct	_NvDsObjEncOutParams
	Holds output parameters. More...
struct	_NvDsObjEncUsrArgs
	Holds user parameters for a nvds_obj_enc_process call. More...

Macros
#define	FILE_NAME_SIZE   (1024)

Typedefs
typedef struct _NvDsObjEncCtx *	NvDsObjEncCtxHandle
	Opaque Handle to the Object Encoder Context. More...
typedef struct _NvDsObjEncOutParams	NvDsObjEncOutParams
	Holds output parameters. More...
typedef struct _NvDsObjEncUsrArgs	NvDsObjEncUsrArgs
	Holds user parameters for a nvds_obj_enc_process call. More...

Functions
NvDsObjEncCtxHandle	nvds_obj_enc_create_context (int)
	Create context and return a handle to NvObjEncCtx. More...
bool	nvds_obj_enc_process (NvDsObjEncCtxHandle, NvDsObjEncUsrArgs *, NvBufSurface *, NvDsObjectMeta *, NvDsFrameMeta *)
	Enqueue an object crop for JPEG encode. More...
void	nvds_obj_enc_finish (NvDsObjEncCtxHandle)
	Wait for all enqueued crops to be encoded. More...
void	nvds_obj_enc_destroy_context (NvDsObjEncCtxHandle)
	Destroy context. More...

Macro Definition Documentation

FILE_NAME_SIZE

#define FILE_NAME_SIZE   (1024)

Definition at line 34 of file nvds_obj_encode.h.

Typedef Documentation

NvDsObjEncCtxHandle

typedef struct _NvDsObjEncCtx* NvDsObjEncCtxHandle

Opaque Handle to the Object Encoder Context.

Definition at line 38 of file nvds_obj_encode.h.

NvDsObjEncOutParams

typedef struct _NvDsObjEncOutParams NvDsObjEncOutParams

Holds output parameters.

This structure is available to the user.

NvDsObjEncUsrArgs

typedef struct _NvDsObjEncUsrArgs NvDsObjEncUsrArgs

Holds user parameters for a nvds_obj_enc_process call.

Function Documentation

nvds_obj_enc_create_context()

NvDsObjEncCtxHandle nvds_obj_enc_create_context

(

int

)

Create context and return a handle to NvObjEncCtx.

nvds_obj_enc_destroy_context()

void nvds_obj_enc_destroy_context

(

NvDsObjEncCtxHandle

)

Destroy context.

nvds_obj_enc_finish()

void nvds_obj_enc_finish

(

NvDsObjEncCtxHandle

)

Wait for all enqueued crops to be encoded.

nvds_obj_enc_process()

bool nvds_obj_enc_process	(	NvDsObjEncCtxHandle	,
		NvDsObjEncUsrArgs *	,
		NvBufSurface *	,
		NvDsObjectMeta *	,
		NvDsFrameMeta *
	)

Enqueue an object crop for JPEG encode.

This is a non-blocking call and user should call nvds_obj_enc_finish() to make sure all enqueued object crops have been processed.