NVIDIA DeepStream SDK Developer Guide

DeepStream Getting Started

• Welcome to the DeepStream Documentation
  • NVIDIA DeepStream Overview
• Migration Guide
  • Additional Resources
• Installation
  • Jetson Setup
  • dGPU Setup for Ubuntu
  • dGPU on ARM Setup for Ubuntu (Alpha)
  • dGPU Setup for RedHat Enterprise Linux (RHEL)
  • Platform and OS Compatibility
• Quickstart Guide
  • Jetson Setup
  • dGPU Setup for Ubuntu
  • dGPU Setup for RedHat Enterprise Linux (RHEL)
  • How to visualize the output if the display is not attached to the system
  • DeepStream Triton Inference Server Usage Guidelines
  • Using DLA for inference
• Docker Containers
  • Prerequisites

DeepStream Samples

• C/C++ Sample Apps Source Details
  • Plugin and Library Source Details
• Python Sample Apps and Bindings Source Details
  • Sample Application Source Details
  • Python Bindings and Application Development
  • MetaData Access
• DeepStream Reference Application - deepstream-app
  • Application Architecture
  • Reference Application Configuration
  • Configuration Groups
  • Application Tuning for DeepStream SDK
• DeepStream Reference Application - deepstream-test5 app
  • IoT Protocols supported and cloud configuration
  • Message consumer
  • Smart Record - Event based recording
  • OTA model update
  • Sensor Provisioning Support over REST API (Runtime sensor add/remove capability)
• DeepStream Reference Application - deepstream-audio app
  • DeepStream Audio Reference Application Architecture and Sample Graphs
• DeepStream Reference Application - deepstream-nmos app
  • Application Architecture
  • Using Easy-NMOS for NMOS Registry and Controller
• DeepStream Reference Application on GitHub
  • Use case applications
  • AI models with DeepStream
  • DeepStream features sample
• Sample Configurations and Streams
  • Contents of the package
• Implementing a Custom GStreamer Plugin with OpenCV Integration Example
  • Description of the Sample Plugin: gst-dsexample
  • Enabling and configuring the sample plugin
  • Using the sample plugin in a custom application/pipeline
  • Implementing Custom Logic Within the Sample Plugin
  • Adding NVTX APIs for sample plugin
  • Accessing NvBufSurface memory in OpenCV

TAO toolkit Integration with DeepStream

• TAO Toolkit Integration with DeepStream
  • Pre-trained models

Tutorials and How-to's

• Custom YOLO Model in the DeepStream YOLO App
  • How to Use the Custom YOLO Model
• DeepStream-3D Custom Apps and Libs Tutorials
  • DS3D Application Examples
  • DS3D data format ds3d/datamap
  • ds3d::dataloader - Load Custom Lib for Data Capture
  • ds3d::databridge - Loads Custom Lib for data conversion to and from DS3D.
  • ds3d::datafilter- DS3D Custom DataFilter
  • ds3d::datarender - Loads DS3D Custom DataRender
  • Custom Libs Configuration Specifications

DeepStream Performance

• Performance
  • TAO Pre-trained models
  • DeepStream reference model and tracker
  • Configuration File Settings for Performance Measurement
  • DeepStream reference model

DeepStream Accuracy

• Accuracy Tuning Tools
  • PipeTuner for Automatic Tuning (Developer Preview)
  • Multi-Object Tracking Parameter Functionalities for Manual Tuning

DeepStream Custom Model

• Using a Custom Model with DeepStream
  • Custom Model Implementation Interface
  • Custom Output Parsing
  • IPlugin Implementation
  • Input Layer Initialization
  • CUDA Engine Creation for Custom Models
  • IModelParser Interface for Custom Model Parsing

DeepStream Key Features

• DeepStream-3D Sensor Fusion Multi-Modal Application and Framework
  • Example 1. BEVFusion Multi-Modal with 6-Camera Plus 1-LiDAR Data Fusion Pipeline
  • Example 2. V2XFusion multi-modal batched 4-Camera and 4-LiDAR Inference Pipeline:
  • Quick Start
  • Build application From Source
  • DS3D Components used in this sample application
  • DS3D Custom Components Configuration Specifications
• DeepStream-3D Multi-Modal BEVFusion Setup
  • Prerequisites
  • Getting Started
  • Prepare DeepStream Triton BEVFusion Container and Models on X86 with a dGPU
  • Usage:
  • IoT Messaging:
  • Build from source:
  • NuScenes Dataset Setup for DS3D BEVFusion Pipeline
  • Dataset Generation for DS3D BEVFusion
  • How to use other nuScenes scene samples:
  • Citation
• DeepStream-3D Multi-Modal V2XFusion Setup
  • Prerequisites
  • Getting Started
  • Build from source:
• Smart Video Record
  • Smart Video Record Module APIs
  • Smart Video Record Configurations
• IoT
  • Secure Edge-to-Cloud Messaging
  • Bidirectional Messaging
  • Autoreconnect feature
• On the Fly Model Update
  • Assumptions
• NTP Timestamp in DeepStream
• AV Sync in DeepStream
  • Setup for RTMP/RTSP Input streams for testing
  • AVSync Reference Pipelines
• DeepStream With REST API Sever
  • Features
  • nvds_rest_server
  • deepstream-server-app
  • Sensor provisioning with deepstream-test5-app
  • How to add custom REST API support
  • Schema and endpoints
  • Limitations
• DeepStream 3D Action Recognition App
  • Getting Started
  • DeepStream 3D Action Recognition App Configuration Specifications
  • Build Custom sequence preprocess lib and application From Source
• DeepStream 3D Depth Camera App
  • Prerequisites
  • Depth Color Capture to 2D Rendering Pipeline Overview
  • Depth Color Capture to 3D Point Cloud Processing and Rendering
  • Getting Started
  • Run 3D Depth Capture, Point Cloud filter, and 3D Points Rendering Examples
  • DeepStream 3D Depth Camera App Configuration Specifications
