NvDsVisualizationExt
NVIDIA components for visualization.
UUID: 25903cd4-fc5c-4139-987b-47bb27e8b424
Version: 1.4.0
Author: NVIDIA
License: Proprietary
Components
nvidia::deepstream::NvDsOSDPropertyController
Helper component to control properties of nvidia::deepstream::NvDsOSD. This is a connector component. It must be linked to two components - the NvDsOSD component to control properties, and another component which will set/get properties via the helper component APIs.
Component ID: d4865eb4-fffb-314e-acd9-9a8a49e3c03b
Base Type: nvidia::deepstream::INvDsPropertyController
Defined in: nvdsvisualization/nvdsvisualization_prop_controllers.hpp
nvidia::deepstream::NvDsOSD
Nvidia DeepStreamSDK NvOSD Bin. Internal Pipeline: queue->nvvidconv->queue->nvosd.
Refer to nvdsosd plugin
Component ID: c2d4834f-0829-39d8-9875-3c6b1c9827dc
Base Type: nvidia::deepstream::INvDsElement
Parameters
bbox-bg-colors
Background Colors for object bounding boxes. Format - <class-label1>=hex1;<class-label2>=hex2. hex is in RGBA hex format.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_STRING
bbox-border-colors
Border Colors for object bounding boxes. Format - <class-label1>=hex1;<class-label2>=hex2. hex is in RGBA hex format.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_STRING
border-width
Border width to set for object bounding boxes.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
clock-color
clock-color.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
clock-font
Clock font to be set.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_STRING
clock-font-size
Font size of the clock.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
display-bbox
Boolean to control the display of bounding boxes.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_BOOL
display-clock
Boolean to control the display of the clock.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_BOOL
Default: False
display-mask
Boolean to control the display of instance mask.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_BOOL
Default: False
display-text
Boolean to control the display of text.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_BOOL
Default: True
display-tracking-id
Boolean to control display of tracking ids in object labels.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_BOOL
Default: True
font
Font to use for object labels.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_STRING
Default: Serif
gpu-id
Set GPU Device ID.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
hw-blend-color-attr
Color attributes for all classes. Use string with values of color class attributes in ClassID (int), r(float), g(float), b(float), a(float) in order to set the property. Applicable only for HW mode on Jetson. e.g. 0,0.0,1.0,0.0,0.3:1,1.0,0.0,0.3,0.3.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_STRING
Default: 0,0.000000,0.000000,0.000000,0.000000:
nvbuf-memory-type
Type of NvBufSurface Memory to be allocated for output buffers.
Valid values:
0: nvbuf-mem-default
1: nvbuf-mem-cuda-pinned
2: nvbuf-mem-cuda-device
3: nvbuf-mem-cuda-unified
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: 0
process-mode
Rect and text draw process mode.
Valid values:
0: CPU_MODE
1: GPU_MODE
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: 0
property-controller
Property Controller for NvDsOSD component.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::NvDsOSDPropertyController
reformat-object-labels
Reformat object labels with format <primary label> [tracking-id] <secondary-labels-sorted-by-component-id>.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_BOOL
Default: False
text-bg-color
Text background color to set for object labels. RGBA hex format e.g. 0xff000044 for semi-transparent red.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
text-color
Text color to set for object labels. RGBA hex format e.g. 0xff000044 for semi-transparent red.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
text-size
Text size to set for object labels.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
video-in
Handle to an nvidia::deepstream::NvDsStaticInput component. Supported formats - video(I420, NV12, P010_10LE, BGRx, RGBA, GRAY8, GBR, RGB, BGR, UYVP).
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(RGBA).
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::NvDsStaticOutput
x-clock-offset
x-clock-offset.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
y-clock-offset
y-clock-offset.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
nvidia::deepstream::NvDsTiler
Tile input multi-stream buffer into a 2D array. Internal Pipeline: queue->nvmultistreamtiler.
Component ID: cea150e2-d8fb-3d59-b835-1b0564633e2e
Base Type: nvidia::deepstream::INvDsElement
Parameters
columns
Number of columns in the Tiled 2D output.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 1
compute-hw
Compute Scaling HW.
Valid values:
0: Default
1: GPU
2: VIC
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: 0
gpu-id
Set GPU Device ID.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
height
Height of the tiled output in pixels.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 1080
interpolation-method
Set interpolation methods.
Valid values:
0: Nearest
1: Bilinear
2: Algo-1
3: Algo-2
4: Algo-3
5: Algo-4
6: Default
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: 0
nvbuf-memory-type
Type of NvBufSurface Memory to be allocated for output buffers.
Valid values:
0: nvbuf-mem-default
1: nvbuf-mem-cuda-pinned
2: nvbuf-mem-cuda-device
3: nvbuf-mem-cuda-unified
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: 0
rows
Number of rows in the Tiled 2D output.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 1
show-source
ID of the source to be shown. If -1 all the sources will be tiled else only a single source will be scaled into the output buffer.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: -1
video-in
Handle to an 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
width
Width of the tiled output in pixels.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 1920
nvidia::deepstream::NvDsSegVisual
Gstreamer NV Segmentation Visualization Plugin.
Component ID: bf8cc54c-b420-3172-9e24-3e47151eb905
Base Type: nvidia::deepstream::INvDsElement
Parameters
batch-size
Maximum batch size for inference.
Flags: GXF_PARAMETER_FLAGS_NONE
Type: GXF_PARAMETER_TYPE_UINT64
gpu-id
Set GPU Device ID.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
height
Height of each frame in output batched buffer.
Flags: GXF_PARAMETER_FLAGS_NONE
Type: GXF_PARAMETER_TYPE_UINT64
video-in
Handle to an 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(RGBA).
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::NvDsStaticOutput
width
Width of each frame in output batched buffer.
Flags: GXF_PARAMETER_FLAGS_NONE
Type: GXF_PARAMETER_TYPE_UINT64
nvidia::deepstream::NvDsBlender
Blend multiple video streams.
Component ID: 77e0adad-20ad-3222-a43c-60c42d5313d8
Base Type: nvidia::deepstream::INvDsElement
Parameters
background
Background type.
Valid values:
0: checker
1: black
2: white
3: transparent
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: 0
batched-background
Background is batched.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_BOOL
Default: True
gpu-id
GPU ID.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: 0
latency
Additional latency in live mode to allow upstream to take longer to produce buffers for the current position (in nanoseconds).
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
min-upstream-latency
When sources with a higher latency are expected to be plugged in dynamically after the aggregator has started playing, this allows overriding the minimum latency reported by the initial source(s). This is only taken into account when larger than the actually reported minimum latency (nanoseconds).
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 0
start-time
Start time to use if s``tart-time-selection=set``.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_UINT64
Default: 18446744073709551615
start-time-selection
Decides which start time is output.
Valid values:
0: zero
1: first
2: set
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_INT64
Default: 0
video-in-%u
Handle to an nvidia::deepstream::NvDsOnRequestInput component. Supported formats - video(NV12, RGBA).
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::NvDsOnRequestInput
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::NvDsTilerEventHandler
Handle mouse and keyboard events for the DeepStream NvMultiStreamTiler plugin.
Left click on a source in the tile to expand it. Right click to go back to the tiled view. For keyboard events, z<row-idx><col-idx> expands the source at location (<row-idx>,<col-idx>). Click on z to go back to tiled view.
Also toggles text overlay, disabled in tiled view, enabled when a source is expanded.
Component ID: ea9e2715-e4b6-481b-b36e-71e7397f4cf2
Base Type: nvidia::deepstream::INvDsComponent
Parameters
handle-mouse-events
Handle mouse events on the video renderer. Requires the ‘renderer’ parameter to be set.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_BOOL
Default: True
kb-input
Handle to a NvDsKeyboardInput component to read keyboard input.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::INvDsKeyboardInput
latency-probe-connector
Handle to an nvidia::deepstream::NvDsProbeConnector component. The IO the probe will be installed on is used for latency measurement.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::NvDsProbeConnector
nvdsosd-prop-controller
Handle to an nvidia::deepstream::NvDsOSDPropertyController component.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::NvDsOSDPropertyController
renderer-prop-controller
Handle to an nvidia::deepstream::NvDsVideoRendererPropertyController component.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::NvDsVideoRendererPropertyController
tiler-out
Handle to an nvidia::deepstream::NvDsProbeConnector component.
Flags: GXF_PARAMETER_FLAGS_OPTIONAL
Type: GXF_PARAMETER_TYPE_HANDLE
Handle Type: nvidia::deepstream::NvDsProbeConnector