Overlays the metadata on the video frame to visualize the inference results.
Pad Templates:
SINK template: 'sink'
Availability: Always
Capabilities:
video/x-raw
format: { (string)BGRx, (string)BGRA, (string)BGR, (string)NV12, (string)I420 }
width: [ 1, 2147483647 ]
height: [ 1, 2147483647 ]
framerate: [ 0/1, 2147483647/1 ]
video/x-raw(memory:DMABuf)
format: { (string)RGBA, (string)I420 }
width: [ 1, 2147483647 ]
height: [ 1, 2147483647 ]
framerate: [ 0/1, 2147483647/1 ]
video/x-raw(memory:VASurface)
format: { (string)NV12 }
width: [ 1, 2147483647 ]
height: [ 1, 2147483647 ]
framerate: [ 0/1, 2147483647/1 ]
video/x-raw(memory:VAMemory)
format: { (string)NV12 }
width: [ 1, 2147483647 ]
height: [ 1, 2147483647 ]
framerate: [ 0/1, 2147483647/1 ]
SRC template: 'src'
Availability: Always
Capabilities:
video/x-raw
format: { (string)BGRx, (string)BGRA, (string)BGR, (string)NV12, (string)I420 }
width: [ 1, 2147483647 ]
height: [ 1, 2147483647 ]
framerate: [ 0/1, 2147483647/1 ]
video/x-raw(memory:DMABuf)
format: { (string)RGBA, (string)I420 }
width: [ 1, 2147483647 ]
height: [ 1, 2147483647 ]
framerate: [ 0/1, 2147483647/1 ]
video/x-raw(memory:VASurface)
format: { (string)NV12 }
width: [ 1, 2147483647 ]
height: [ 1, 2147483647 ]
framerate: [ 0/1, 2147483647/1 ]
video/x-raw(memory:VAMemory)
format: { (string)NV12 }
width: [ 1, 2147483647 ]
height: [ 1, 2147483647 ]
framerate: [ 0/1, 2147483647/1 ]
Element has no clocking capabilities.
Element has no URI handling capabilities.
Pads:
SINK: 'sink'
Pad Template: 'sink'
SRC: 'src'
Pad Template: 'src'
Element Properties:
async-handling : The bin will handle Asynchronous state changes
flags: readable, writable
Boolean. Default: false
displ-cfg : Comma separated list of KEY=VALUE parameters of displayed notations.
Available options:
show-labels=<bool> enable or disable displaying text labels, default true
font-scale=<double 0.1 to 2.0> scale factor for text labels, default 0.5
thickness=<uint> bounding box thickness, default 2
color-idx=<int> color index for bounding box, keypoints, and text, default -1 (use default colors: 0 red, 1 green, 2 blue)
draw-txt-bg=<bool> enable or disable displaying text labels background, by enabling it the text color is set to white, default true
font-type=<string> font type for text labels, default triplex. Supported fonts: simplex, plain, duplex, complex, triplex, complex_small, script_simplex, script_complex
e.g.: displ-cfg=show-labels=false
e.g.: displ-cfg=font-scale=0.5,thickness=3,color-idx=2,font-type=plain
flags: readable, writable
String. Default: null
device : Supported devices are CPU and GPU. Default is CPU on system memory and GPU on video memory
flags: readable, writable
String. Default: null
displ-avgfps : If true, display the average FPS read from gvafpscounter element on the output video.
The gvafpscounter element must be present in the pipeline.
e.g. ... ! gvawatermark displ-avgfps=true ! gvafpscounter ! ...
flags: readable, writable
Boolean. Default: false
message-forward : Forwards all children messages
flags: readable, writable
Boolean. Default: false
name : The name of the object
flags: readable, writable
String. Default: "gvawatermark0"
parent : The parent of the object
flags: readable, writable
Object of type "GstObject"The following examples demonstrate how different displ-cfg parameters affect the watermark appearance:
Controls the size of text labels displayed on detected objects.
Small Font Scale (font-scale=0.7)
Large Font Scale (font-scale=2.0)
Labels Disabled (show-labels=false)
Shows only bounding boxes without text labels
Text Background Enabled (draw-txt-bg=true)
Blue background makes text more readable over complex backgrounds
Red Color (color-idx=0)
Uses red color for bounding boxes and text
Font Comparison
Comparison of different font types (simplex vs complex)
Default Triplex Font
The default triplex font provides good readability
You can selectively show or hide detected objects based on their labels using filtering parameters:
Include Labels (show-roi=person:car:truck)
- Only objects with labels "person", "car", or "truck" will be displayed
- All other detected objects will be hidden
- Useful for focusing on specific object types
e.g displ-cfg=show-labels=true,show-roi=car
Exclude Labels (hide-roi=bottle:cup:laptop)
- Objects with labels "bottle", "cup", or "laptop" will be hidden
- All other detected objects will be displayed
- Useful for removing distracting or irrelevant objects from the display
e.g displ-cfg=show-labels=true,hide-roi=car
Filter Priority
- If both
show-roiandhide-roiare specified,show-roitakes precedence - Empty lists mean no filtering is applied
# Minimal labels with smaller font
displ-cfg=show-labels=true,show-roi=false
# Large text with background
displ-cfg=font-scale=2.0,draw-txt-bg=true
# Colored thin boxes with simple font
displ-cfg=color-idx=0,thickness=1,font-type=simplex
# Complete custom styling
displ-cfg=font-scale=1.5,thickness=3,color-idx=2,font-type=complex,draw-txt-bg=true
# Show only specific object types
displ-cfg=show-labels=true,show-roi=person:car:truck
# Hide specific object types
displ-cfg=show-labels=true,hide-roi=bottle:cup:laptop
# Combine filtering with styling
displ-cfg=show-labels=true,show-roi=person:car,font-scale=1.2,color-idx=1Average FPS Display (displ-avgfps=true)
Displays average FPS counter when gvafpscounter element is present in pipeline