• DeepStream 3D Lidar Inference App
  • Prerequisites
  • Lidar Point Cloud to 3D Point Cloud Processing and Rendering
  • Getting Started
• Networked Media Open Specifications (NMOS) in DeepStream
  • Supported Specifications
  • Prerequisites
  • NvDsNmos API
  • Sample Application
• Gst-nvdspostprocess in DeepStream
  • Detector models
  • Primary Classification model
  • Mask RCNN Model
  • Custom Parsing functions
• DeepStream Can Orientation App
  • Getting Started
  • DeepStream Can Orientation App Configuration Specifications
  • Build application From Source

DeepStream Application Migration

• Application Migration to DeepStream 7.0 from DeepStream 6.4
  • Running DeepStream 6.4 compiled Apps in DeepStream 7.0
  • Compiling DeepStream 6.4 Apps in DeepStream 7.0
  • Migrating DeepStream 6.4 Gst-nvtracker to DeepStream 7.0

Plugins Development Guide

DeepStream Plugin Guide

• GStreamer Plugin Overview
• MetaData in the DeepStream SDK
  • NvDsBatchMeta: Basic Metadata Structure
  • User/Custom Metadata Addition inside NvDsBatchMeta
  • Adding Custom Meta in Gst Plugins Upstream from Gst-nvstreammux
• Gst-nvdspreprocess (Alpha)
  • Inputs and Outputs
  • Features
  • Custom library Interfaces
  • Gst-nvdspreprocess File Configuration Specifications
  • Gst Properties
  • Sample pipelines
• Gst-nvinfer
  • Inputs and Outputs
  • Features
  • Gst-nvinfer File Configuration Specifications
  • Gst Properties
  • Clustering algorithms supported by nvinfer
  • Tensor Metadata
  • Segmentation Metadata
• Gst-nvinferaudio
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvinferserver
  • Inputs and Outputs
  • Gst-nvinferserver Configuration File Specifications
  • Features
  • Gst Properties
  • DeepStream Triton samples
  • DeepStream Triton gRPC support
  • Triton Ensemble Models
  • Custom Process interface IInferCustomProcessor for Extra Input, LSTM Loop, Output Tensor Postprocess
  • Tensor Metadata Output for Downstream Plugins
  • Segmentation Metadata
• Gst-nvtracker
  • Sub-batching (Alpha)
  • Inputs and Outputs
  • Gst Properties
  • NvDsTracker API for Low-Level Tracker Library
  • NvMultiObjectTracker : A Reference Low-Level Tracker Library
  • Unified Tracker Architecture for Composable Multi-Object Tracker
  • Workflow and Core Modules in The NvMultiObjectTracker Library
  • Low-Level Tracker Comparisons and Tradeoffs
  • IOU Tracker
  • NvSORT Tracker
  • NvDeepSORT Tracker
  • NvDCF Tracker
  • Miscellaneous Data Output
  • Setup and Usage of Re-ID Model
  • Setup and Usage of Sub-batching (Alpha)
  • Setup and Visualization of Tracker Sample Pipelines
  • Tracker Accuracy Tuning
  • How to Implement a Custom Low-Level Tracker Library
• Gst-nvstreammux
  • Inputs and Outputs
  • Features
  • Gst Properties
  • Known Issues with Solutions and FAQ
• Gst-nvstreammux New
  • Inputs and Outputs
  • Features
  • Gst Properties
  • Mux Config Properties
  • NvStreamMux Tuning Solutions for specific use cases
  • Known Issues with Solutions and FAQ
• Gst-nvstreamdemux
  • Inputs and Outputs
• Gst-nvmultistreamtiler
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvdsosd
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvdsmetautils
  • Gst-nvdsmetainsert
  • Inputs and Outputs
  • Features
  • customlib_impl Interfaces
  • Gst Properties
  • Use Cases & Sample Pipelines
  • Gst-nvdsmetaextract
  • Inputs and Outputs
  • Features
  • customlib_impl Interfaces
  • Gst Properties
  • Use Cases & Sample Pipelines
• Gst-nvdsvideotemplate
  • Inputs and Outputs
  • Features
  • customlib_impl Interfaces
  • Gst Properties
  • Sample pipelines
• Gst-nvdsaudiotemplate
  • Inputs and Outputs
  • Features
  • customlib_impl Interfaces
  • Gst Properties
  • Sample pipelines
• Gst-nvvideoconvert
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvdewarper
  • Inputs and Outputs
  • Features
  • Configuration File Parameters
  • Gst Properties
• Gst-nvof
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvofvisual
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvsegvisual
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvvideo4linux2
  • Decoder
  • Encoder
• Gst-nvjpegdec
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvimagedec
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvjpegenc
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvimageenc
  • Inputs and Outputs
  • Features
  • Gst Properties
• Gst-nvmsgconv
  • Inputs and Outputs
  • Features
  • Gst Properties
  • NvMsgConv low level library API’s
  • Schema Customization
  • Payload with Custom Objects
• Gst-nvmsgbroker
  • Inputs and Outputs
  • Features
  • Gst Properties
  • nvds_msgapi: Protocol Adapter Interface
  • nvds_kafka_proto: Kafka Protocol Adapter
  • Azure MQTT Protocol Adapter Libraries
  • AMQP Protocol Adapter
  • REDIS Protocol Adapter
  • MQTT Protocol Adapter
  • nv_msgbroker: Message Broker interface
• Gst-nvdsanalytics
  • Inputs and Outputs
  • Features
  • Gst Properties
  • Configuration File Parameters
