Class OutputImageCrop

Crop settings for OutputImageParams.

Constructors

constructor

Accessors

padColor returnOriginalRect size type

Constructors

constructor

  • new OutputImageCrop(type, params?): OutputImageCrop

  • Parameters

    • type: OutputImageCropAspectRatio
    • Optionalparams: {
          padColor?: number;
          returnOriginalRect?: boolean;
          size?: Size;
      }
      • OptionalpadColor?: number
      • OptionalreturnOriginalRect?: boolean
      • Optionalsize?: Size

    Returns OutputImageCrop

Accessors

padColor

  • get padColor(): number

  • When an image is aligned by type, its original size may be insufficient, and in this case it needs to be supplemented, "padded". padColor sets the value for the color that will be used for such a supplement.

    Returns number

returnOriginalRect

  • get returnOriginalRect(): boolean

  • If set, the coordinates of the rectangle with the face in the original image prepared for the face crop are returned in the DetectFaceResult.originalRect field. Default is false.

    Returns boolean

size

  • get size(): Size

  • The resize value to process. If the value doesn't match AspectRatio type proportion or minimum size, an adjustment is applied. Use OutputImageCropAspectRatio to check you size matches AspectRatio type proportions and minimum size.

    Returns Size

type

Settings

Member Visibility

On This Page

Constructors
Accessors