NVIDIA DeepStream SDK API Reference

6.3 Release
includes/nvds_rest_server.h File Reference

Go to the source code of this file.

Data Structures

struct  NvDsDecInfo
 
struct  NvDsEncInfo
 
struct  NvDsConvInfo
 
struct  NvDsMuxInfo
 
struct  NvDsRoiInfo
 
struct  NvDsStreamInfo
 
struct  NvDsInferInfo
 
struct  NvDsOsdInfo
 
struct  NvDsAppInstanceInfo
 
struct  NvDsInferServerInfo
 
struct  NvDsResponseInfo
 
struct  NvDsServerConfig
 
struct  NvDsServerCallbacks
 

Typedefs

typedef struct NvDsDecInfo NvDsDecInfo
 
typedef struct NvDsEncInfo NvDsEncInfo
 
typedef struct NvDsConvInfo NvDsConvInfo
 
typedef struct NvDsMuxInfo NvDsMuxInfo
 
typedef struct NvDsRoiInfo NvDsRoiInfo
 
typedef struct NvDsStreamInfo NvDsStreamInfo
 
typedef struct NvDsInferInfo NvDsInferInfo
 
typedef struct NvDsOsdInfo NvDsOsdInfo
 
typedef struct NvDsAppInstanceInfo NvDsAppInstanceInfo
 
typedef struct NvDsInferServerInfo NvDsInferServerInfo
 
typedef struct NvDsResponseInfo NvDsResponseInfo
 
typedef struct NvDsServerConfig NvDsServerConfig
 
typedef struct NvDsServerCallbacks NvDsServerCallbacks
 

Enumerations

enum  NvDsDecPropFlag {
  DROP_FRAME_INTERVAL = 1 << 0,
  SKIP_FRAMES = 1 << 1,
  LOW_LATENCY_MODE = 1 << 2,
  DROP_FRAME_INTERVAL = 1 << 0,
  SKIP_FRAMES = 1 << 1,
  LOW_LATENCY_MODE = 1 << 2
}
 
enum  NvDsEncPropFlag {
  BITRATE = 1 << 0,
  FORCE_IDR = 1 << 1,
  FORCE_INTRA = 1 << 2,
  IFRAME_INTERVAL = 1 << 3,
  BITRATE = 1 << 0,
  FORCE_IDR = 1 << 1,
  FORCE_INTRA = 1 << 2,
  IFRAME_INTERVAL = 1 << 3
}
 
enum  NvDsConvPropFlag {
  SRC_CROP = 1 << 0,
  DEST_CROP = 1 << 1,
  FLIP_METHOD = 1 << 2,
  INTERPOLATION_METHOD = 1 << 3,
  SRC_CROP = 1 << 0,
  DEST_CROP = 1 << 1,
  FLIP_METHOD = 1 << 2,
  INTERPOLATION_METHOD = 1 << 3
}
 
enum  NvDsMuxPropFlag {
  BATCHED_PUSH_TIMEOUT = 1 << 0,
  MAX_LATENCY = 1 << 1,
  BATCHED_PUSH_TIMEOUT = 1 << 0,
  MAX_LATENCY = 1 << 1
}
 
enum  NvDsInferPropFlag {
  INFER_INTERVAL = 1 << 0,
  INFER_INTERVAL = 1 << 0
}
 
enum  NvDsInferServerPropFlag {
  INFERSERVER_INTERVAL = 1 << 0,
  INFERSERVER_INTERVAL = 1 << 0
}
 
enum  NvDsOsdPropFlag {
  PROCESS_MODE = 1 << 0,
  PROCESS_MODE = 1 << 0
}
 
enum  NvDsRoiPropFlag {
  ROI_UPDATE = 1 << 0,
  ROI_UPDATE = 1 << 0
}
 
enum  NvDsAppInstanceFlag {
  QUIT_APP = 1 << 0,
  QUIT_APP = 1 << 0
}
 
enum  NvDsAppInstanceStatus {
  QUIT_SUCCESS = 0,
  QUIT_FAIL,
  QUIT_SUCCESS = 0,
  QUIT_FAIL
}
 
