react-native-vision-camera-face-detector/src/specs/FaceDetectorFactory.nitro.ts

Frame Processor Plugin to detect faces using MLKit Vision Face Detector for React Native Vision Camera!

import type {
  CameraOutput,
  CameraPosition
} from 'react-native-vision-camera'
import type { HybridObject } from 'react-native-nitro-modules'
import type { Face } from './Face.nitro'
import type { FaceDetector } from './FaceDetector.nitro'
import type { ImageFaceDetectorOptions } from './ImageFaceDetectorFactory.nitro'

export interface FaceDetectorOptions
  extends ImageFaceDetectorOptions {
  /**
   * Current active camera
   * 
   * @default front
   */
  cameraFacing?: CameraPosition

  /**
   * Should auto scale (face bounds, contour and landmarks) and rotation on native side? 
   * This option must be disabled/undefined if you want to draw on frame using `Skia Frame Processor`.
   * See [this](https://github.com/luicfrr/react-native-vision-camera-face-detector/issues/30#issuecomment-2058805546) and [this](https://github.com/luicfrr/react-native-vision-camera-face-detector/issues/35) for more details. 
   * 
   * @default false
   */
  autoMode?: boolean

  /**
   * Required if you want to use `autoMode`. You must handle your own logic to get screen sizes, with or without statusbar size, etc...
   * 
   * @default 1.0
   */
  windowWidth?: number

  /**
   * Required if you want to use `autoMode`. You must handle your own logic to get screen sizes, with or without statusbar size, etc...
   * 
   * @default 1.0
   */
  windowHeight?: number
}

/**
 * Controls the camera buffer resolution used for barcode scanning.
 *
 * - `'preview'`: Prefer preview-sized buffers for lower latency.
 * - `'full'`: Prefer full/highest available buffers for better detail.
 */
export type FaceDetectorOutputResolution = 'preview' | 'full'

export interface FaceDetectorOutputOptions
  extends FaceDetectorOptions {
  /**
   * Controls which camera buffer resolution should be used.
   *
   * - `'preview'`: Prefer preview-sized buffers for lower latency.
   * - `'full'`: Prefer full/highest available buffers for better detail.
   *
   * @default 'preview'
   */
  outputResolution?: FaceDetectorOutputResolution
  /**
   * Called whenever faces have been detected.
   */
  onFacesDetected: (
    faces: Face[]
  ) => void

  /**
   * Called when there was an error detecting faces.
   */
  onError: ( error: Error ) => void
}

export interface FaceDetectorFactory
  extends HybridObject<{
    ios: 'swift',
    android: 'kotlin'
  }> {
  /**
   * Create a new {@linkcode FaceDetector}.
   */
  createFaceDetector( options: FaceDetectorOptions ): FaceDetector

  /**
   * Create a new {@linkcode CameraOutput} that can
   * detect Barcodes.
   */
  createFaceDetectorOutput( options: FaceDetectorOutputOptions ): CameraOutput
}