Page

class Page

Represents a page of a document.

Properties

Link copied to clipboard

The detection status of the page.

Link copied to clipboard

The URI of the document file.

Link copied to clipboard

The Bitmap of the document image. Calling this getter is an IO operation and is not recommended to execute in the UI thread. The getter will return null if the image does not exist or is corrupted.

Link copied to clipboard

The URI of the document preview file.

Link copied to clipboard

The Bitmap of the document preview image. Calling this getter is an IO operation and is not recommended to execute in the UI thread. The getter will return null if the image does not exist or is corrupted.

Link copied to clipboard

The document quality of the page.

Link copied to clipboard

The list of filters applied to the page.

Link copied to clipboard
val filtersFlow: <Error class: unknown class><List<ParametricFilter>?>
Link copied to clipboard

The URI of the original file.

Link copied to clipboard

The Bitmap of the original image. Calling this getter is an IO operation and is not recommended to execute in the UI thread. The getter will return null if the image does not exist or is corrupted.

Link copied to clipboard

The polygon of the page.

Link copied to clipboard
val polygonFlow: <Error class: unknown class><List<PointF>?>
Link copied to clipboard

The rotation of all images (including previews) of the page. The direction of rotation is represented by ImageRotation enum.

Link copied to clipboard
val rotationFlow: <Error class: unknown class><ImageRotation>
Link copied to clipboard

The source of the page image.

Link copied to clipboard

The URI of the unfiltered document file.

Link copied to clipboard

The Bitmap of the unfiltered document image. Calling this getter is an IO operation and is not recommended to execute in the UI thread. The getter will return null if the image does not exist or is corrupted.

Link copied to clipboard

The unique identifier of the page.

Functions

Link copied to clipboard
fun apply(newImageRotation: ImageRotation = ImageRotation.NONE, newPolygon: List<PointF>? = null, newFilters: List<ParametricFilter>? = null)

Processes all submitted operations on the page and saves the result images in the file system. This is an IO operation and is not recommended to execute in the UI thread.

Link copied to clipboard
fun toJson(): <Error class: unknown class>

Returns the JSON representation of the page.