• Gst-nvdsasr
  • Inputs and Outputs
  • Features
  • DS-Riva ASR Library YAML File Configuration Specifications
  • Gst Properties
• Gst-nvds_text_to_speech (Alpha)
  • Inputs and Outputs
  • Features
  • DS-Riva TTS Yaml File Configuration Specifications
  • Gst Properties
  • Sample Application
• Gst-nvdsudpsrc
  • Inputs and Outputs
  • Features
  • Gst Properties
  • Example pipelines
• Gst-nvdsudpsink
  • Inputs and Outputs
  • Features
  • Gst Properties
  • Example pipelines
• Gst-nvdspostprocess (Alpha)
  • Inputs and Outputs
  • Features
  • Gst-nvdspostprocess File Configuration Specifications
  • Gst Properties
  • Sample pipelines
• Gst-nvds3dfilter
  • Custom library Interfaces
  • Inputs and Outputs
  • Configuration file
  • Gst-nvds3dfilter properties Specifications
  • Supported DS3D filter custom libs
  • Custom ds3d::datafilter library: libnvds_3d_alignment_datafilter.so
  • Custom ds3d::datafilter library: libnvds_3d_depth2point_datafilter.so
• Gst-nvds3dbridge
  • Gst-nvds3dbridge properties Specifications
  • Custom library Interfaces
  • Supported DS3D Data bridges
  • Custom low level library: libnvds_3d_video_databridge.so
• Gst-nvds3dmixer
  • Gst-nvds3dmixer properties Specifications
  • Custom library Interfaces
  • Supported DS3D Data mixers
  • Custom low level library: libnvds_3d_multisensor_mixer.so
• Gst-nvdsucx
  • Description
  • Requirements
  • Inputs and Outputs
  • Gst Properties
  • Examples
• Gst-nvdsxfer
  • Inputs and Outputs
  • Gst Properties
  • How to test
  • Use cases
• Gst-nvvideotestsrc
  • Outputs
  • Gst Properties
  • How to test
• Gst-nvmultiurisrcbin
  • 1. Introduction
  • 2. Features
  • 3. How to use nvmultiurisrcbin in a pipeline
  • 4. Gst Properties
  • 5. Important Notes
  • 6. Limitations
• Gst-nvurisrcbin
  • 1. Introduction
  • 2. How to use nvurisrcbin in a pipeline
  • 3. Gst Properties

Troubleshooting and FAQ Guide

DeepStream Troubleshooting and FAQ

• Troubleshooting
  • You are migrating from DeepStream 6.0 to DeepStream 7.0
  • Inference
  • Performance
  • Triton
  • Troubleshooting in Tracker Setup and Parameter Tuning
  • Graph Composer Troubleshooting
  • Miscellaneous
• Frequently Asked Questions
  • DeepStream General topics
  • Smart Record
  • Triton

Deepstream Setup On WSL2

DeepStream On WSL2

• DeepStream On WSL
  • Pre-Requisites:
  • Install Ubuntu OS for WSL :
  • Install Docker Engine And Dependencies Inside Ubuntu:
  • Run Deepstream Container:
• FAQ for Deepstream On WSL
  • 1. Do we need to install nvidia driver inside Ubuntu Image with WSL?
  • 2. While installing driver, should you choose ‘Clean Installation’?
  • 3. While starting docker, I face error:“docker: Error response from daemon: could not select device driver “” with capabilities: [[gpu]]. What should I do?
  • 4. While starting docker, I get error “GPU access blocked by operating system”. What should I do?
  • 5. While installing Ubuntu image for WSL2, I get error: “The service cannot be started, either because it is disabled or because it has no enabled devices associated with it”. What should I do?
  • 6. While running deepstream-app for the first time, I get an error: “GLib (gthread-posix.c): Unexpected error from C library during ‘pthread_setspecific’: Invalid argument. Aborting.”. What should I do?
  • 7. There is no video on the screen while running gstreamer or deepstream video pipelines. But pipeline seems to be running in terminal without any error. What is the reason?
  • 8. Warning prints are coming while running deepstream-app for first time after starting docker. For e.g: “deepstream-app –version” shows below warnings. Is that an issue?

DeepStream API Reference Documentation

DeepStream API Guide

• DeepStream API Guides

Nvidia Deepstream Service Maker

DeepStream Service Maker (Alpha)

• What is Deepstream Service Maker
• Getting Started with Service Maker APIs
• Application Developer Fundamentals
  • Pipeline
  • Elements and Plugins
  • Buffer
  • Metadata
  • SourceConfig
  • CommonFactory and custom Objects
• Sample Applications
• What is a Deepstream Service Maker Plugin
• Getting Started with Your Factory and Plugin
• Incorporating properties to a plugin
• Sample Plugins
  • Message Metadata Generator
  • KITTI Dump Plugin
  • Framerate Measurement Plugin
  • Latency Measurement Plugin
  • Sample Video Probe Plugin
  • Sample Signal Handler Plugin
  • Sample Video Feeder Plugin
  • Sample Video Receiver Plugin
  • Smart Recording Action Plugin
  • Smart Recording Signal Plugin
• Plugin Search Path

Deepstream Libraries

Deepstream Libraries

• DeepStream Libraries (Developer Preview)
• DeepStream Libraries Installation
• DeepStream Libraries Repository Setup
• Getting Started with DeepStream Libraries APIs
• Sample Applications
• Additional References and Applications

Application Development Using Graph Composer

Graph Composer

• Overview
  • Concepts
    • GXF (Graph eXecution Format)
    • Graph
    • Node
    • Components
    • Codelets
    • Subgraph
    • System
    • Edges / Connection
    • Messages
    • Extension
    • Graph eXecution Engine (GXE)
  • Tools
    • Graph Composer
    • Registry
    • Container Builder
    • GXF Server
    • GXF CLI
  • Workflow

Platforms

