NVIDIA DeepStream SDK API Reference

6.1 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 (void)
 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

#define FILE_NAME_SIZE   (1024)

Definition at line 32 of file nvds_obj_encode.h.

Typedef Documentation

typedef struct _NvDsObjEncCtx* NvDsObjEncCtxHandle

Opaque Handle to the Object Encoder Context.

Definition at line 36 of file nvds_obj_encode.h.

Holds output parameters.

This structure is available to the user.

Holds user parameters for a nvds_obj_enc_process call.

Function Documentation

NvDsObjEncCtxHandle nvds_obj_enc_create_context ( void  )

Create context and return a handle to NvObjEncCtx.

void nvds_obj_enc_destroy_context ( NvDsObjEncCtxHandle  )

Destroy context.

void nvds_obj_enc_finish ( NvDsObjEncCtxHandle  )

Wait for all enqueued crops to be encoded.

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.