enum  NvDsStreamStatus {
  STREAM_ADD_SUCCESS = 0,
  STREAM_ADD_FAIL,
  STREAM_REMOVE_SUCCESS,
  STREAM_REMOVE_FAIL,
  STREAM_ADD_SUCCESS = 0,
  STREAM_ADD_FAIL,
  STREAM_REMOVE_SUCCESS,
  STREAM_REMOVE_FAIL
}
 
enum  NvDsRoiStatus {
  ROI_UPDATE_SUCCESS = 0,
  ROI_UPDATE_FAIL,
  ROI_UPDATE_SUCCESS = 0,
  ROI_UPDATE_FAIL
}
 
enum  NvDsDecStatus {
  DROP_FRAME_INTERVAL_UPDATE_SUCCESS = 0,
  DROP_FRAME_INTERVAL_UPDATE_FAIL,
  SKIP_FRAMES_UPDATE_SUCCESS,
  SKIP_FRAMES_UPDATE_FAIL,
  LOW_LATENCY_MODE_UPDATE_SUCCESS,
  LOW_LATENCY_MODE_UPDATE_FAIL,
  DROP_FRAME_INTERVAL_UPDATE_SUCCESS = 0,
  DROP_FRAME_INTERVAL_UPDATE_FAIL,
  SKIP_FRAMES_UPDATE_SUCCESS,
  SKIP_FRAMES_UPDATE_FAIL,
  LOW_LATENCY_MODE_UPDATE_SUCCESS,
  LOW_LATENCY_MODE_UPDATE_FAIL
}
 
enum  NvDsEncStatus {
  BITRATE_UPDATE_SUCCESS = 0,
  BITRATE_UPDATE_FAIL,
  FORCE_IDR_UPDATE_SUCCESS,
  FORCE_IDR_UPDATE_FAIL,
  FORCE_INTRA_UPDATE_SUCCESS,
  FORCE_INTRA_UPDATE_FAIL,
  IFRAME_INTERVAL_UPDATE_SUCCESS,
  IFRAME_INTERVAL_UPDATE_FAIL,
  BITRATE_UPDATE_SUCCESS = 0,
  BITRATE_UPDATE_FAIL,
  FORCE_IDR_UPDATE_SUCCESS,
  FORCE_IDR_UPDATE_FAIL,
  FORCE_INTRA_UPDATE_SUCCESS,
  FORCE_INTRA_UPDATE_FAIL,
  IFRAME_INTERVAL_UPDATE_SUCCESS,
  IFRAME_INTERVAL_UPDATE_FAIL
}
 
enum  NvDsConvStatus {
  DEST_CROP_UPDATE_SUCCESS = 0,
  DEST_CROP_UPDATE_FAIL,
  SRC_CROP_UPDATE_SUCCESS,
  SRC_CROP_UPDATE_FAIL,
  INTERPOLATION_METHOD_UPDATE_SUCCESS,
  INTERPOLATION_METHOD_UPDATE_FAIL,
  FLIP_METHOD_UPDATE_SUCCESS,
  FLIP_METHOD_UPDATE_FAIL,
  DEST_CROP_UPDATE_SUCCESS = 0,
  DEST_CROP_UPDATE_FAIL,
  SRC_CROP_UPDATE_SUCCESS,
  SRC_CROP_UPDATE_FAIL,
  INTERPOLATION_METHOD_UPDATE_SUCCESS,
  INTERPOLATION_METHOD_UPDATE_FAIL,
  FLIP_METHOD_UPDATE_SUCCESS,
  FLIP_METHOD_UPDATE_FAIL
}
 
enum  NvDsMuxStatus {
  BATCHED_PUSH_TIMEOUT_UPDATE_SUCCESS = 0,
  BATCHED_PUSH_TIMEOUT_UPDATE_FAIL,
  MAX_LATENCY_UPDATE_SUCCESS,
  MAX_LATENCY_UPDATE_FAIL,
  BATCHED_PUSH_TIMEOUT_UPDATE_SUCCESS = 0,
  BATCHED_PUSH_TIMEOUT_UPDATE_FAIL,
  MAX_LATENCY_UPDATE_SUCCESS,
  MAX_LATENCY_UPDATE_FAIL
}
 
