Skip to content

[GST gvawatermark] document explicit enable-blur flag usage #757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
walidbarakat wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −1
Open

[GST gvawatermark] document explicit enable-blur flag usage #757

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2e502b
[GST gvawatermark] document explicit enable-blur flag usage
walidbarakat Apr 10, 2026
d12be1f
Merge branch 'main' into update_watermark_ROI_filter_doc
tbujewsk Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/user-guide/elements/gvawatermark.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Element Properties:
* show-roi=<string> colon-separated list of labels to include (only these objects will be shown), default empty
* hide-roi=<string> colon-separated list of labels to exclude (these objects will be hidden), default empty
* enable-blur=<bool> enable ROI blurring for privacy protection, default false
NOTE : Blurring is applied only when "enable-blur=true"; if no "show-blur-roi" / "hide-blur-roi" filters are set, all ROIs are blurred
NOTE : show-blur-roi takes precedence over hide-blur-roi when both are specified
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new NOTE line is missing a trailing period and uses quoted parameter names/values. For consistency with the rest of the doc (which commonly uses inline code formatting like displ-cfg=...), consider switching these to backticks and ending the sentence with a period.

Suggested change
NOTE : show-blur-roi takes precedence over hide-blur-roi when both are specified
NOTE : `show-blur-roi` takes precedence over `hide-blur-roi` when both are specified.

Copilot uses AI. Check for mistakes.
NOTE : this option is supported only for CPU for now.
* show-blur-roi=<string> colon-separated list of object labels to blur (e.g., "face:person")
Expand Down Expand Up @@ -191,7 +192,8 @@ The gvawatermark element supports privacy protection through region of interest

Blur functionality is controlled through the `displ-cfg` parameter with these options:

- **enable-blur=<bool\>** - Enable or disable blur feature (default: false)
- **enable-blur=<bool\>** - Enable or disable blur feature (default: false) Blurring is applied only when "enable-blur=true"; if no "show-blur-roi" / "hide-blur-roi" filters are set, all ROIs are blurred.
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This bullet point combines multiple sentences on one line, which makes the list harder to scan. Consider splitting the extra guidance into a second sentence/line (and using backticks for inline parameters like enable-blur=true, show-blur-roi, hide-blur-roi for consistency).

Suggested change
- **enable-blur=<bool\>** - Enable or disable blur feature (default: false) Blurring is applied only when "enable-blur=true"; if no "show-blur-roi" / "hide-blur-roi" filters are set, all ROIs are blurred.
- **enable-blur=<bool\>** - Enable or disable blur feature (default: false).
Blurring is applied only when `enable-blur=true`. If no `show-blur-roi` / `hide-blur-roi` filters are set, all ROIs are blurred.

Copilot uses AI. Check for mistakes.

- **show-blur-roi=<string\>** - Colon-separated list of object labels to blur (e.g., "person:face")
- **hide-blur-roi=<string\>** - Colon-separated list of object labels to exclude from blurring

Expand Down
2 changes: 2 additions & 0 deletions src/monolithic/gst/elements/gvawatermark/gstgvawatermarkimpl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ enum { PROP_0, PROP_DEVICE, PROP_OBB, PROP_DISPL_AVGFPS, PROP_DISPL_CFG };
"\t\t\thide-roi=<string> colon-separated list of labels to exclude (these objects will be hidden), default " \
"empty\n" \
"\t\t\tenable-blur=<bool> enable or disable ROI blurring for privacy protection, default false\n" \
"\t\t\tBlurring is applied only when `enable-blur=true`\n" \
"\t\t\tif no `show-blur-roi` / `hide-blur-roi` filters are set, all ROIs are blurred.\n" \
"\t\t\tshow-blur-roi=<string> colon-separated list of object labels to blur (e.g. 'face:person')\n" \
"\t\t\thide-blur-roi=<string> colon-separated list of object labels to exclude from blurring\n" \
"\t\t\tNOTE: show-blur-roi takes precedence over hide-blur-roi when both are specified\n" \
Expand Down
Loading