CaptureVisionRouter Class

The CaptureVisionRouter class defines how a user interacts with image-processing and semantic-processing Dynamsoft products in their applications.

A CaptureVisionRouter instance accepts and processes images from an image source and returns processing results which may contain final results or intermediate results. The instance can also process video frames coming from a camera or a different image source as well, therefore providing the ability to capture results via an interactive video scenario or from static images.

Definition

Assembly: dynamsoft_capture_vision_flutter

class CaptureVisionRouter

Static Properties

Returns the singleton instance of CaptureVisionRouter.

static CaptureVisionRouter get instance;

Methods

Capture from an Image

Process Multiple Images

Settings

Intermediate Results

capture

Processes an image using the specified template.

Future<CapturedResult> capture(ImageData imageData, String templateName) async

Parameters

[in] imageData: A ImageData object that contains image info.

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

captureFile

Processes an image from a file (specified by a file path) using the specified template.

Future<CapturedResult> captureFile(String filePath, String templateName) async

Parameters

[in] filePath: The file path and name that you want to capture data from. You have to specify the file name with extension name in the filePath. Supported file type includes “.bmp”, “.jpg”, “.png”, “.gif” or one-page “.tiff”.

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

captureFileBytes

Processes an image from a byte array using the specified template.

Future<CapturedResult> captureFileBytes(Uint8List bytes, String templateName) async

Parameters

[in] bytes: A byte array that points to a file in memory.

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

addResultFilter

Adds a result filter to process the captured results. This filter is of type MultiFrameResultCrossFilter. Supported filters:

• Cross-Verification: Improve the accuracy by cross-verifying the results.
• De-duplication: Removes the duplicated results.
• Overlapping: Improve the read-rate of multiple barcode scanning by overlaping the results.

Future<void> addResultFilter(MultiFrameResultCrossFilter filter)

addResultReceiver

Adds a CapturedResultReceiver object as the receiver of captured results.

Future<void> addResultReceiver(CapturedResultReceiver receiver)

removeAllResultFilters

Removes all the result filters from the Capture Vision Router instance.

Future<void> removeAllResultFilters()

removeAllResultReceivers

Removes all result receivers from the Capture Vision Router instance.

Future<void> removeAllResultReceivers()

removeResultFilter

Removes a previously added result filter.

Future<void> removeResultFilter(MultiFrameResultCrossFilter filter)

removeResultReceiver

Removes a previously added result receiver.

Future<void> removeResultReceiver(CapturedResultReceiver receiver)

setInput

Sets up an image source to provide images for continuous processing. This method is mainly used when configuring a camera (via the CameraEnhancer) as an input source.

Future<void> setInput(ImageSourceAdapter input) async

Parameters

[in] imageSourceAdapter: An object of ImageSourceAdapter.

You can use the following officially implemented ImageSourceAdapter classes:

• CameraEnhancer: A camera class that can capture video frames continuously.

Exception

startCapturing

Starts the capturing process using the specified template. Any result(s) that are received while the capture process is underway will be relayed by a result receiver, which is a callback function that is triggered once a captured result is found.

Future<void> startCapturing(String templateName)

Parameters

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

stopCapturing

Stops the capturing process.

Future<void> stopCapturing()

switchCapturingTemplate

Switch the image processing settings with the CaptureVisionTemplate name during the image processing workflow.

Future<void> switchCapturingTemplate(String templateName) async

Parameters

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

Exception

getSimplifiedSettings

Returns a subset of the full applied settings as a SimplifiedCaptureVisionSettings object. This object contains the simplified settings of the Capture Vision Router instance, which in turn contains the simplified settings of the functional product used.

Future<SimplifiedCaptureVisionSettings?> getSimplifiedSettings(String templateName) async

Parameters

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

Exception

getTemplateNames

Returns all the currently available Capture Vision template names.

Future<List<String>> getTemplateNames() async

initSettings

Initializes the settings of the CaptureVisionRouter instance using a JSON template (as a JSON string). To learn how to use a customized JSON template, please refer to this section of the Foundational User Guide.

Future<void> initSettings(String content)

Parameters

[in] content: A JSON string that contains Capture Vision settings.

Exception

initSettingsFromFile

Initializes the settings of the CaptureVisionRouter instance using a JSON template (as a JSON file). To learn how to use a customized JSON template, please refer to this section of the Foundational User Guide.

Future<void> initSettingsFromFile(String filePath) async

Parameters

[in] filePath: A JSON file that contains Capture Vision settings.

Exception

outputSettings

Outputs the specified Capture Vision template’s settings as a JSON string. If includeDefaultValues is set to true, the output will include the default settings values.

Future<String?> outputSettings(String templateName, bool includeDefaultValues) async

Parameters

[in] templateName: The name of the template that you want to output.

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

[in] includeDefaultValues: A boolean value that indicates whether to include default values in the output.

Exception

outputSettingsToFile

Outputs the specified Capture Vision template’s settings to a JSON file. If includeDefaultValues is set to true, the output will include the default settings values.

Future<void> outputSettingsToFile(String templateName, String filePath, bool includeDefaultValues) async

Parameters

[in] templateName: The name of the template that you want to output.

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

[in] file: The file path and name that you want to save the template.

[in] includeDefaultValues: A boolean value that indicates whether to include default values in the output.

Exception

resetSettings

Resets all of the settings to their default values.

Future<void> resetSettings() async

Exception

updateSettings

Updates the specified template settings of the CaptureVisionRouter instance using a SimplifiedCaptureVisionSettings object. To learn how to update the settings using the SimplifiedCaptureVisionSettings class - please refer to this section of the Foundational User Guide.

Future<void> updateSettings(String templateName, SimplifiedCaptureVisionSettings settings)

Parameters

[in] templateName: Specify the name of the template that you want to update.

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

[in] settings: An object of SimplifiedCaptureVisionSettings.

Exception

setGlobalIntraOpNumThreads

Sets the global number of threads used internally by the library for model execution. This parameter could help regulate the resources needed to operate the Capture Vision Router instance.

static Future<void> setGlobalIntraOpNumThreads(int intraOpNumThreads)

Parameters

intraOpNumThreads: Number of threads used internally for model execution. Valid range: [0, 256]. Default: 2.

clearDLModelBuffers

Clears the buffer used by deep learning models to free up memory and resources used by the Capture Vision Router instance for its operation.

static Future<void> clearDLModelBuffers()

getIntermediateResultManager

Retrieves the IntermediateResultManager instance.

IntermediateResultManager getIntermediateResultManager();