enum  NvDsInferStatus {
  INFER_INTERVAL_UPDATE_SUCCESS = 0,
  INFER_INTERVAL_UPDATE_FAIL,
  NVDSINFER_SUCCESS = 0,
  NVDSINFER_CONFIG_FAILED,
  NVDSINFER_CUSTOM_LIB_FAILED,
  NVDSINFER_INVALID_PARAMS,
  NVDSINFER_OUTPUT_PARSING_FAILED,
  NVDSINFER_CUDA_ERROR,
  NVDSINFER_TENSORRT_ERROR,
  NVDSINFER_RESOURCE_ERROR,
  NVDSINFER_TRITON_ERROR,
  NVDSINFER_TRTIS_ERROR = NVDSINFER_TRITON_ERROR,
  NVDSINFER_MEM_ERROR,
  NVDSINFER_UNKNOWN_ERROR,
  INFER_INTERVAL_UPDATE_SUCCESS = 0,
  INFER_INTERVAL_UPDATE_FAIL
}
 
enum  NvDsInferServerStatus {
  INFERSERVER_INTERVAL_UPDATE_SUCCESS = 0,
  INFERSERVER_INTERVAL_UPDATE_FAIL,
  INFERSERVER_INTERVAL_UPDATE_SUCCESS = 0,
  INFERSERVER_INTERVAL_UPDATE_FAIL
}
 
enum  NvDsOsdStatus {
  PROCESS_MODE_UPDATE_SUCCESS = 0,
  PROCESS_MODE_UPDATE_FAIL,
  PROCESS_MODE_UPDATE_SUCCESS = 0,
  PROCESS_MODE_UPDATE_FAIL
}
 

Functions

NvDsRestServer * nvds_rest_server_start (NvDsServerConfig *server_config, NvDsServerCallbacks *server_cb)
 
void nvds_rest_server_stop (NvDsRestServer *ctx)
 

Typedef Documentation

◆ NvDsAppInstanceInfo

◆ NvDsConvInfo

typedef struct NvDsConvInfo NvDsConvInfo

◆ NvDsDecInfo

typedef struct NvDsDecInfo NvDsDecInfo

◆ NvDsEncInfo

typedef struct NvDsEncInfo NvDsEncInfo

◆ NvDsInferInfo

typedef struct NvDsInferInfo NvDsInferInfo

◆ NvDsInferServerInfo

◆ NvDsMuxInfo

typedef struct NvDsMuxInfo NvDsMuxInfo

◆ NvDsOsdInfo

typedef struct NvDsOsdInfo NvDsOsdInfo

◆ NvDsResponseInfo

◆ NvDsRoiInfo

typedef struct NvDsRoiInfo NvDsRoiInfo

◆ NvDsServerCallbacks

◆ NvDsServerConfig

◆ NvDsStreamInfo

Enumeration Type Documentation

◆ NvDsAppInstanceFlag

Enumerator
QUIT_APP 
QUIT_APP 

Definition at line 81 of file includes/nvds_rest_server.h.

◆ NvDsAppInstanceStatus

Enumerator
QUIT_SUCCESS 
QUIT_FAIL 
QUIT_SUCCESS 
QUIT_FAIL 

Definition at line 86 of file includes/nvds_rest_server.h.

◆ NvDsConvPropFlag

Enumerator
SRC_CROP 
DEST_CROP 
FLIP_METHOD 
INTERPOLATION_METHOD 
SRC_CROP 
DEST_CROP 
FLIP_METHOD 
INTERPOLATION_METHOD 

Definition at line 47 of file includes/nvds_rest_server.h.

◆ NvDsConvStatus

