CaptureVisionRouter

The CaptureVisionRouter class is what a user uses to interact with image-processing and semantic-processing products in their applications. It accepts an image source and returns processing results which may contain Final results.

Definition

Namespace: com.dynamsoft.cvr

class CaptureVisionRouter

Constructor Methods

Method	Description
`CaptureVisionRouter`	Initializes a new instance of the `CaptureVisionRouter` class.

Single-File Processing Methods

Method	Description
`capture`	Processes an image or file to derive important information.
`captureMultiPages`	Processes an image or file containing multiple pages to derive important information.

Multiple-File Processing Methods

Method	Description
`setInput`	Sets an image source to provide images for consecutive process.
`getInput`	Gets the attached image source adapter object of the capture vision router.
`addCaptureStateListener`	Adds an object that listens to the state changes of the capture process.
`removeCaptureStateListener`	Removes an object which listens to the state changes of the capture process.
`addImageSourceStateListener`	Adds an object that listens to state changes of the image source.
`removeImageSourceStateListener`	Removes an object which listens to state changes of the image source.
`addResultReceiver`	Adds an object as the receiver of captured results.
`removeResultReceiver`	Removes an object which was added as a receiver of captured results.
`addResultFilter`	Adds an object as the filter of captured results.
`removeResultFilter`	Removes an object which was added as a filter of captured results.
`startCapturing`	Starts to process images consecutively.
`stopCapturing`	Stops the consecutive process.
`pauseCapturing`	Pauses the capture process. The current thread will be blocked until the capture process is resumed.
`resumeCapturing`	Resumes the capture process. The current thread will be unblocked after the capture process is resumed.

Setting Methods

Method	Description
`initSettings`	Loads and initializes a template from a string.
`initSettingsFromFile`	Loads and initializes a template from a file.
`outputSettings`	Exports a specific `CaptureVisionTemplate` to a string.
`outputSettingsToFile`	Exports a specific `CaptureVisionTemplate` to a file.
`getSimplifiedSettings`	Retrieves a `SimplifiedCaptureVisionSettings` object for a specific `CaptureVisionTemplate`.
`updateSettings`	Updates a `CaptureVisionTemplate` with `SimplifiedCaptureVisionSettings` object.
`resetSettings`	Resets all templates to factory settings.
`getParameterTemplateCount`	Retrieves the total number of available parameter templates.
`getParameterTemplateName`	Retrieves the name of a specific parameter template by its index.
`switchCapturingTemplate`	Switches the capturing template during the image processing workflow.

Buffered Items Methods

Method	Description
`getBufferedItemsManager`	Gets a `BufferedItemsManager` object.

Intermediate Result

The following method returns an IntermediateResultManager object which allows the application to tap into the algorithmic process.

API Name	Description
`getIntermediateResultManager`	Returns an `IntermediateResultManager` object.

Auxiliary Methods

Method	Description
`setGlobalIntraOpNumThreads`	Sets the global number of threads used internally for model execution.
`appendDLModelBuffer`	Appends a deep learning model to the memory buffer.
`clearDLModelBuffers`	Clears all deep learning models from buffer to free up memory.
`appendModelBuffer`	Deprecated. Will be removed in future versions. Use `appendDLModelBuffer` instead.