capture-vision-router.md

layout	default-layout
title	CaptureVisionRouter Class- Dynamsoft Capture Vision Router Module .NET Edition API Reference
description	API reference for the CaptureVisionRouter class in Dynamsoft Capture Vision .NET Edition, the central class for managing image capture and recognition workflows.
keywords	capture vision router, router, .NET, api reference
needAutoGenerateSidebar	true
needGenerateH3Content	true

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 or Intermediate Results.

Definition

Namespace: Dynamsoft.CVR

public class CaptureVisionRouter : IDisposable

Thread Safety

Instances of CaptureVisionRouter are not thread-safe.
Do not access the same CaptureVisionRouter instance from multiple threads concurrently.
Create a separate instance for each thread if concurrent processing is required.

Constructor and Destructor Methods

Method	Description
CaptureVisionRouter	Default constructor of CaptureVisionRouter object.
~CaptureVisionRouter	Destructor of CaptureVisionRouter object.
Dispose	Releases all resources used by current object.

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.
SwitchCapturingTemplate	Switches the capturing template during the image processing workflow.

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.

Auxiliary Methods

Method	Description
GetBufferedItemsManager	Gets the manager instance of buffered items.
GetIntermediateResultManager	Returns an IntermediateResultManager object.
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.