careplix-web-algo/faceScan.d.ts

CarePlix Web NPM Package to process Raw-Data from Camera Input

declare type intensity = { r: number; g: number; b: number };
declare function startScan({
  calibrationTime_inSec,
  scanTime_inSec,
  liteModeRedetectionInterval_inSec,
  models_path,
  draw_type,
  draw_color,
  strict_mode,
  videoElement,
  canvasElement,
}: {
  calibrationTime_inSec?: number;
  scanTime_inSec?: number;
  liteModeRedetectionInterval_inSec?: number;
  models_path?: string;
  draw_type?: "face-circle" | "bounding-box" | "corner-box";
  draw_color?: string;
  strict_mode?: boolean;
  videoElement: HTMLVideoElement;
  canvasElement: HTMLCanvasElement;
}): Promise<void>;
declare function stopScan(noCallback?: boolean): void;
declare namespace faceScan {
  export { startScan };
  export { stopScan };
  export function onFrame(
    callback: ({
      type,
      timeElapsed,
      percentage,
      isFaceInView,
      isLiteMode,
    }: {
      type: "calibration" | "scan";
      timeElapsed: number;
      percentage: number;
      isFaceInView: boolean;
      isLiteMode: boolean;
    }) => void
  ): void;
  export function onScanFinish(
    callback: ({
      raw_intensity,
      ppg_time,
      average_fps,
    }: {
      raw_intensity: intensity[];
      ppg_time: number[];
      average_fps: number;
    }) => void
  ): void;
  export function onError(callback: (err: Error) => void): void;
  export function isInitializing(): boolean;
  export function isScanning(): boolean;
}
export default faceScan;