@face-auth/face-id-video (英语)

只浏览器的 Webcam 工具, 用于启动视频流并捕获静态图像 . 当前软件包版本 : 0.0.3。 。 。 .

安装

npm install @face-auth/face-id-video

许可证

专有跑时专用许可证. 您可以执行软件包的未修改副本, 但不允许修改、再分配、分许可证和其他再利用. 见 LICENSE。 。 。 .

公共 API

只从软件包根导入 。 深度进口 dist/ 或者说 dist/src/ 不属于公共合同.

类

• FaceVideo

导出类型

• CameraError
• CameraOptions
• CaptureOptions
• CaptureResult
• FaceVideoElement
• OvalDimensions

FaceVideo

创建一个相机/抓取管理器 HTMLVideoElement。 。 。 .

import { FaceVideo } from "@face-auth/face-id-video";

const videoElement = document.getElementById("videoRef") as HTMLVideoElement;
const faceVideo = new FaceVideo(videoElement);

方法

• getDevices(): Promise<MediaDeviceInfo[]>
• start(options?: CameraOptions, deviceId?: string): Promise<void>
• capture(options: CaptureOptions): Promise<CaptureResult>
• stop(): void
• onCameraStarted(callback): void
• offCameraStarted(callback): void

相机选择

您可以向浏览器询问可用的视频输入 :

const devices = await faceVideo.getDevices();

devices.forEach((device) => {
  console.log(device.deviceId, device.label);
});

要启动溪流,要么提供 preferredFacingMode 或通过特定的 deviceId 作为第二个论点.

await faceVideo.start({
  preferredFacingMode: "user",
  idealResolution: { width: 1280, height: 720 }
});

const devices = await faceVideo.getDevices();
const selectedDeviceId = devices[0]?.deviceId;

await faceVideo.start(
  {
    preferredFacingMode: "environment",
    idealResolution: { width: 1280, height: 720 }
  },
  selectedDeviceId
);

抓取输出

capture() 返回 a CaptureResult 带有 blob 决议 imageType。 。 。 .

const result = await faceVideo.capture({
  imageType: "image/jpeg"
});

console.log(result.blob);
console.log(result.imageType);

若为 imageType ,软件包使用 image/png 默认.

相机启动事件

const handleCameraStarted = () => {
  console.log("Camera is ready");
};

faceVideo.onCameraStarted(handleCameraStarted);

await faceVideo.start({
  preferredFacingMode: "user"
});

faceVideo.offCameraStarted(handleCameraStarted);

运行时间合同

CameraOptions

interface CameraOptions {
  preferredFacingMode?: "user" | "environment";
  idealResolution?: { width: number; height: number };
}

CaptureOptions

interface CaptureOptions {
  imageType?: string;
}

CaptureResult

interface CaptureResult {
  blob: Blob;
  imageType: string;
}

相机错误

何时 start() 失败, 抛出的错误可能包括其中之一 code 值 :

• PERMISSION_DENIED
• NO_DEVICES
• OVERCONSTRAINED
• UNKNOWN

页:1

• capture() 必须在后面调用 start()。 。 。 .
• 软件包目前返回抓取的图像为 Blob它不直接返回 Base64.
• 目标环境为浏览器.