Processing Multiple Images/Pages

setInput

Sets an image source that will provide images to be consecutively processed.

• Objective-C
• Swift

1. - (BOOL)setInput:(DSImageSourceAdapter *)adapter
          error:(NSError * _Nullable * _Nullable)error;
   

2. func setInput(_ adapter: DSImageSourceAdapter) throws -> BOOL
   

Parameters

adapter: An object of DSImageSourceAdapter. You can use an internally implemented ImageSourceAdapter such as CameraEnhancer, DirectoryFetcher or FileFetcher. error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

A BOOL value that indicates whether the input is set successfully.

getInput

Gets the attached image source adapter (DSImageSourceAdapter) object of the Capture Vision Router.

• Objective-C
• Swift

1. - (DSImageSourceAdapter *)getInput;
   

2. func getInput() -> DSImageSourceAdapter
   

Return Value

The attached DSImageSourceAdapter object of the capture vision router.

addImageSourceStateListener

Registers a DSImageSourceStateListener object to be used as a callback when the status of DSImageSourceAdapter is received.

• Objective-C
• Swift

1. - (BOOL)addImageSourceStateListener:(id<DSImageSourceStateListener>)listener;
   

2. func addImageSourceStateListener(_ listener:DSImageSourceStateListener) -> BOOL
   

Parameters

listener: An object of DSImageSourceStateListener.

Return Value

A BOOL value that indicates whether the DSImageSourceStateListener is added successfully.

removeImageSourceStateListener

Removes a DSImageSourceStateListener from the Capture Vision Router.

• Objective-C
• Swift

1. - (BOOL)removeImageSourceStateListener:(id<DSImageSourceStateListener>)listener;
   

2. func removeImageSourceStateListener(_ listener:DSImageSourceStateListener) -> BOOL
   

Parameters

listener: An object of DSImageSourceStateListener.

Return Value

A BOOL value that indicates whether the DSImageSourceStateListener is removed successfully.

addResultReceiver

Adds a CapturedResultReceiver object as the receiver of captured results.

• Objective-C
• Swift

1. - (BOOL)addResultReceiver:(id<DSCapturedResultReceiver>)receiver;
   

2. func addResultReceiver(_ listener:DSCapturedResultReceiver) -> BOOL
   

Parameters

listener: An object of DSCapturedResultReceiver.

Return Value

A BOOL value that indicates whether the result receiver is added successfully.

removeResultReceiver

emoves the specified CapturedResultReceiver object.

• Objective-C
• Swift

1. - (BOOL)removeResultReceiver:(id<DSCapturedResultReceiver>)receiver;
   

2. func removeResultReceiver(_ listener:DSCapturedResultReceiver) -> BOOL
   

Parameters

listener: An object of DSCapturedResultReceiver.

Return Value

A BOOL value that indicates whether the result receiver is removed successfully.

startCapturing

Initiates a capturing process based on a specified template. This process is repeated for each image fetched from the source.

• Objective-C
• Swift

1. - (void)startCapturing:(NSString*)templateName
    completionHandler:(nullable void(^)(BOOL isSuccess, NSError *_Nullable error))completionHandler;
   

2. func startCapturing(_ templateName:String) -> BOOL
   

Parameters

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

• One of the DSPresetTemplate 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.

completionHandler: A completion handler the system calls after it finishes the startCapturing.

• isSuccess: A BOOL value that indicates whether the startCapturing operation is successful.
• error: An error object if the request fails; otherwise, nil.

Error

Return Value

A BOOL value that indicates whether the capture starts successfully.

stopCapturing

Stops the capturing process.

• Objective-C
• Swift

1. - (void)stopCapturing;
   

2. func stopCapturing()
   

pauseCapturing

Pauses the capturing process.

• Objective-C
• Swift

1. - (void)pauseCapturing;
   

2. func pauseCapturing()
   

resumeCapturing

Resumes the capturing process.

• Objective-C
• Swift

1. - (void)resumeCapturing;
   

2. func resumeCapturing()
   

addCaptureStateListener

Registers a DSCaptureStateListener to be used as a callback when capture state changes.

• Objective-C
• Swift

1. - (BOOL)addCaptureStateListener:(nonnull id<DSCaptureStateListener>)listener;
   

2. func addCaptureStateListener(_ listener:DSCaptureStateListener) -> BOOL
   

Parameters

listener: A delegate object of DSCaptureStateListener to receive the capture state.

Return Value

A BOOL value that indicates whether the capture state listener is added successfully.

removeCaptureStateListener

Removes a DSCaptureStateListener that has been configured for the Capture Vision Router via the addCaptureStateListener method.

• Objective-C
• Swift

1. - (BOOL)removeCaptureStateListener:(nonnull id<DSCaptureStateListener>)listener;
   

2. func removeCaptureStateListener(_ listener:DSCaptureStateListener) -> BOOL
   

Parameters

listener: An object of DSCaptureStateListener.

Return Value

A BOOL value that indicates whether the capture state listener is removed successfully.

addResultFilter

Adds a DSCapturedResultFilter object to filter non-essential results. Currnetly, is must be a MultiFrameCrossFilter object.

• Objective-C
• Swift

1. - (BOOL)addResultFilter:(nonnull id<DSCapturedResultFilter>)filter;
   

2. func addResultFilter(_ filter:DSCapturedResultFilter) -> BOOL
   

Parameters

filter: An object of DSCapturedResultFilter.

Return Value

A BOOL value that indicates whether the result filter is added successfully.

removeResultFilter

Removes the specified DSCapturedResultFilter object.

• Objective-C
• Swift

1. - (BOOL)removeResultFilter:(nonnull id<DSCapturedResultFilter>)filter;
   

2. func removeResultFilter(_ filter:DSCapturedResultFilter) -> BOOL
   

Parameters

filter: An object of DSCapturedResultFilter.

Return Value

A BOOL value that indicates whether the result filter is removed successfully.