• Ubuntu 22.04 LTS (x86_64)
  • Graph Composer
    • Features Supported
    • System Requirements
    • Dependencies
    • Install
  • Graph Composer Runtime
    • Features Supported
    • System Requirements
    • Install
• Ubuntu 22.04 LTS (ARM64 Jetson)
  • Graph Composer Runtime
    • Features Supported
    • System Requirements
    • Install
• Windows 10 (x86_64)
  • Graph Composer
    • Features Supported
    • System Requirements
• WSL Ubuntu 22.04 LTS (x86_64)

Getting Started

• Application Development Workflow
  • Python Application Development
    • Python API Setup
    • ComputeEntity
    • PyComputeEntity
  • C++ Application Development
    • Graph Entity
    • Segment
      • Connecting Graph Entities
    • Application
      • Runtime Codelet Registration
    • Distributed Application
  • Graph Composer
    • Launch Graph Composer
    • Sync Extensions
    • Create a Graph
    • Run Graph from Graph Composer
      • Local System
      • Remote System
    • Run Graph from Command line
    • Create Container Image from Graph Composer
      • Local System
      • Remote System (Windows)
    • DeepStream Application

• Creating an AI Application
  • Launch Composer
  • Drag and Drop Components
  • Configure Components
  • Connect Components
  • Add GStreamer Scheduler
  • Count Number Of People
  • Save Graph
  • Use Multiple inputs
  • Runtime add/remove inputs

• Reference graphs
  • Installing the reference graphs
  • deepstream-test1
  • deepstream-test2
  • deepstream-test3
  • deepstream-test4
  • deepstream-test5
  • deepstream-runtime-src-add-del
  • deepstream-template-plugin
  • deepstream-app
  • deepstream-audio
  • deepstream-triton
  • deepstream-camera
  • deepstream-action-recognition
  • deepstream-subgraph
  • deepstream-3d-camera
  • deepstream-ucx-test1
  • deepstream-ucx-test2

• Extension Development Workflow
  • Sync Extensions
  • Develop New Extension
  • Create and test graph

• Developing Extensions for DeepStream
  • Extension and component factory registration boilerplate
  • A simple DeepStream component
  • Implementation of INvDsInPlaceDataHandler
  • Controlling Properties
  • Triggering Actions
  • Handling signal callbacks
  • Implementation of an Configuration Provider component

• DeepStream Components
  • Interfaces
  • Data Components
  • Basic Components
  • Connections
  • Probes

GXF Internals

• GXF Internals
  • LifeCycle of a Codelet
  • The GXF Scheduler
    • Greedy Scheduler
      • Greedy Scheduler Configuration
    • Multithread Scheduler
      • Multithread Scheduler Configuration
    • Event Based Scheduler
      • Messaging and Events
      • Event Based Scheduler Configuration
    • Epoch Scheduler
  • SchedulingTerms
    • PeriodicSchedulingTerm
    • CountSchedulingTerm
    • MessageAvailableSchedulingTerm
    • MultiMessageAvailableSchedulingTerm
    • BooleanSchedulingTerm
    • AsynchronousSchedulingTerm
    • DownstreamReceptiveSchedulingTerm
    • TargetTimeSchedulingTerm
    • ExpiringMessageAvailableSchedulingTerm
    • MessageAvailableFrequencyThrottler
    • MemoryAvailableSchedulingTerm
    • BTSchedulingTerm
  • Combining SchedulingTerms
  • Connection Topologies
  • Messages
    • Transmitter
    • Receiver
    • Transmitter Example
    • Receiver Example
  • Memory Management
  • Distributed Execution
    • GraphWorker
    • GraphDriver
  • Logging
  • Component Factory

Graph eXecution Engine

• Graph Execution Engine
  • 1. How to override the parameters that are specified in the graph file using command line options?

Graph Composer Containers

• Graph Composer and GXF Containers
  • Prerequisites

GXF Component Interfaces

• GXF Component Interfaces
  • Codelet
  • Allocator
  • Receiver
  • Transmitter
  • System
  • Scheduler
  • SchedulingTerm
  • Router
  • Clock

GXF Application API's

• GXF App C++ APIs
  • Arg
  • Arg Parse
  • Application
  • Segment
  • Graph Entity
• GXF App Python APIs
  • Node
  • Graph
  • Entity
  • Component
  • EntityGroup
  • ComputeEntity
  • PyComputeEntity
  • standard_methods

GXF Runtime API's

• GXF Core C++ APIs
  • Expected
  • Component
  • Entity
  • Handle
    • UntypedHandle Class
    • Handle Class
  • Parameters
    • Parameter Types
    • Parameter Registration
