@regulaforensics/face-sdk
    Preparing search index...

    Class MatchFacesImage

    This class represents the input image and its attributes for MatchFacesRequest.

    Index
    constructor
    detectAll identifier image imageType

    • Parameters

      • image: string
      • imageType: ImageType
      • Optionaloptions: { detectAll?: boolean }

      Returns MatchFacesImage

    • get detectAll(): boolean

      Defines whether the comparison and detection should apply for all faces found on the image. Defaults to false. When set to false, only the most centered faces are compared and detected. Otherwise, all the faces are compared and detected.

      Returns boolean

    • get identifier(): string

      Returns string

    • get image(): string

      The underlying image.

      Returns string

    • get imageType(): ImageType

      The image type. The imageType influences matching results, therefore this field is required.

      Returns ImageType

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors