Skip to content

Commit 4a22da8

Browse files
committed
[GST gvawatermark] document explicit enable-blur flag usage
update gvawatermark documentation to explicit the need for "enable-blur" flag to enable the blurring feature either ROI blur filter is enabled or not. Signed-off-by: Walid <walid.aly@intel.com>
1 parent 6e4ccec commit 4a22da8

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

docs/user-guide/elements/gvawatermark.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Element Properties:
7777
* show-roi=<string> colon-separated list of labels to include (only these objects will be shown), default empty
7878
* hide-roi=<string> colon-separated list of labels to exclude (these objects will be hidden), default empty
7979
* enable-blur=<bool> enable ROI blurring for privacy protection, default false
80+
NOTE : enable-blur flag must be enabled either ROI blur filter is enabled or not
8081
NOTE : show-blur-roi takes precedence over hide-blur-roi when both are specified
8182
NOTE : this option is supported only for CPU for now.
8283
* show-blur-roi=<string> colon-separated list of object labels to blur (e.g., "face:person")
@@ -191,7 +192,7 @@ The gvawatermark element supports privacy protection through region of interest
191192
192193
Blur functionality is controlled through the `displ-cfg` parameter with these options:
193194
194-
- **enable-blur=<bool\>** - Enable or disable blur feature (default: false)
195+
- **enable-blur=<bool\>** - Enable or disable blur feature (default: false) this flag must be enabled either ROI blur filter is enabled or not.
195196
- **show-blur-roi=<string\>** - Colon-separated list of object labels to blur (e.g., "person:face")
196197
- **hide-blur-roi=<string\>** - Colon-separated list of object labels to exclude from blurring
197198

src/monolithic/gst/elements/gvawatermark/gstgvawatermarkimpl.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ enum { PROP_0, PROP_DEVICE, PROP_OBB, PROP_DISPL_AVGFPS, PROP_DISPL_CFG };
8787
"\t\t\thide-roi=<string> colon-separated list of labels to exclude (these objects will be hidden), default " \
8888
"empty\n" \
8989
"\t\t\tenable-blur=<bool> enable or disable ROI blurring for privacy protection, default false\n" \
90+
"\t\t\tthis flag must be enabled either ROI blur filter is enabled or not.\n" \
9091
"\t\t\tshow-blur-roi=<string> colon-separated list of object labels to blur (e.g. 'face:person')\n" \
9192
"\t\t\thide-blur-roi=<string> colon-separated list of object labels to exclude from blurring\n" \
9293
"\t\t\tNOTE: show-blur-roi takes precedence over hide-blur-roi when both are specified\n" \

0 commit comments

Comments
 (0)