Class MatchFacesImage

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

Constructors

constructor

Accessors

detectAll identifier image imageType

Constructors

constructor

  • new MatchFacesImage(image, imageType, params?): MatchFacesImage

  • Parameters

    • image: string
    • imageType: ImageType
    • Optionalparams: {
          detectAll?: boolean;
      }
      • OptionaldetectAll?: boolean

    Returns MatchFacesImage

Accessors

detectAll

  • 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

identifier

  • get identifier(): string

  • Returns string

image

  • get image(): string

  • The underlying image.

    Returns string

imageType

  • 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