Package io.scanbot.sdk.image

Class BasicImageLoadOptions

java.lang.Object

io.scanbot.sdk.image.BasicImageLoadOptions

public class BasicImageLoadOptions
extends Object

Basic options for loading image.

Constructor Summary

Constructors

Constructor	Description
BasicImageLoadOptions(boolean liveSource)	Constructs BasicImageLoadOptions with default parameters.
BasicImageLoadOptions(Rectangle cropRect, boolean liveSource, CanvasColor canvasColor)	Constructs BasicImageLoadOptions with the given params.

Method Summary

Modifier and Type	Method	Description
CanvasColor	getCanvasColor()	Getter for canvasColor field.
Rectangle	getCropRect()	Getter for cropRect field.
boolean	getLiveSource()	Getter for liveSource field.
void	setCanvasColor(CanvasColor canvasColor)	Setter for canvasColor field.
void	setCropRect(Rectangle cropRect)	Setter for cropRect field.
void	setLiveSource(boolean liveSource)	Setter for liveSource field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicImageLoadOptions

public BasicImageLoadOptions(Rectangle cropRect,
 boolean liveSource,
 CanvasColor canvasColor)

Constructs BasicImageLoadOptions with the given params.

Parameters:

cropRect - If the rect is not empty, the image will be cropped to this rect before processing.

liveSource - True if the image should be processed in live mode by scanners configured with ProcessingMode.AUTO. Should be set to true for images that come from some video stream, e.g. from the camera or a video file.

canvasColor - CanvasColor color to use when converting images with alpha channel to images without alpha channel. Default is `WHITE`.

BasicImageLoadOptions

public BasicImageLoadOptions(boolean liveSource)

Constructs BasicImageLoadOptions with default parameters.

Parameters:

liveSource - True if the image should be processed in live mode by scanners configured with ProcessingMode.AUTO. Should be set to true for images that come from some video stream, e.g. from the camera or a video file.

Method Details

getCropRect

public Rectangle getCropRect()

Getter for cropRect field. See constructor documentation for more information about the field.

Returns:

cropRect

setCropRect

public void setCropRect(Rectangle cropRect)

Setter for cropRect field. See constructor documentation for more information about the field.

Parameters:

cropRect - Value to set.

getLiveSource

public boolean getLiveSource()

Getter for liveSource field. See constructor documentation for more information about the field.

Returns:

liveSource

setLiveSource

public void setLiveSource(boolean liveSource)

Setter for liveSource field. See constructor documentation for more information about the field.

Parameters:

liveSource - Value to set.

getCanvasColor

public CanvasColor getCanvasColor()

Getter for canvasColor field. See constructor documentation for more information about the field.

Returns:

canvasColor

setCanvasColor

public void setCanvasColor(CanvasColor canvasColor)

Setter for canvasColor field. See constructor documentation for more information about the field.

Parameters:

canvasColor - Value to set.