NvDsBaseExt#

Basic components required to build a DeepStream graph.

  • UUID: 56d7e3ec-62c6-4652-bcc8-4f1c3b00df03

  • Version: 1.6.0

  • Author: NVIDIA

  • License: Proprietary

Interfaces#

nvidia::deepstream::INvDsKeyboardInput#

Interface for the keyboard input component.

  • Component ID: 8ab63073-251f-49ba-a48e-fe7f602eec94

  • Base Type: nvidia::gxf::Component

  • Defined in: nvdsbase/nvds_keyboard_input.hpp

Components#

nvidia::deepstream::NvDsStaticOutput#

I/O component for a static (always available) output of an INvDsElement component.

  • Component ID: 58a8c362-bf1d-4bdf-8139-61aa21a44644

  • Base Type: nvidia::deepstream::INvDsOutput

  • Defined in: nvdsbase/nvds_io.hpp

nvidia::deepstream::NvDsDynamicOutput#

I/O component for an output that is made dynamically available at runtime by an INvDsElement component.

  • Component ID: cbdcefb0-f6c0-43d6-908b-89ca7fb67d74

  • Base Type: nvidia::deepstream::INvDsOutput

  • Defined in: nvdsbase/nvds_io.hpp

nvidia::deepstream::NvDsOnRequestOutput#

I/O component for an output that must be requested from an INvDsElement component.

  • Component ID: bb06615e-34c9-4288-8928-5d18a8c796be

  • Base Type: nvidia::deepstream::INvDsOutput

  • Defined in: nvdsbase/nvds_io.hpp

nvidia::deepstream::NvDsStaticInput#

I/O component for a static (always available) input of an INvDsElement component.

  • Component ID: 9fd570ad-ff14-4621-b661-c1f77ccdef18

  • Base Type: nvidia::deepstream::INvDsInput

  • Defined in: nvdsbase/nvds_io.hpp

nvidia::deepstream::NvDsOnRequestInput#

I/O component for an input that an INvDsElement component accepts on request.

  • Component ID: fdf605c3-44f3-49cf-a570-3fb53dfe8cee

  • Base Type: nvidia::deepstream::INvDsInput

  • Defined in: nvdsbase/nvds_io.hpp

nvidia::deepstream::NvDsMultiOutput#

I/O component for an INvDsElement component output that generates data from multiple sources.

  • Component ID: 46365da3-a2c5-472e-9eba-ccf8c9d6d3b5

  • Base Type: nvidia::deepstream::INvDsIO

  • Defined in: nvdsbase/nvds_io.hpp

nvidia::deepstream::NvDsProbeConnector#

Connector component between NvDsProbe and a component implementing the INvDsInPlaceDataHandler interface.

  • Component ID: 2d9c7aad-df5a-4634-a297-4045bdc41370

  • Base Type: nvidia::gxf::Component

  • Defined in: nvdsbase/nvds_probe_connector.hpp

nvidia::deepstream::NvDsProbe#

Component for probing an I/O for monitoring and in-place manipulation of data flowing through the I/O.

  • Component ID: 27fb497d-9fba-45c3-a793-ebc3dd7f058f

  • Base Type: nvidia::deepstream::INvDsProbe

Parameters#

io

Handle to a INvDsIO component.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::INvDsIO


probe-connector

Handle to a NvDsProbeConnector component.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsProbeConnector

nvidia::deepstream::NvDsConnection#

Component that connects two INvDsElement based components.

  • Component ID: f51eee4e-6176-4df7-bc38-aa352df3cbb9

  • Base Type: nvidia::deepstream::INvDsConnection

Parameters#

source

Handle to a source I/O - derived from INvDsOutput.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::INvDsOutput


source-request-pad-name

Pad name to use when requesting a pad from NvDsOnRequestOutput.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_STRING


target

Handle to a target I/O - derived from INvDsInput.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::INvDsInput


target-request-pad-name

Pad name to use when requesting a pad from NvDsOnRequestInput.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_STRING

nvidia::deepstream::NvDsMultiSrcConnection#

Component that connects INvDsElement based components, that generate output from multiple sources to another aggregator component.

  • Component ID: 4ce04fde-c27a-44a1-b786-63161fb80f74

  • Base Type: nvidia::deepstream::INvDsConnection

Parameters#

source

Handle to an NvDsMultiOutput component.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsMultiOutput


target

Handle to an NvDsOnRequestInput component.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsOnRequestInput

nvidia::deepstream::NvDsKeyboardInput#

Keyboard input component. Helper component to share keyboard/stdin input between various components. Returns an fd to read input from.

  • Component ID: 266b08bd-bcee-415b-bd99-8f85543d3efc

  • Base Type: nvidia::deepstream::INvDsKeyboardInput

nvidia::deepstream::NvDsScheduler#

The DeepStream scheduler responsible for constructing the graph(pipeline) and managing its state and scheduling DeepStream components

  • Component ID: 74f24521-e347-42ce-853b-e429f3d07cb3

  • Base Type: nvidia::gxf::System

nvidia::deepstream::NvDsToGxfBridge#

Bridge component that extracts data from the DeepStream pipeline and translates it to GXF data structures.

  • Component ID: e63a7542-862d-443f-b0d5-106f1d16e4b3

  • Base Type: nvidia::gxf::Codelet

Parameters#

allocator

Handle to a allocator component

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Allocator


data-storage-type

Memory storage type for data components: 0 - kSystem, 1 - kHost

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 0


data-tx

Handle to a Transmitter component

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Transmitter


frame-tx

Handle to a Transmitter component

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Transmitter


in

Handle to a NvDsStaticInput component. Supported formats - audio, video

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticInput


