Table of Contents

Class PIIRedactionSettings

Namespace
VisioForge.Core.Types.X.AI
Assembly
VisioForge.Core.dll

Settings for the PII redaction block, which automatically obscures personally identifiable information in video frames: faces (YuNet), vehicle license plates (FastALPR detector), and on-screen text (PaddleOCR detector, with an optional regex filter on the recognized text). Each category can be enabled independently and all use detection only — nothing is identified, recognized, or exported unless the text regex filter explicitly requires recognition.

public class PIIRedactionSettings

Inheritance

Inherited Members

Remarks

Detection runs on a background worker; the streaming thread redacts every frame using the most recent regions. VisioForge.Core.Types.X.AI.PIIRedactionSettings.RegionPaddingPercent and VisioForge.Core.Types.X.AI.PIIRedactionSettings.RegionHoldTimeMs compensate for object motion and detector flicker between detection cycles, so a region stays covered while the worker catches up. Frames arriving before the first detection result completes are passed through unredacted — for zero-leak offline redaction, process files at reduced speed instead of live. Regions are computed at the resolution the detector ran on; if the source changes resolution mid-stream (for example adaptive HLS/RTSP switching up to a higher resolution), the newly exposed area can briefly leak PII until the next detection cycle re-derives regions at the new resolution.

Properties

BlurRadius

Gets or sets the Gaussian blur sigma used by VisioForge.Core.Types.X.AI.PIIRedactionStyle.GaussianBlur. Defaults to 20.

public float BlurRadius { get; set; }

Property Value

float

DeviceId

Gets or sets the device identifier for hardware execution providers (the GPU index for CUDA/DirectML). Defaults to 0.

public int DeviceId { get; set; }

Property Value

int

Faces

Gets the face-category settings.

public PIIFaceRedactionSettings Faces { get; }

Property Value

PIIFaceRedactionSettings

FillColor

Gets or sets the fill color used by VisioForge.Core.Types.X.AI.PIIRedactionStyle.SolidFill. Defaults to black.

public SKColor FillColor { get; set; }

Property Value

SKColor

FramesToSkip

Gets or sets the number of frames to skip between detections on live video. 0 submits every frame (frames are still dropped while the background worker is busy). Defaults to 0.

public int FramesToSkip { get; set; }

Property Value

int

LicensePlates

Gets the license-plate-category settings.

public PIIPlateRedactionSettings LicensePlates { get; }

Property Value

PIIPlateRedactionSettings

PixelateBlockSize

Gets or sets the mosaic cell size, in pixels, used by VisioForge.Core.Types.X.AI.PIIRedactionStyle.Pixelate. Defaults to 16.

public int PixelateBlockSize { get; set; }

Property Value

int

Provider

Gets or sets the execution provider used by the detection sessions. Defaults to VisioForge.Core.Types.X.AI.OnnxExecutionProvider.Auto.

public OnnxExecutionProvider Provider { get; set; }

Property Value

OnnxExecutionProvider

RegionHoldTimeMs

Gets or sets how long, in milliseconds, a category's regions stay redacted after the detector stops reporting them. Prevents PII from flashing through when detection flickers for a few frames. Defaults to 700.

public int RegionHoldTimeMs { get; set; }

Property Value

int

RegionPaddingPercent

Gets or sets how much each detected box is expanded per side, as a fraction of its size (0.15 = 15% per side). Padding compensates for object motion between detection cycles. Defaults to 0.15.

public float RegionPaddingPercent { get; set; }

Property Value

float

Style

Gets or sets the redaction style applied to detected regions. Can be changed while the pipeline is running. Defaults to VisioForge.Core.Types.X.AI.PIIRedactionStyle.GaussianBlur.

public PIIRedactionStyle Style { get; set; }

Property Value

PIIRedactionStyle

Text

Gets the on-screen-text-category settings.

public PIITextRedactionSettings Text { get; }

Property Value

PIITextRedactionSettings