Class ImageManipulator

API for image processing. If applicable on the platform, all the methods return images with the same liveness flag as the input image.

Index

Methods

cropRect destroy flip resize rotate create

Methods

cropRect

cropRect(image, rect, consumeImage?): Promise<ImageManipulatorCroprectResponse>
Crops out the given rectangle from the image.
Parameters
- image: Image
  The image to crop.
- rect: Rectangle
  The rectangle in normalized coordinates to crop.
- Optional consumeImage: Config.ConsumeType
  Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.
Returns Promise<ImageManipulatorCroprectResponse>
Cropped image.

destroy

destroy(): Promise<void>
Frees up any resources associated with this object. No other methods may be called on this object after destroy has been called.

Returns Promise<void>

flip

flip(image, origin, consumeImage?): Promise<ImageManipulatorFlipResponse>
Flips the given image horizontally or vertically.
Parameters
- image: Image
  The image to flip
- origin: ImageOrigin
  Location of the image origin in the image coordinate system.
- Optional consumeImage: Config.ConsumeType
  Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.
Returns Promise<ImageManipulatorFlipResponse>
The result of the filter application.

resize

resize(image, size, consumeImage?): Promise<ImageManipulatorResizeResponse>
Resizes the given image to the given size.
Parameters
- image: Image
  The image to resize
- size: number
  Size of the longer side of the image.
- Optional consumeImage: Config.ConsumeType
  Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.
Returns Promise<ImageManipulatorResizeResponse>
Resized image.

rotate

rotate(image, rotation, consumeImage?): Promise<ImageManipulatorRotateResponse>
Rotates the given image by the given angle.
Parameters
- image: Image
  The image to rotate
- rotation: ImageRotation
  Rotation to be applied
- Optional consumeImage: Config.ConsumeType
  Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.
Returns Promise<ImageManipulatorRotateResponse>
Rotated image.

`Static` create

create(workerBridge): Promise<ImageManipulator>
Parameters
- workerBridge: WorkerBridge
Returns Promise<ImageManipulator>

Generated using TypeDoc