• GXF Core C APIs
  • Context
    • Create context
    • Create a context from a shared context
    • Get a shared context from a context
    • Destroy context
  • Extensions
    • GxfLoadExtensionsInfo
    • Load Extensions from a file
    • Load Extension libraries
    • Load Extension from a pointer
    • Load Metadata files
    • Register component
    • Register a component during runtime
  • Graph Execution
    • Loads a list of entities from YAML file
    • Set the root folder for searching YAML files during loading
    • Loads a list of entities from YAML text
    • Activate all system components
    • Deactivate all System components
    • Starts the execution of the graph asynchronously
    • Interrupt the execution of the graph
    • Waits for the graph to complete execution
    • Runs all System components and waits for their completion
  • Entities
    • Create an entity
    • Activate an entity
    • Deactivate an entity
    • Destroy an entity
    • Find an entity
    • Find all entities
    • Increase reference count of an entity
    • Decrease reference count of an entity
    • Get status of an entity
    • Get state of an entity
    • Notify entity of an event
    • Notify entity of an event including the event type
    • Check if an entity is valid
  • Components
    • Get component type identifier
    • Get component type name
    • Get component type name from component UID
    • Get component name
    • Get unique identifier of the entity of given component
    • Add a new component
    • Add component to entity interface
    • Find a component in an entity
    • Find all components in an entity
    • Get type identifier for a component
    • Gets pointer to component
    • Check if a component is derived from another component
  • Parameter
    • 64-bit floating point
    • 64-bit signed integer
    • 64-bit unsigned integer
    • 32-bit signed integer
    • 32-bit unsigned integer
    • 16-bit unsigned integer
    • 16-bit signed integer
    • 8-bit unsigned integer
    • 8-bit signed integer
    • String parameter
    • Boolean
    • Handle
  • Vector Parameters
    • Set 1-D Vetor Parameters
    • Set 2-D Vetor Parameters
    • Get 1-D Vetor Parameters
    • Get 2-D Vetor Parameters
  • YAML Parameters
    • Sets a parameter from YAML
  • File Parameters
    • Sets a FilePath parameter
  • EntityGroup
    • kDefaultEntityGroupName
    • Create an entity group
    • Update entity’s EntityGroup
    • Find all resources from an EntityGroup
    • Get name of an EntityGroup
    • Get resource component id from EntityGroup
  • Information Queries
    • Get Meta Data about the GXF Runtime
    • Get description and list of components in loaded Extension
    • Get description and list of parameters of Component
    • Get parameter type description
    • Get flag type description
    • Get parameter description
    • Redirect logs to a file
  • Miscellaneous
    • Get string description of error
    • Check if a result is successful
    • Set log severity
    • Get log severity
• GXF Core Python APIs
  • Context
    • context_create
    • context_destroy
  • Extensions
    • load_extensions
    • get_extension_list
    • get_extension_info
  • Graph
    • graph_load_file
    • set_root_filepath
    • _subgraph_load_file
    • graph_activate
    • graph_run
    • graph_run_async
    • graph_interrupt
    • graph_wait
    • graph_save
    • graph_deactivate
    • gxf_set_severity
  • Entities
    • gxf_entity_create_info
    • entity_create
    • entity_activate
    • entity_deactivate
    • entity_destroy
    • entity_find
    • entity_find_all
    • entity_ref_count_inc
    • entity_ref_count_dec
    • entity_get_state
    • entity_event_notify
    • entity_notify_event_type
    • entity_get_status
  • EntityGroup
    • entity_group_create
    • entity_group_add
  • Components
    • gxf_tid_t
    • gxf_uid_t
    • get_component_list
    • get_component_info
    • get_param_list
    • get_param_info
    • component_add
    • component_find
    • component_type_id
    • component_type_name
    • component_add_to_interface
  • Primitive Parameters
    • 64-bit floating point (double)
    • 32-bit floating point
    • 64-bit signed integer
    • 64-bit unsigned integer
    • 32-bit signed integer
    • parameter_set_str
    • parameter_get_str
    • parameter_set_handle
    • parameter_get_handle
    • parameter_set_bool
    • parameter_get_bool
    • parameter_set_path
    • parameter_set_from_yaml_node
  • Vector Parameters
    • Set 1-D Vetor Parameters
    • Set 2-D Vetor Parameters
    • Get 1-D Vetor Parameters
    • Get 2-D Vetor Parameters

Extensions Manual

• CudaExtension
  • Components
    • nvidia::gxf::CudaStream
    • nvidia::gxf::CudaStreamId
    • nvidia::gxf::CudaEvent
    • nvidia::gxf::CudaStreamPool
    • nvidia::gxf::CudaStreamSync
• GXF Stream Sync
  • Signaler
  • Waiter
  • GxfStreamExtension
  • Components
    • nvidia::gxf::GxfStreamSync
  • GXF Stream Sync Workflow
    • At the Signaler codelet
  • At the Waiter Codelet
    • Yaml file
• StandardExtension
  • Interfaces
    • nvidia::gxf::Codelet
    • nvidia::gxf::Clock
    • nvidia::gxf::System
    • nvidia::gxf::Queue
    • nvidia::gxf::Router
    • nvidia::gxf::Transmitter
    • nvidia::gxf::Receiver
    • nvidia::gxf::Scheduler
    • nvidia::gxf::SchedulingTerm
    • nvidia::gxf::Allocator
    • nvidia::gxf::Monitor
    • nvidia::gxf::IPCServer
    • nvidia::gxf::IPCClient
    • nvidia::gxf::ResourceBase
    • nvidia::gxf::Controller
  • Components
    • nvidia::gxf::RealtimeClock
    • nvidia::gxf::ManualClock
    • nvidia::gxf::SyntheticClock
    • nvidia::gxf::SystemGroup
    • nvidia::gxf::MessageRouter
    • nvidia::gxf::NetworkRouter
    • nvidia::gxf::RouterGroup
    • nvidia::gxf::DoubleBufferTransmitter
    • nvidia::gxf::DoubleBufferReceiver
    • nvidia::gxf::Connection
    • nvidia::gxf::PeriodicSchedulingTerm
    • nvidia::gxf::CountSchedulingTerm
    • nvidia::gxf::TargetTimeSchedulingTerm
    • nvidia::gxf::DownstreamReceptiveSchedulingTerm
    • nvidia::gxf::MessageAvailableSchedulingTerm
    • nvidia::gxf::MultiMessageAvailableSchedulingTerm
    • nvidia::gxf::ExpiringMessageAvailableSchedulingTerm
    • nvidia::gxf::BooleanSchedulingTerm
    • nvidia::gxf::BTSchedulingTerm
    • nvidia::gxf::AsynchronousSchedulingTerm
    • nvidia::gxf::MessageAvailableFrequencyThrottler
    • nvidia::gxf::MemoryAvailableSchedulingTerm
    • nvidia::gxf::GraphWorker
    • nvidia::gxf::GraphDriver
    • nvidia::gxf::GreedyScheduler
    • nvidia::gxf::MultiThreadScheduler
    • nvidia::gxf::EpochScheduler
    • nvidia::gxf::EventBasedScheduler
    • nvidia::gxf::BlockMemoryPool
    • nvidia::gxf::UnboundedAllocator
    • nvidia::gxf::ThreadPool
    • nvidia::gxf::GPUDevice
    • nvidia::gxf::CPUThread
    • nvidia::gxf::Forward
    • nvidia::gxf::Topic
    • nvidia::gxf::Tensor
    • nvidia::gxf::Timestamp
    • nvidia::gxf::MultiSourceTimestamp
    • nvidia::gxf::Metric
    • nvidia::gxf::JobStatistics
    • nvidia::gxf::Broadcast
    • nvidia::gxf::Gather
    • nvidia::gxf::TensorCopier
    • nvidia::gxf::TimedThrottler
    • nvidia::gxf::Vault
    • nvidia::gxf::Subgraph
    • nvidia::gxf::EndOfStream
    • nvidia::gxf::Synchronization
    • signed char
    • unsigned char
    • short int
    • short unsigned int
    • int
    • unsigned int
    • long int
    • long unsigned int
    • float
    • double
    • bool
  • Python Bindings
    • Clock
    • Receiver
    • Transmitter
    • PrimitiveType
    • Shape
    • MemoryStorageType
    • Tensor
    • Allocator