Enumerator
DEST_CROP_UPDATE_SUCCESS 
DEST_CROP_UPDATE_FAIL 
SRC_CROP_UPDATE_SUCCESS 
SRC_CROP_UPDATE_FAIL 
INTERPOLATION_METHOD_UPDATE_SUCCESS 
INTERPOLATION_METHOD_UPDATE_FAIL 
FLIP_METHOD_UPDATE_SUCCESS 
FLIP_METHOD_UPDATE_FAIL 
DEST_CROP_UPDATE_SUCCESS 
DEST_CROP_UPDATE_FAIL 
SRC_CROP_UPDATE_SUCCESS 
SRC_CROP_UPDATE_FAIL 
INTERPOLATION_METHOD_UPDATE_SUCCESS 
INTERPOLATION_METHOD_UPDATE_FAIL 
FLIP_METHOD_UPDATE_SUCCESS 
FLIP_METHOD_UPDATE_FAIL 

Definition at line 128 of file includes/nvds_rest_server.h.

◆ NvDsDecPropFlag

Enumerator
DROP_FRAME_INTERVAL 
SKIP_FRAMES 
LOW_LATENCY_MODE 
DROP_FRAME_INTERVAL 
SKIP_FRAMES 
LOW_LATENCY_MODE 

Definition at line 32 of file includes/nvds_rest_server.h.

◆ NvDsDecStatus

Enumerator
DROP_FRAME_INTERVAL_UPDATE_SUCCESS 
DROP_FRAME_INTERVAL_UPDATE_FAIL 
SKIP_FRAMES_UPDATE_SUCCESS 
SKIP_FRAMES_UPDATE_FAIL 
LOW_LATENCY_MODE_UPDATE_SUCCESS 
LOW_LATENCY_MODE_UPDATE_FAIL 
DROP_FRAME_INTERVAL_UPDATE_SUCCESS 
DROP_FRAME_INTERVAL_UPDATE_FAIL 
SKIP_FRAMES_UPDATE_SUCCESS 
SKIP_FRAMES_UPDATE_FAIL 
LOW_LATENCY_MODE_UPDATE_SUCCESS 
LOW_LATENCY_MODE_UPDATE_FAIL 

Definition at line 106 of file includes/nvds_rest_server.h.

◆ NvDsEncPropFlag

Enumerator
BITRATE 
FORCE_IDR 
FORCE_INTRA 
IFRAME_INTERVAL 
BITRATE 
FORCE_IDR 
FORCE_INTRA 
IFRAME_INTERVAL 

Definition at line 39 of file includes/nvds_rest_server.h.

◆ NvDsEncStatus

Enumerator
BITRATE_UPDATE_SUCCESS 
BITRATE_UPDATE_FAIL 
FORCE_IDR_UPDATE_SUCCESS 
FORCE_IDR_UPDATE_FAIL 
FORCE_INTRA_UPDATE_SUCCESS 
FORCE_INTRA_UPDATE_FAIL 
IFRAME_INTERVAL_UPDATE_SUCCESS 
IFRAME_INTERVAL_UPDATE_FAIL 
BITRATE_UPDATE_SUCCESS 
BITRATE_UPDATE_FAIL 
FORCE_IDR_UPDATE_SUCCESS 
FORCE_IDR_UPDATE_FAIL 
FORCE_INTRA_UPDATE_SUCCESS 
FORCE_INTRA_UPDATE_FAIL 
IFRAME_INTERVAL_UPDATE_SUCCESS 
IFRAME_INTERVAL_UPDATE_FAIL 

Definition at line 116 of file includes/nvds_rest_server.h.

◆ NvDsInferPropFlag

Enumerator
INFER_INTERVAL 
INFER_INTERVAL 

Definition at line 61 of file includes/nvds_rest_server.h.

◆ NvDsInferServerPropFlag

Enumerator
INFERSERVER_INTERVAL 
INFERSERVER_INTERVAL 

Definition at line 66 of file includes/nvds_rest_server.h.

◆ NvDsInferServerStatus

Enumerator
INFERSERVER_INTERVAL_UPDATE_SUCCESS 
INFERSERVER_INTERVAL_UPDATE_FAIL 
INFERSERVER_INTERVAL_UPDATE_SUCCESS 
INFERSERVER_INTERVAL_UPDATE_FAIL 

Definition at line 154 of file includes/nvds_rest_server.h.

◆ NvDsInferStatus

