SimplifiedCaptureVisionSettings

The SimplifiedCaptureVisionSettings class contains settings for capturing and recognizing images with the CaptureVisionRouter class.

Definition

Namespace: com.dynamsoft.cvr

Assembly: DynamsoftCaptureVisionBundle.aar

class SimplifiedCaptureVisionSettings

Attributes & Methods

toJSON

Transform the current SimplifiedCaptureVisionSettings object to a JSON string.

String toJSON();

Return Value

The JSON string format of the current SimplifiedCaptureVisionSettings object.

fromJSON

Generate a SimplifiedCaptureVisionSettings object from a JSON string.

static SimplifiedCaptureVisionSettings fromJSON(String jsonString);

Return Value

The generated SimplifiedCaptureVisionSettings object.

toString

Generate the current SimplifiedCaptureVisionSettings object to a string.

@NonNull
@Override
public String toString();

Return Value

A string representation of the current SimplifiedCaptureVisionSettings object.

outputOriginalImage

Specifies whether to output the original image or not.

boolean outputOriginalImage;

Remarks

The property determines:

1. Whether the CapturedResult object contains the original image.
2. Whether you can receive the original image via onOriginalImageResultReceived.

roi

Specifies the region of interest (ROI) of the image or frame where the capture and recognition will take place.

Quadrilateral roi;

roiMeasuredInPercentage

Specifies whether the ROI is measured in pixels (false) or as a percentage of the image dimensions (true).

boolean roiMeasuredInPercentage;

maxParallelTasks

Specifies the maximum number of parallel tasks that can be used for image capture and recognition.

int maxParallelTasks;

minImageCaptureInterval

Set the minimum capture interval (in milliseconds) between consecutive frames when capturing via video. In other words, it is a measure of the frequency in which frames are fetched.

int minImageCaptureInterval;

Remarks

If you find that the battery consumption when using any of the Dynamsoft Capture Vision products, we recommend setting this parameter to a higher value. Please see this article for more info on how to reduce battery consumption.

timeout

Specifies the maximum time (in milliseconds) allowed for image capture and recognition.

int timeout;

barcodeSettings

Specifies the settings for the DynamsoftBarcodeReader task with a SimplifiedBarcodeReaderSettings object.

SimplifiedBarcodeReaderSettings barcodeSettings;

labelSettings

Specifies the settings for the DynamsoftLabelRecognizer task with a SimplifiedLabelRecognizerSettings object.

SimplifiedLabelRecognizerSettings labelSettings;

documentSettings

Specifies the settings for the DynamsoftDocumentNormalizer task with a SimplifiedDocumentNormalizerSettings object.

SimplifiedDocumentNormalizerSettings documentSettings;