Multiple-File Processing Methods - CaptureVisionRouter Class

SetInput

Sets an image source to provide images for consecutive processing.

int SetInput(ImageSourceAdapter pAdaptor)

Parameters

[in] pAdaptor Specifies an object which has implemented the Image Source Adapter Interface.

Return Value

Returns an error code. Zero indicates success.

See Also

ImageSourceAdapter

DirectoryFetcher

FileFetcher

GetInput

Gets the attached image source adapter object of the capture vision router.

ImageSourceAdapter GetInput()

Return Value

Returns the attached image source adapter object of the capture vision router.

See Also

ImageSourceAdapter

DirectoryFetcher

FileFetcher

AddCaptureStateListener

Adds an object that listens to the state changes of the capture process.

int AddCaptureStateListener(ICaptureStateListener listener)

Parameters

[in] listener Specifies a listening object of the type ICaptureStateListener to be added.

Return Value

Returns an error code. Zero indicates success.

See Also

ICaptureStateListener

RemoveCaptureStateListener

Removes an object which listens to the state changes of the capture process.

int RemoveCaptureStateListener(ICaptureStateListener listener)

Parameters

[in] listener Specifies a listening object of the type ICaptureStateListener to be removed.

Return Value

Returns an error code. Zero indicates success.

See Also

ICaptureStateListener

AddImageSourceStateListener

Adds an object that listens to state changes of the image source.

int AddImageSourceStateListener(IImageSourceStateListener listener)

Parameters

[in] listener Specifies a listening object of the type IImageSourceStateListener to be added.

Return Value

Returns an error code. Zero indicates success.

See Also

IImageSourceStateListener

RemoveImageSourceStateListener

Removes an object which listens to state changes of the image source.

int RemoveImageSourceStateListener(IImageSourceStateListener listener)

Parameters

[in] listener Specifies a listening object of the type IImageSourceStateListener to be removed.

Return Value

Returns an error code. Zero indicates success.

See Also

IImageSourceStateListener

AddResultReceiver

Adds an object as the receiver of captured results.

int AddResultReceiver(CapturedResultReceiver receiver)

Parameters

[in] receiver Specifies a receiver object of the type CapturedResultReceiver to be added.

Return Value

Returns an error code. Zero indicates success.

See Also

CapturedResultReceiver

RemoveResultReceiver

Removes an object which was added as a receiver of captured results.

int RemoveResultReceiver(CapturedResultReceiver receiver)

Parameters

[in] receiver Specifies a receiver object of the type CapturedResultReceiver to be removed.

Return Value

Returns an error code. Zero indicates success.

See Also

CapturedResultReceiver

AddResultFilter

Adds an object as the filter of captured results.

int AddResultFilter(CapturedResultFilter filter)

Parameters

[in] filter Specifies a filter object of the type CapturedResultFilter to be added.

Return Value

Returns an error code. Zero indicates success.

See Also

CapturedResultFilter

RemoveResultFilter

Removes an object which was added as a filter of captured results.

int RemoveResultFilter(CapturedResultFilter filter)

Parameters

[in] filter Specifies a filter object of the type CapturedResultFilter to be removed.

Return Value

Returns an error code. Zero indicates success.

See Also

CapturedResultFilter

StartCapturing

Starts to process images consecutively.

int StartCapturing(string templateName, bool waitForThreadExit, out string errorMsgBuffer)

Parameters

[in] templateName Specifies a CaptureVisionTemplate to use for capturing.

[in] waitForThreadExit Indicates whether to wait for the capture process to complete before returning.

[out] errorMsgBuffer Stores any error messages generated during the capturing process.

Remarks

• There are two types of CaptureVisionTemplate: the preset ones which come with the SDK and the custom ones that get initialized when the user calls InitSettings / InitSettingsFromFile.
• When using a custom template, the parameter templateName should be the name of the CaptureVisionTemplate object in the JSON template file.
• Please be aware that the preset CaptureVisionTemplates will be overwritten should the user call InitSettings / InitSettingsFromFile and pass his own settings.
• If parameter templateName is not specified, the preset one named ‘Default’ will be used. However, if the preset ones have been overwritten as described above, the first CaptureVisionTemplate from the user’s own settings will be used instead.

Return Value

The function returns an integer value representing the success or failure of the capturing process. A value of 0 indicates success, while a non-zero value indicates failure. Any error messages generated during the capturing process will be returned in errorMsgBuffer.

StopCapturing

Stops the multiple-file processing.

void StopCapturing(bool waitForRemainingTasks = true, bool waitForThreadExit = false)

Parameters

[in] waitForRemainingTasks Indicates whether to wait for the remaining tasks to complete before returning. The default value is true.
[in] waitForThreadExit Indicates whether to wait for the capture process to complete before returning. The default value is false.

PauseCapturing

Pauses the capture process. The current thread will be blocked until the capture process is resumed.

void PauseCapturing()

ResumeCapturing

Resumes the capture process. The current thread will be unblocked after the capture process is resumed.

void ResumeCapturing()