NVIDIA DeepStream SDK API Reference

6.4 Release
API Modules
Here is a list of all modules:
[detail level 12]
 Buffer Management API moduleThis section describes types and functions of NvBufSurface application programming interface
 NvBufSurfTransform Types and FunctionsDefines types and functions of the NvBufSurfTransform application programming interface
 NvBufSurface Types and FunctionsDefines types and functions of NvBufSurface application programming interface
 Custom Gstreamer APIsThis section defines custom Gstreamer APIs
 DeepStream Metadata ExtensionDefines an API for managing GStreamer DeepStream metadata
 DeepStream Yaml Parser APIDefines an API for the GStreamer NvDsYaml plugin
 NvDsPreProcess PluginDefines an API for the GStreamer NvDsPreProcess plugin
 NvInfer PluginDefines an API for the GStreamer NvInfer plugin
 Smart RecordSpecifies APIs relating to smart recording
 server_appctx DeepStream Yaml Parser APIDefines an API for the GStreamer REST Application Server context
 DBScan Based Object Clustering APIDefines the API for DBScan-based object clustering
 Events, Messages and Query based APIsDefines Events, Messages and Query-based APIs
 Events: Custom Events APISpecifies GStreamer custom event functions, used to map events to individual sources which are batched together by Gst-nvstreammux
 Messages: Custom Message Functions APIHelper functions for custom GStreamer messages posted by DeepStream GStreamer plugins
 Query FunctionsGets information such as the batch size and the number of streams
 Global propertiesGlobal properties that apply to all surfaces and are specified under [property] group
 Gst-infer API Common ElementsDefines common elements used in the API exposed by the Gst-inference plugin
 Import Transfer Learning Toolkit Encoded ModelsDefines an API for importing Transfer Learning Toolkit encoded models
 Inference Interface APIDefines the DeepStream inference interface API. In C++, defines the NvDsInferContext class
 Logging APIDefines an API for logging and debugging DeepStream applications
 Messaging APIDefines an API for exchanging messages with remote entities and services
 Metadata APIsThis section describes types and functions of Metadata APIs programming interface
 Analytics MetadataDefines metadata concerning nvdsanalytics plugin
 Dewarping MetadataDefines metadata concerning dewarping
 Latency Measurement APIDefines an API for measuring latency in modules
 Metadata Extension StructuresDefines metadata structures used to describe metadata objects
 Metadata StructuresDefine structures that hold metadata
 Optical flow metadataDefines the optical flow metadata
 Tracker MetadataSpecifies metadata concerning tracking
 Networked Media Open Specifications (NMOS) APIDefines the DeepStream NMOS utility library (NvDsNmos) API
 Object Encoder APIDefines APIs for Object Encoder
 Object Tracker APIDefines the DeepStream object tracker API
 On-Screen Display APIDefines the functions of On-screen Display APIs
 On-Screen Display APIDefines the NvOSD library to be used to draw rectangles and text over the frame
 On-Screen Display ManagerDefines the NvOSD library to be used to draw rectangles and text over the frame
 Pre-Process MetadataSpecifies metadata concerning ROIs used in nvdspreprocess plugin
 Standard GStreamer boilerplate
 Surface propertiesSurface properties which can be different for every surface. These are specified under [surface<n>] group
 Utilities: Gstreamer utilities APISpecifies GStreamer utilities functions, used to configure the source to generate NTP Sync values
 Version Number APIDefines the API used to get the current version number of DeepStream and its dependencies
 nvinferserverCopyright (c) 2020, NVIDIA CORPORATION