Options
All
  • Public
  • Public/Protected
  • All
Menu

This service handles managing (adding, removing, updating, etc) faces.

Hierarchy

  • FaceManagementServiceBase
    • FaceManagementService

Index

Constructors

constructor

Properties

Protected capture

capture: FaceCapture

Protected resources

resources: AppResources

Contains the application resources (database, logger, etc).

Methods

AddFace

  • AddFace(inputImage: Uint8Array | Mat, name: string, autostart?: boolean, skipDetection?: boolean): Promise<Face>
  • Adds a face to the database, scanning the provided image for a face.

    Parameters

    • inputImage: Uint8Array | Mat

      Image to add.

    • name: string

      Friendly name of the face.

    • Default value autostart: boolean = false

      Whether the face should be loaded on application start.

    • Default value skipDetection: boolean = false

      If true, will skip scanning the provided image for a face.

    Returns Promise<Face>

AddFaceFromCamera

  • AddFaceFromCamera(name: string, autostart?: boolean): Promise<Face>
  • Adds a face detected in the capture source to the database.

    Parameters

    • name: string

      Friendly name of the face.

    • Default value autostart: boolean = false

      Whether the face should be loaded on application start.

    Returns Promise<Face>

GetFace

  • GetFace(faceId: number): Promise<Face>
  • Retrieves a face from the database.

    Parameters

    • faceId: number

      ID of the face to retrieve

    Returns Promise<Face>

GetFaces

  • GetFaces(): Promise<Face[]>
  • Retrieves all faces from the database.

    Returns Promise<Face[]>

RemoveFace

  • RemoveFace(faceId: number): Promise<void>
  • Removes a face from the database.

    Parameters

    • faceId: number

      ID of the face to remove.

    Returns Promise<void>

UpdateFace

  • UpdateFace(face: Face, scanForFace?: boolean, imageFromCamera?: boolean): Promise<Face>
  • Upates an existing face.

    Parameters

    • face: Face

      Object containing properties to update.

    • Default value scanForFace: boolean = false

      If true, will scan the image property for a face.

    • Default value imageFromCamera: boolean = false

      If true, will attempt to detect a face in the capture source.

    Returns Promise<Face>

Generated using TypeDoc