NvDsInferenceExt#

NVIDIA DeepStreamSDK Streaming Inference components.

  • UUID: 0b02963e-c24e-4c13-ace0-c4cdf36c7c71

  • Version: 1.6.0

  • Author: NVIDIA

  • License: Proprietary

Components#

nvidia::deepstream::NvDsModelUpdatedSignal#

Reports the on-the-fly model update status. This is a connector component. This component must be linked to ‘NvDsInferVideo’ which emits the signal and another component which will handle the signal callback.

  • Component ID: 5b154229-a6ce-342c-8ca6-8f045316a912

  • Base Type: nvidia::deepstream::INvDsSignal

  • Defined in: nvdsinference/nvdsinference_interfaces.hpp

nvidia::deepstream::NvDsInferVideoPropertyController#

Helper component to control properties of nvidia::deepstream::NvDsInferVideo. This is a connector component. It must be linked to two components: NvDsInferVideo component to control the properties, and another component which will set/get properties via the helper component APIs.

  • Component ID: 6b5f8068-fb7d-301f-ad5a-55fbf81d1b6f

  • Base Type: nvidia::deepstream::INvDsPropertyController

  • Defined in: nvdsinference/nvdsinference_interfaces.hpp

nvidia::deepstream::NvDsInferVideo#

DeepStreamSDK TensorRT Bin. Internal Pipeline: queue->nvvidconv->nvinfer.

  • Component ID: 18e494e2-4c0e-3589-97be-06ece23a7692

  • Base Type: nvidia::deepstream::INvDsElement

Parameters#

batch-size

Maximum batch size for inference.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 1


config-file-path

Path to the configuration file for this instance of nvinfer.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_FILE


filter-out-class-ids

Ignore metadata for objects of specified class ids Use string with values of class ids in ClassID (int) to set the property. e.g. 0;2;3.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_STRING


gpu-id

Set GPU Device ID.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 0


infer-model-config

Handle to a INvDsInferModelConfigComponent component.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::INvDsInferModelConfigComponent


infer-on-class-ids

Operate on objects with specified class ids Use string with values of class ids in ClassID (int) to set the property. e.g. 0:2:3.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_STRING


infer-on-gie-id

Infer on metadata generated by GIE with this unique ID. Set to -1 to infer on all metadata.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64

  • Default: -1


input-tensor-meta

Use preprocessed input tensors attached as metadata instead of preprocessing inside the plugin

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL


interval

Specifies number of consecutive batches to be skipped for inference.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 0


model-engine-file

Absolute path to the pre-generated serialized engine file for the model.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_FILE


model-updated-signal

Handle to a NvDsModelUpdatedSignal component.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsModelUpdatedSignal


output-instance-mask

Instance mask expected in network output and attach it to metadata.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


output-tensor-meta

Attach inference tensor outputs as buffer metadata.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


process-mode

Infer processing mode.

Valid values:

1: primary

2: secondary

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64

  • Default: 1


property-controller

Property Controller for NvDsInferVideo component.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsInferVideoPropertyController


raw-output-file-write

Write raw inference output to file.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


unique-id

Unique ID for the element. Can be used to identify output of the element.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 15


video-in

Handle to a nvidia::deepstream::NvDsStaticInput component. Supported formats - video(NV12, RGBA).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticInput


video-out

Handle to an nvidia::deepstream::NvDsStaticOutput component. Supported formats - video(NV12, RGBA).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticOutput

nvidia::deepstream::NvDsAsr#

Performs automatic speech recognition on input audio. Refer to nvdsasr plugin

  • Component ID: f74d67fc-711e-364b-8a8b-e5a349304d15

  • Base Type: nvidia::deepstream::INvDsElement

Parameters#

audio-in

Handle to an nvidia::deepstream::NvDsStaticInput component. Supported formats - audio(S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticInput


audio-out

Handle to a nvidia::deepstream::NvDsStaticOutput component. Supported formats - audio(S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticOutput


config-file

Set config file path for algo ctx in custom lib.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_FILE


create-speech-ctx-func

Symbol name to create algo ctx in custom lib.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_STRING

  • Default: creat_asr_ctx


customlib-name

Set custom library Name to be used.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_FILE

  • Default: libnvds_speech_riva.so

nvidia::deepstream::NvDsInferAudio#

DeepStreamSDK Audio Inference plugin. Refer to nvinferaudio plugin

  • Component ID: 582e8e1d-197c-32ce-a79e-3630785e9408

  • Base Type: nvidia::deepstream::INvDsElement

Parameters#

audio-framesize

Frame size to use for transform.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_UINT64


audio-hopsize

Hop size to use for transform.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_UINT64


audio-in

Handle to an nvidia::deepstream::NvDsStaticInput component. Supported formats - audio(S16LE).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticInput


audio-out

Handle to an nvidia::deepstream::NvDsStaticOutput component. Supported formats - audio(S16LE).

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticOutput


audio-transform

Transform name and parameters.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_STRING


batch-size

Maximum batch size for inference.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 1


classifier-type

Type of classifier of this instance of nvinfer.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_STRING


config-file-path

Path to the configuration file for this instance of nvinfer.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_FILE


gpu-id

Set GPU Device ID

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 0


infer-model-config

Handle to a INvDsInferModelConfigComponent component.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::INvDsInferModelConfigComponent


model-engine-file

Absolute path to the pre-generated serialized engine file for the model.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_FILE


output-tensor-meta

Attach inference tensor outputs as buffer metadata.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


raw-output-file-write

Write raw inference output to file.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: False


unique-id

Unique ID for the element. Can be used to identify output of the element.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 15

nvidia::deepstream::NvDsPreProcess#

Preprocessing using custom algorithms for different streams. For more information refer to https://docs.nvidia.com/metropolis/deepstream/dev-guide/text/DS_plugin_gst-nvdspreprocess.html

  • Component ID: 2abf4770-e210-3f41-abd6-0555b8ca107f

  • Base Type: nvidia::deepstream::INvDsElement

Parameters#

unique-id

Unique ID for the element. Can be used to identify output of the element

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 15


enable

Enable gst-nvdspreprocess plugin, or set in passthrough mode

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_BOOL

  • Default: True


gpu-id

Set GPU Device ID

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 0


config-file

Preprocess Config File

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_FILE


video-out

Handle to a nvidia::deepstream::NvDsStaticOutput component. Supported formats - video(NV12, RGBA, I420)

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticOutput


video-in

Handle to a nvidia::deepstream::NvDsStaticInput component. Supported formats - video(NV12, RGBA, I420)

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::deepstream::NvDsStaticInput