Enumerator
INFER_INTERVAL_UPDATE_SUCCESS 
INFER_INTERVAL_UPDATE_FAIL 
NVDSINFER_SUCCESS 

NvDsInferContext operation succeeded.

NVDSINFER_CONFIG_FAILED 

Failed to configure the NvDsInferContext instance possibly due to an erroneous initialization property.

NVDSINFER_CUSTOM_LIB_FAILED 

Custom Library interface implementation failed.

NVDSINFER_INVALID_PARAMS 

Invalid parameters were supplied.

NVDSINFER_OUTPUT_PARSING_FAILED 

Output parsing failed.

NVDSINFER_CUDA_ERROR 

CUDA error was encountered.

NVDSINFER_TENSORRT_ERROR 

TensorRT interface failed.

NVDSINFER_RESOURCE_ERROR 

Resource error was encountered.

NVDSINFER_TRITON_ERROR 

Triton error was encountered.

Renamed TRT-IS to Triton.

NVDSINFER_TRTIS_ERROR 

[deprecated]TRT-IS error was encountered

NVDSINFER_MEM_ERROR 

Cuda Memory error was encountered.

NVDSINFER_UNKNOWN_ERROR 

Unknown error was encountered.

INFER_INTERVAL_UPDATE_SUCCESS 
INFER_INTERVAL_UPDATE_FAIL 

Definition at line 148 of file includes/nvds_rest_server.h.

◆ NvDsMuxPropFlag

Enumerator
BATCHED_PUSH_TIMEOUT 
MAX_LATENCY 
BATCHED_PUSH_TIMEOUT 
MAX_LATENCY 

Definition at line 55 of file includes/nvds_rest_server.h.

◆ NvDsMuxStatus

Enumerator
BATCHED_PUSH_TIMEOUT_UPDATE_SUCCESS 
BATCHED_PUSH_TIMEOUT_UPDATE_FAIL 
MAX_LATENCY_UPDATE_SUCCESS 
MAX_LATENCY_UPDATE_FAIL 
BATCHED_PUSH_TIMEOUT_UPDATE_SUCCESS 
BATCHED_PUSH_TIMEOUT_UPDATE_FAIL 
MAX_LATENCY_UPDATE_SUCCESS 
MAX_LATENCY_UPDATE_FAIL 

Definition at line 140 of file includes/nvds_rest_server.h.

◆ NvDsOsdPropFlag

Enumerator
PROCESS_MODE 
PROCESS_MODE 

Definition at line 71 of file includes/nvds_rest_server.h.

◆ NvDsOsdStatus

Enumerator
PROCESS_MODE_UPDATE_SUCCESS 
PROCESS_MODE_UPDATE_FAIL 
PROCESS_MODE_UPDATE_SUCCESS 
PROCESS_MODE_UPDATE_FAIL 

Definition at line 160 of file includes/nvds_rest_server.h.

◆ NvDsRoiPropFlag

Enumerator
ROI_UPDATE 
ROI_UPDATE 

Definition at line 76 of file includes/nvds_rest_server.h.

◆ NvDsRoiStatus

Enumerator
ROI_UPDATE_SUCCESS 
ROI_UPDATE_FAIL 
ROI_UPDATE_SUCCESS 
ROI_UPDATE_FAIL 

Definition at line 100 of file includes/nvds_rest_server.h.

◆ NvDsStreamStatus

Enumerator
STREAM_ADD_SUCCESS 
STREAM_ADD_FAIL 
STREAM_REMOVE_SUCCESS 
STREAM_REMOVE_FAIL 
STREAM_ADD_SUCCESS 
STREAM_ADD_FAIL 
STREAM_REMOVE_SUCCESS 
STREAM_REMOVE_FAIL 

Definition at line 92 of file includes/nvds_rest_server.h.

Function Documentation

◆ nvds_rest_server_start()

NvDsRestServer* nvds_rest_server_start ( NvDsServerConfig server_config,
NvDsServerCallbacks server_cb 
)

◆ nvds_rest_server_stop()

void nvds_rest_server_stop ( NvDsRestServer *  ctx)