• Python Codelets
  • General Concepts
  • Implenting a Python Codelet
    • Implementing Class
    • Adding Python Codelet to the Graph
    • Accessing Parameters
    • Accessing other Components
• NetworkExtension
  • Interfaces
    • nvidia::gxf::TcpCodelet
  • Components
    • nvidia::gxf::ClockSyncPrimary
    • nvidia::gxf::ClockSyncSecondary
    • nvidia::gxf::TcpClient
    • nvidia::gxf::TcpServer
• NvTritonExt
  • Components
    • nvidia::triton::TritonServer
    • nvidia::triton::TritonInferencerInterface
    • nvidia::triton::TritonInferencerImpl
    • nvidia::triton::TritonInferenceRequest
    • nvidia::triton::TritonInferenceResponse
    • nvidia::triton::TritonOptions
    • nvidia::triton::TritonRequestReceptiveSchedulingTerm
• SerializationExtension
  • Interfaces
    • nvidia::gxf::ComponentSerializer
  • Components
    • nvidia::gxf::EntityRecorder
    • nvidia::gxf::EntityReplayer
    • nvidia::gxf::StdComponentSerializer
• MultimediaExtension
  • Components
    • nvidia::gxf::AudioBuffer
    • nvidia::gxf::VideoBuffer
• VideoEncoderExtension
  • Components
    • nvidia::gxf::VideoEncoderRequest
    • nvidia::gxf::VideoEncoderResponse
    • nvidia::gxf::VideoEncoderContext
• VideoDecoderExtension
  • Components
    • nvidia::gxf::VideoDecoderRequest
    • nvidia::gxf::VideoDecoderResponse
    • nvidia::gxf::VideoDecoderContext
• Behavior Trees
  • General Concept
  • Behavior Tree Codelets
    • Constant Behavior
    • Parallel Behavior
    • Repeat Behavior
    • Selector Behavior
    • Sequence Behavior
    • Switch Behavior
    • Timer Behavior
• UCX Extension
  • Description
  • Requirements
  • Components
    • UcxContext
    • UcxTransmitter
    • UcxReceiver
    • UcxComponentSerializer
    • UcxEntitySerializer
    • UcxSerializationBuffer
  • Example
• HttpExtension
  • Interfaces
    • nvidia::gxf::HttpClient
  • Components
    • nvidia::gxf::HttpServer
    • nvidia::gxf::HttpIPCClient
    • nvidia::gxf::CppRestHttpClient
• GrpcExtension
  • Interfaces
  • Components
    • nvidia::gxf::GrpcServer
    • nvidia::gxf::GrpcClient
• TensorRTExtension
  • Components
    • nvidia::gxf::TensorRtInference
• NvDs3dProcessingExt
  • Components
    • nvidia::deepstream::NvDs3dSrc
    • nvidia::deepstream::NvDs3dSink
    • nvidia::deepstream::NvDs3dFilter
    • nvidia::deepstream::NvDs3dDataDepthInfoLogger
    • nvidia::deepstream::NvDs3dDataColorInfoLogger
    • nvidia::deepstream::NvDs3dDataPointCloudInfoLogger
• NvDsActionRecognitionExt
  • Components
    • nvidia::deepstream::NvDsActionRecognition2D
    • nvidia::deepstream::NvDsActionRecognition3D
• NvDsAnalyticsExt
  • Components
    • nvidia::deepstream::NvDsAnalytics
• NvDsBaseExt
  • Interfaces
    • nvidia::deepstream::INvDsKeyboardInput
  • Components
    • nvidia::deepstream::NvDsStaticOutput
    • nvidia::deepstream::NvDsDynamicOutput
    • nvidia::deepstream::NvDsOnRequestOutput
    • nvidia::deepstream::NvDsStaticInput
    • nvidia::deepstream::NvDsOnRequestInput
    • nvidia::deepstream::NvDsMultiOutput
    • nvidia::deepstream::NvDsProbeConnector
    • nvidia::deepstream::NvDsProbe
    • nvidia::deepstream::NvDsConnection
    • nvidia::deepstream::NvDsMultiSrcConnection
    • nvidia::deepstream::NvDsKeyboardInput
    • nvidia::deepstream::NvDsScheduler
    • nvidia::deepstream::NvDsToGxfBridge
    • nvidia::deepstream::NvGxfToDsBridge
    • nvidia::deepstream::NvDsGxfObjectDataTranslator
    • nvidia::deepstream::NvDsGxfAudioClassificationDataTranslator
    • nvidia::deepstream::NvDsGxfOpticalFlowDataTranslator
    • nvidia::deepstream::NvDsGxfSegmentationDataTranslator
    • nvidia::deepstream::NvDsGxfInferTensorDataTranslator
    • nvidia::deepstream::NvDsQueue
    • nvidia::deepstream::NvDsTee
    • nvidia::deepstream::NvDsBufferSync
