NvDsSampleExt
---------------
Sample components for demonstrating usage of various DeepStream interfaces and components.

* UUID: 44a711e4-8519-4a68-81e8-be7ee4af3ff0
* Version: 0.0.3
* Author: NVIDIA
* License: Proprietary

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

nvidia::deepstream::NvDsSampleProbeMessageMetaCreation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sample probe handler demonstrating creation of ``NvDsEventMsgMeta`` for sending messages to cloud. ***This is only a temporary implementation.***

* Component ID: 7995ee1f-8be0-40d4-a35f-b2679850b7b2
* Base Type: nvidia::deepstream::INvDsInPlaceDataHandler

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

**car-color-unique-id**

Unique ID of the ``NvDsInferVideo`` component configured for car color classification.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_UINT64

|

**car-make-unique-id**

Unique ID of the ``NvDsInferVideo`` component configured for car make classification.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_UINT64

|

**generate-dummy-data**

Generate dummy data to be attached as ``NvDsEventMsgMeta``, if false or not set, uses metadata generated by the pipeline.

* 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

|

**vehicle-type-unique-id**

Unique ID of the ``NvDsInferVideo`` component configured for vehicle type classification.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_UINT64

nvidia::deepstream::NvDsSampleSourceManipulator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sample component demonstrating adding/removing sources at runtime.

* Component ID: 717b2c43-2f10-4fe8-b961-65e408ece299
* Base Type: nvidia::deepstream::INvDsComponent

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

**interval-sec**

Interval in seconds at which the sources will be added/removed.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_UINT64
* Default: 10

|

**max-num-sources**

Maximum number of sources to add to the ``NvDsMultiSrcInput`` component.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_UINT64
* Default: 4

|

**source-manip-action**

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

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

|

**uri**

URI to add. Same URI will be added multiple times.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_STRING

nvidia::deepstream::NvDsSampleVideoTemplateLib
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sample component demonstrating usage of DeepStream's video template plugin configuration component. The sample component scales video frame.

* Component ID: 7a6e75f1-da4d-4819-8861-3ea49328ade7
* Base Type: nvidia::deepstream::INvDsVideoTemplatePluginConfigComponent

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

**scale-factor**

Video frame scaling factor

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_FLOAT64
* Default: 1.0

nvidia::deepstream::NvDsSampleAudioTemplateLib
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sample component demonstrating usage of DeepStream's audio template plugin configuration component. The sample component adds noise to the input audio.

* Component ID: 69571eda-411a-4de6-8ca0-ad5bd2c29353
* Base Type: nvidia::deepstream::INvDsAudioTemplatePluginConfigComponent

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

**noise-factor**

Noise to add to the input audio.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_FLOAT64
* Default: 1.0

nvidia::deepstream::NvDsSampleC2DSmartRecordTrigger
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sample component for demonstrating cloud to device(C2D) communication and handling C2D messages. This component triggers smart record start/stop action on the ``NvDsMultiUriSrcInput`` component. Expected JSON schema for the messages: ::

     {
     ....command:string,        // <start-recording / stop-recording>
     ....start: string,         // "2020-05-18T20:02:00.051Z"
     ....end: string,           // "2020-05-18T20:02:02.851Z"
     ....sensor: {
     ........id: string         // sensor name in msgconv config
     ....}
     }

* Component ID: 5f358981-6081-44c4-a1c0-017ac49a7215
* Base Type: nvidia::deepstream::INvDsComponent

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

**msg-rx**

Handle to a ``NvDsMsgRelayReceiver`` component.

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

|

**msgconv-config**

Path to a ``NvDsMsgConv`` config file containing the sensor information.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_FILE

|

**smart-record-action**

Handle to a ``NvDsMultiSourceSmartRecordAction`` component.

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

|

**smart-record-done-signal**

Handle to a ``NvDsSrDoneSignal`` component.

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

nvidia::deepstream::NvDsSampleD2C_SRMsgGenerator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sample component for demonstrating device to cloud(C2D). This component generates JSON messages which can be consumed by ``NvDsSampleC2DSmartRecordTrigger`` component to trigger smart record start/stop.

* Component ID: e6dcc34b-542b-4680-8d61-72a2cfc5e1de
* Base Type: nvidia::deepstream::INvDsComponent

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

**msg-tx**

Handle to a ``NvDsMsgRelayTransmitter`` component.

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

|

**msgconv-config**

Path to a ``NvDsMsgConv`` config file containing the sensor information.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_FILE

|

**topic**

Topic to send the messages on.

* Flags: GXF_PARAMETER_FLAGS_OPTIONAL
* Type: GXF_PARAMETER_TYPE_STRING