..
   Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
   NVIDIA CORPORATION and its licensors retain all intellectual property
   and proprietary rights in and to this software, related documentation
   and any modifications thereto. Any use, reproduction, disclosure or
   distribution of this software and related documentation without an express
   license agreement from NVIDIA CORPORATION is strictly prohibited.

NvDsInferenceUtilsExt
-----------------------
NVIDIA DeepStreamSDK Streaming Inference components.

* UUID: 27856a43-5ad4-4d8e-be36-0ec2cf9bbb58
* Version: 1.0.0
* Author: NVIDIA
* License: Proprietary

Components
~~~~~~~~~~~~

nvidia::deepstream::NvDsKittiDump
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Store list of objects in a frame to a file in a modified KITTI metadata format.

* Component ID: 495a66f2-d9ab-4c0a-a8d5-2c4fb3818a7c
* Base Type: nvidia::deepstream::INvDsInPlaceDataHandler

Parameters
++++++++++++

**output-dir**

Directory to write kitti data to.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_STRING

|

**probe-connector**

Handle to an ``nvidia::deepstream::NvDsProbeConnector`` component.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsProbeConnector

nvidia::deepstream::NvDsFpsMeasurement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Measure per source FPS.

* Component ID: ec142ba4-724c-4332-aaaf-7e0746e98446
* Base Type: nvidia::deepstream::INvDsInPlaceDataHandler

Parameters
++++++++++++

**enable**

Enable FPS measurement.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_BOOL
* Default: True

|

**interval**

Interval in seconds to print the FPS values.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_UINT64
* Default: 5

|

**print-time**

Print the current time along with the FPS values.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_BOOL
* Default: False

|

**probe-connector**

Handle to an ``nvidia::deepstream::NvDsProbeConnector`` component.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsProbeConnector

nvidia::deepstream::NvDsLatencyMeasurement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Measure overall pipeline and per component latency. Requires exporting environment variable ``NVDS_ENABLE_LATENCY_MEASUREMENT=1``. Additionally to for per-component latency export ``NVDS_ENABLE_COMPONENT_LATENCY_MEASUREMENT=1``.

* Component ID: 43d4a2b8-7892-4e10-ae5d-fc15cbb54cd5
* Base Type: nvidia::deepstream::INvDsInPlaceDataHandler

Parameters
++++++++++++

**enable**

Enable latency measurement.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_BOOL
* Default: True

|

**probe-connector**

Handle to an ``nvidia::deepstream::NvDsProbeConnector`` component.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsProbeConnector

nvidia::deepstream::NvDsAudioClassificationPrint
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sample probe to print audio classification labels.

* Component ID: 2071b190-5f0a-40fb-a420-5ead5da214a0
* Base Type: nvidia::deepstream::INvDsInPlaceDataHandler

Parameters
++++++++++++

**probe-connector**

Handle to an ``nvidia::deepstream::NvDsProbeConnector`` component.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsProbeConnector

nvidia::deepstream::NvDsPerClassObjectCounting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Count and print number of objects per class in the current batch.

* Component ID: 5dc37884-ea36-4bf2-810c-f7b7821090a5
* Base Type: nvidia::deepstream::INvDsInPlaceDataHandler

Parameters
++++++++++++

**overlay-count**

Whether to overlay the per class object count on the frame.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_BOOL
* Default: True

|

**probe-connector**

Handle to an ``nvidia::deepstream::NvDsProbeConnector`` component.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsProbeConnector

nvidia::deepstream::NvDsModelEngineWatchOTFTrigger
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Watch a model engine file for updates and trigger on-the-fly model update on a ``NvDsInferVideo`` component.

* Component ID: d64b11b7-97cf-4de4-a2ac-772da9295008
* Base Type: nvidia::deepstream::INvDsComponent

Parameters
++++++++++++

**nvdsinfervideo-prop-controller**

Handle to an ``NvDsInferVideoPropertyController`` component.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsInferVideoPropertyController

|

**watch-file**

Engine file to watch for updates and trigger on-the-fly model update.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_FILE

nvidia::deepstream::NvDsRoiClassificationResultParse
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Parse classification results for an ROI and attach as OSD text

* Component ID: 86d9071a-bbe8-4c1a-a721-353cc83610b6
* Base Type: nvidia::deepstream::INvDsInPlaceDataHandler

Parameters
++++++++++++

**probe-connector**

Handle to a nvidia::deepstream::NvDsProbeConnector component

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsProbeConnector


nvidia::deepstream::NvDsMetaDeserialize
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Component to deserialize DeepStream metadata and attach to buffer

* Component ID: fd3771a8-e342-3ac2-a28b-ab92f25b58c9
* Base Type: nvidia::deepstream::INvDsElement

Parameters
++++++++++++

**deserialize-lib**

Set de-serialization library Name to be used

* Flags: GXF_PARAMETER_FLAGS_NONE
* Type: GXF_PARAMETER_TYPE_STRING

|

**video-out**

Handle to a nvidia::deepstream::NvDsStaticOutput component. Supported formats - video(ANY);audio(ANY)

* 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(ANY);audio(ANY)

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsStaticInput


nvidia::deepstream::NvDsMetaSerialize
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Component to serialize DeepStream metadata attached to a buffer

* Component ID: 9b9181cd-8b6d-3dac-bd7d-aac21fe993da
* Base Type: nvidia::deepstream::INvDsElement

Parameters
++++++++++++

**serialize-lib**

Set serialization library Name to be used

* Flags: GXF_PARAMETER_FLAGS_NONE
* Type: GXF_PARAMETER_TYPE_STRING

|

**video-out**

Handle to a nvidia::deepstream::NvDsStaticOutput component. Supported formats - video(ANY);audio(ANY)

* 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(ANY);audio(ANY)

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_HANDLE
* Handle Type: nvidia::deepstream::NvDsStaticInput