• NvDsBodyPose2D
  • Components
    • nvidia::BodyPose2D::PostProcess
    • nvidia::BodyPose2D::BodyPose2dModel
    • nvidia::BodyPose2D::NvDsGxfBodypose2dDataTranslator
• NvDsCloudMsgExt
  • Components
    • nvidia::deepstream::NvDsMessage
    • nvidia::deepstream::NvDsMsgRelayTransmitter
    • nvidia::deepstream::NvDsMsgRelayReceiver
    • nvidia::deepstream::NvDsMsgBrokerC2DReceiver
    • nvidia::deepstream::NvDsMsgBrokerD2CTransmitter
    • nvidia::deepstream::NvDsMsgRelay
    • nvidia::deepstream::NvDsMsgBroker
    • nvidia::deepstream::NvDsMsgConverter
    • nvidia::deepstream::NvDsMsgConvBroker
• NvDsConverterExt
  • Components
    • nvidia::deepstream::NvDsVideoConvert
    • nvidia::deepstream::AudioConvert
    • nvidia::deepstream::AudioResample
• NvDsDewarperExt
  • Components
    • nvidia::deepstream::NvDsAisleFilter
    • nvidia::deepstream::NvDsBBoxFilter
    • nvidia::deepstream::NvDsDewarper
    • nvidia::deepstream::NvDsSpotChangeSignal
    • nvidia::deepstream::NvDsSpot
• NvDsEmotionExt
  • Components
    • nvidia::Emotion::NvDsEmotionTemplateLib
• NvDsFacialLandmarks
  • Components
    • nvidia::FacialLandmarks::PostProcess
    • nvidia::FacialLandmarks::PreProcess
    • nvidia::FacialLandmarks::FacialLandmarksPgieModel
    • nvidia::FacialLandmarks::FacialLandmarksSgieModel
    • nvidia::FacialLandmarks::FacialLandmarksSgieModelV2
    • nvidia::FacialLandmarks::NvDsGxfFacialLandmarksTranslator
• NvDsGazeExt
  • Components
    • nvidia::Gaze::NvDsGazeTemplateLib
    • nvidia::Gaze::NvDsGxfGazeDataTranslator
• NvDsGesture
  • Components
    • nvidia::Gesture::PreProcess
    • nvidia::Gesture::GestureModel
• NvDsHeartRateExt
  • Components
    • nvidia::HeartRate::NvDsHeartRateTemplateLib
    • nvidia::HeartRate::NvDsGxfHeartRateDataTranslator
• NvDsInferenceExt
  • Components
    • nvidia::deepstream::NvDsModelUpdatedSignal
    • nvidia::deepstream::NvDsInferVideoPropertyController
    • nvidia::deepstream::NvDsInferVideo
    • nvidia::deepstream::NvDsAsr
    • nvidia::deepstream::NvDsInferAudio
    • nvidia::deepstream::NvDsPreProcess
• NvDsInferenceUtilsExt
  • Components
    • nvidia::deepstream::NvDsKittiDump
    • nvidia::deepstream::NvDsFpsMeasurement
    • nvidia::deepstream::NvDsLatencyMeasurement
    • nvidia::deepstream::NvDsAudioClassificationPrint
    • nvidia::deepstream::NvDsPerClassObjectCounting
    • nvidia::deepstream::NvDsModelEngineWatchOTFTrigger
    • nvidia::deepstream::NvDsRoiClassificationResultParse
    • nvidia::deepstream::NvDsMetaDeserialize
    • nvidia::deepstream::NvDsMetaSerialize
• NvDsInterfaceExt
  • Interfaces
    • nvidia::deepstream::INvDsElement
    • nvidia::deepstream::INvDsIO
    • nvidia::deepstream::INvDsInput
    • nvidia::deepstream::INvDsOutput
    • nvidia::deepstream::INvDsProbe
    • nvidia::deepstream::INvDsConnection
    • nvidia::deepstream::INvDsComponent
    • nvidia::deepstream::INvDsInPlaceDataHandler
    • nvidia::deepstream::INvDsAction
    • nvidia::deepstream::INvDsSignal
    • nvidia::deepstream::INvDsPropertyController
    • nvidia::deepstream::INvDsAudioTemplatePluginConfigComponent
    • nvidia::deepstream::INvDsVideoTemplatePluginConfigComponent
    • nvidia::deepstream::INvDsInferModelConfigComponent
    • nvidia::deepstream::INvDsGxfDataTranslator
  • Components
    • nvidia::deepstream::NvBufSurfaceHandle
    • nvidia::deepstream::NvBufAudioHandle
    • nvidia::deepstream::NvDsBatchMetaHandle
    • nvidia::deepstream::GstBufferHandle
• NvDsMuxDemuxExt
  • Components
    • nvidia::deepstream::NvDsStreamDemux
    • nvidia::deepstream::NvDsStreamMux
    • nvidia::deepstream::NvDsStreamDemuxNew
    • nvidia::deepstream::NvDsStreamMuxNew
• NvDsOpticalFlowExt
  • Components
    • nvidia::deepstream::NvDsOpticalFlow
    • nvidia::deepstream::NvDsOpticalFlowVisual
