Help prepare for 2025 → Answer 8 simple questions on our Fall Survey
Open Survey

View on GitHub

@nativescript/mlkit-face-detection

A plugin that is used with @nativescript/mlkit-core to enable face detection and provide the FaceResult type for the data of the face detection event.

Contents

Installation

Install @nativescript/mlkit-face-detection by running the following command:

cli
npm install @nativescript/mlkit-face-detection

Use @nativescript/mlkit-face-detection

For more details, read use @nativescript/mlkit-core and @nativescript/mlkit-core

API

FaceResult

The Face Detection event data type.

ts
interface FaceResult {
  smilingProbability: number
  leftEyeOpenProbability: number
  rightEyeOpenProbability: number
  trackingId: number
  bounds: Bounds
  headEulerAngleZ: number
  headEulerAngleY: number
  headEulerAngleX: number
}

Bounds

ts
interface Bounds {
  origin: Origin
  size: Size
}

Origin

ts
interface Origin {
  x: number
  y: number
}

Size

ts
interface Size {
  width: number
  height: number
}

License

Apache License Version 2.0