TypeScript SDK Reference / CustomConditionRange

Interface: CustomConditionRange

Defines a customized range for condition checking during scanning. This allows fine-tuning the acceptable ranges for face distance and position relative to the camera frame.

Deprecated

This interface is deprecated and will be removed in a future version. Use ConditionCheckerConfig instead.

Example

const customRange: CustomConditionRange = {
  distanceRange: [30, 80], // Face should be between 30-80 cm
  boundaryRangeX: { min: 0.2, max: 0.8 }, // Face center X between 20%-80% of frame
  boundaryRangeY: { min: 0.1, max: 0.9 }  // Face center Y between 10%-90% of frame
};

Properties

boundaryRangeX?

optional boundaryRangeX: NumberRange

Acceptable horizontal position range as fraction of frame width.

---

boundaryRangeY?

optional boundaryRangeY: NumberRange

Acceptable vertical position range as fraction of frame height.

---

distanceRange?

optional distanceRange: NumberRange

Acceptable distance range from camera in cm.