• NvDsOutputSinkExt
  • Components
    • nvidia::deepstream::NvDsFakeSink
    • nvidia::deepstream::NvDsFileOut
    • nvidia::deepstream::NvDsVideoRendererPropertyController
    • nvidia::deepstream::NvDsVideoRenderer
    • nvidia::deepstream::NvDsRtspOut
    • nvidia::deepstream::XvImageSink
    • nvidia::deepstream::AlsaAudioRenderer
• NvDsSampleExt
  • Components
    • nvidia::deepstream::NvDsSampleProbeMessageMetaCreation
    • nvidia::deepstream::NvDsSampleSourceManipulator
    • nvidia::deepstream::NvDsSampleVideoTemplateLib
    • nvidia::deepstream::NvDsSampleAudioTemplateLib
    • nvidia::deepstream::NvDsSampleC2DSmartRecordTrigger
    • nvidia::deepstream::NvDsSampleD2C_SRMsgGenerator
• NvDsSampleModelsExt
  • Components
    • nvidia::deepstream::NvDsResnet10_4ClassDetectorModel
    • nvidia::deepstream::NvDsSecondaryCarColorClassifierModel
    • nvidia::deepstream::NvDsSecondaryCarMakeClassifierModel
    • nvidia::deepstream::NvDsSecondaryVehicleTypeClassifierModel
    • nvidia::deepstream::NvDsSonyCAudioClassifierModel
    • nvidia::deepstream::NvDsCarDetector360dModel
• NvDsSourceExt
  • Components
    • nvidia::deepstream::NvDsSourceInfoLoader
    • nvidia::deepstream::NvDsStartSrAction
    • nvidia::deepstream::NvDsStopSrAction
    • nvidia::deepstream::NvDsSrDoneSignal
    • nvidia::deepstream::NvDsSingleSrcInput
    • nvidia::deepstream::NvDsSourceManipulationAction
    • nvidia::deepstream::NvDsMultiSourceSmartRecordAction
    • nvidia::deepstream::NvDsMultiSrcInput
    • nvidia::deepstream::NvDsMultiSrcWarpedInput
    • nvidia::deepstream::NvDsRecordAction
    • nvidia::deepstream::NvDsMultiSrcInputWithRecord
    • nvidia::deepstream::NvDsCameraSrcInput
    • nvidia::deepstream::VideoTestSrc
    • nvidia::deepstream::AudioTestSrc
    • nvidia::deepstream::AlsaAudioInput
• NvDsTemplateExt
  • Components
    • nvidia::deepstream::NvDsAudioTemplate
    • nvidia::deepstream::NvDsVideoTemplate
• NvDsTrackerExt
  • Components
    • nvidia::deepstream::NvDsTracker
• NvDsTranscodeExt
  • Components
    • nvidia::deepstream::NvDsJpegDecoder
    • nvidia::deepstream::NvDsVideoDecoder
    • nvidia::deepstream::NvDsH264Encoder
    • nvidia::deepstream::NvDsH265Encoder
• NvDsTritonExt
  • Components
    • nvidia::deepstream::NvDsTriton
• NvDsUcxExt
  • Components
    • nvidia::deepstream::NvDsUcxClientSink
    • nvidia::deepstream::NvDsUcxClientSrc
    • nvidia::deepstream::NvDsUcxServerSink
    • nvidia::deepstream::NvDsUcxServerSrc
• NvDsUdpExt
  • Components
    • nvidia::deepstream::NvDsUdpSink
    • nvidia::deepstream::NvDsUdpSrc
• NvDsVisualizationExt
  • Components
    • nvidia::deepstream::NvDsOSDPropertyController
    • nvidia::deepstream::NvDsOSD
    • nvidia::deepstream::NvDsTiler
    • nvidia::deepstream::NvDsSegVisual
    • nvidia::deepstream::NvDsBlender
    • nvidia::deepstream::NvDsTilerEventHandler

Tools

• Registry
  • Repository Manager
    • NVIDIA Cloud Repository
    • Local Workspace
  • Cache
  • Extension Registration
  • Installing graphs for deployment
• Registry Command Line Interface
  • cache
  • repo
    • repo clean
    • repo list
    • repo info
    • repo sync
  • extn
    • extn add
    • extn sync
    • extn import
    • extn list
    • extn info
    • extn versions
    • extn variants
    • extn dependencies
  • comp
    • comp list
    • comp info
  • graph
    • graph install
• Composer
  • User Interface
    • Menu Bar
    • Context Menu
    • Toolbar
    • Component List
  • Create New Application
  • Open and Save Application Graphs
  • Compose an Application Graph
    • Finding the right component
    • Creating a Component Instance
    • Understanding the Component Handles
    • Linking and Unlinking components
    • Entity Node
    • Setting up a Connection from an Input to an Output
    • Changing the Component Properties
    • Editor Features
    • Subgraph
    • Backdrop
  • Extend a Graph
  • Run Graph
    • Options
  • Build Container Image
    • Options
  • Generate Gstreamer Extension
    • Options
  • Remote Access
    • Comparison of available options
  • Omniverse Streaming Client
    • Installation and Usage
    • Configuration
    • Server
    • Client
  • WebRTC streaming
    • Current Limitations:
  • Restrictions
  • Trouble Shooting
• Container Builder
  • Prerequisites
  • Container Builder Features
  • Container Builder Tool Usage
  • Run Container Builder
  • Container Builder Configuration
  • A Basic Example of Container Builder Configuration
  • A Multi-Stage Example
  • Container builder main control section specification
  • Container dockerfile stage section specification
• GXF Command Line Interface
  • stat
  • config
  • dump

FAQ Guide

• FAQ
  • General
  • Registry
  • Container Builder
  • Composer
  • Extension Developement

DeepStream Legal Information

• DeepStream End User License Agreement

DeepStream Feedback

• Feedback form
  • Request Documentation Fix