measure-perf

Enable bridge performance meaurement

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


scheduling-term

Handle to a AsynchronousSchedulingTerm component

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::AsynchronousSchedulingTerm


sync

Wether to retreive frames from Gst pipeline synchronously based on frame PTS

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False

nvidia::deepstream::NvGxfToDsBridge#

Bridge component that translates GXF data structures to DeepStream buffers and metadata and pushed them to the DeepStream pipeline.

  • Component ID: e9945862-1686-4464-a211-b873f1f8365f

  • Base Type: nvidia::gxf::Codelet

Parameters#

caps

GStreamer capabilies to set on the underlying source element. Required when frame data received is not raw audio or video.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_STRING


data-rx

Handle to a Receiver component

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Receiver


data-timeout

Time in nanoseconds to wait for data message to arrive after frame message is received. -1 to wait indefinitely.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64

  • Default: -1


frame-rx

Handle to a Receiver component

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Receiver


measure-perf

Enable bridge performance meaurement

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


out

Handle to a NvDsStaticOutput component. Supported formats - audio, video

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticOutput


sys-mem-mode

When component receives audio/video frames with memory storage, select between translation to (0) - Nv Buffer format, (1) - Pure Gst buffer

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

nvidia::deepstream::NvDsGxfObjectDataTranslator#

Translate DS object data structure to GXF data structure and vice versa.

  • Component ID: 2dc0e9d6-722f-4856-872c-2386442eda46

  • Base Type: nvidia::deepstream::INvDsGxfDataTranslator

nvidia::deepstream::NvDsGxfAudioClassificationDataTranslator#

Translate DS audio classification data structure to GXF data structure and vice versa.

  • Component ID: f7cb57b9-e05f-42c4-bb44-1a2bc6bda6cc

  • Base Type: nvidia::deepstream::INvDsGxfDataTranslator

nvidia::deepstream::NvDsGxfOpticalFlowDataTranslator#

Translate DS optical flow data structure to GXF data structure and vice versa.

  • Component ID: 35567c7d-a376-42b8-8562-efc2ea85de3d

  • Base Type: nvidia::deepstream::INvDsGxfDataTranslator

nvidia::deepstream::NvDsGxfSegmentationDataTranslator#

Translate DS segmentation data structure to GXF data structure and vice versa.

  • Component ID: bd69f3eb-dc18-46e6-800c-c4c33c85b541

  • Base Type: nvidia::deepstream::INvDsGxfDataTranslator

nvidia::deepstream::NvDsGxfInferTensorDataTranslator#

Translate DS infer tensor data structure to GXF data structure and vice versa.

  • Component ID: 682a30d1-6fed-4b2a-b97e-b0416f49cf8c

  • Base Type: nvidia::deepstream::INvDsGxfDataTranslator

nvidia::deepstream::NvDsQueue#

Simple data queue. Moves the processing of the downstream component to a separate thread.

  • Component ID: 87ad1e4f-1a37-39d0-88f3-6a07adce663a

  • Base Type: nvidia::deepstream::INvDsElement

Parameters#

flush-on-eos

Discard all data in the queue when an EOS event is received.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


in

Handle to an nvidia::deepstream::NvDsStaticInput component. Supports all formats.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticInput


leaky

Determines where the queue leaks, if at all.

Valid values:

0: no

1: upstream

2: downstream

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64

  • Default: 0


max-size-buffers

Maximum number of buffers in the queue (0=disable).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 200


max-size-bytes

Maximum amount of data in the queue (bytes, 0=disable).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 10485760


max-size-time

Maximum amount of data in the queue (in ns, 0=disable).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 1000000000


min-threshold-buffers

Minimum number of buffers in the queue to allow reading (0=disable).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 0


min-threshold-bytes

Minimum amount of data in the queue to allow reading (bytes, 0=disable).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 0


min-threshold-time

Minimum amount of data in the queue to allow reading (in ns, 0=disable).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 0


out

Handle to an nvidia::deepstream::NvDsStaticOutput component. Supports any format.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticOutput


silent

Used to silence queue signals.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False

nvidia::deepstream::NvDsTee#

1-to-N pipe fitting.

  • Component ID: 57c50fad-14af-3e03-bfdc-d60485da7d4e

  • Base Type: nvidia::deepstream::INvDsElement

Parameters#

allow-not-linked

Return GST_FLOW_OK even if there are no source pads or they are all unlinked.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


has-chain

Checks if the element can operate in push mode.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: True


in

Handle to an nvidia::deepstream::NvDsStaticInput component. Supports any format.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticInput


out-%u

Handle to an nvidia::deepstream::NvDsOnRequestOutput component. Supports any format.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsOnRequestOutput


pull-mode

Behavior of tee in pull mode.

Valid values:

0: never

1: single

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64

  • Default: 0


silent

Cancels the production of last_message events.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: True

nvidia::deepstream::NvDsBufferSync#

Ensures that processing by upstream components on buffers received on src pad has finished. This is useful in cases where a buffer is provided to multiple elements simultaneously using an element like tee and it must be ensured that the elements have finished processing before pushing it downstream.

  • Component ID: bdb17955-2fb5-3481-9ee3-722d9cffca61

  • Base Type: nvidia::deepstream::INvDsElement

Parameters#

in-%u

Handle to an nvidia::deepstream::NvDsOnRequestInput component. Supports any format.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsOnRequestInput


out

Handle to an nvidia::deepstream::NvDsStaticOutput component. Supports any format.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticOutput


sync-in

Handle to an nvidia::deepstream::NvDsStaticInput component. Supports any format.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticInput

On this page