Processing a Single Image

captureFromFile

Capture data from the file specified by the file path. To learn more about what the captured data can be, please see the Return Value section below.

• Objective-C
• Swift

1. - (DSCapturedResult *)captureFromFile:(NSString *)file
                        templateName:(NSString*)templateName;
   

2. func captureFromFile(_ file:String, templateName:String) -> CaptureResult
   

Parameters

file: The file path and name that you want to capture data from.

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.

Return Value

A DSCapturedResult object.

If an error occurs when processing the image, the DSCapturedResult object will include error code and error message that describes the reason of the error.

Possible errors:

captureFromFileBytes

Capture data from a given file in memory. To learn more about what the captured data can be, please see the Return Value section below.

• Objective-C
• Swift

1. - (DSCapturedResult *)captureFromFileBytes:(NSData *)fileBytes
                             templateName:(NSString*)templateName;
   

2. func captureFromFileBytes(_ fileBytes:Data, templateName:String) -> CaptureResult
   

Parameters

fileBytes: A NSData object that points to a file in memory.

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.

Return Value

A DSCapturedResult object.

If an error occurs when processing the image, the DSCapturedResult object will include error code and error message that describes the reason of the error.

Possible errors:

captureFromBuffer

Capture data from the memory buffer via a DSImageData object. To learn more about what the captured data can be, please see the Return Value section below.

• Objective-C
• Swift

1. - (DSCapturedResult *)captureFromBuffer:(DSImageData *)buffer
                          templateName:(NSString*)templateName;
   

2. func captureFromBuffer(_ buffer:DSImageData, templateName:String) -> CaptureResult
   

Parameters

buffer: A DSImageData object that contains image info.

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.

Return Value

A DSCapturedResult object.

If an error occurs when processing the image, the DSCapturedResult object will include error code and error message that describes the reason of the error.

Possible errors:

captureFromImage

Capture data from the given image. To learn more about what the captured data can be, please see the Return Value section below.

• Objective-C
• Swift

1. - (DSCapturedResult *)captureFromImage:(UIImage *)image
                         templateName:(NSString*)templateName;
   

2. func captureFromImage(_ image:UIImage, templateName:String) -> CaptureResult
   

Parameters

image: A UIImage object.

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.

Return Value

A DSCapturedResult object.

If an error occurs when processing the image, the DSCapturedResult object will include error code and error message that describes the reason of the error.

Possible errors:

captureMultiPagesFromFile

Capture data from a multi-page file specified by the file path.

• Objective-C
• Swift

1. - (NSArray<DSCapturedResult *> *)captureMultiPagesFromFile:(NSString *)file
                                             templateName:(NSString *)templateName;
   

2. func captureMultiPagesFromFile(_ file: String, templateName: String) -> [CapturedResult]
   

Parameters

file: The file path and name that you want to capture data from.

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.

Return Value

An array of DSCapturedResult objects.

captureMultiPagesFromFileBytes

Capture data from a multi-page file in memory.

• Objective-C
• Swift

1. - (NSArray<DSCapturedResult *> *)captureMultiPagesFromFileBytes:(NSData *)fileBytes
                                                  templateName:(NSString *)templateName;
   

2. func captureMultiPagesFromFileBytes(_ fileBytes: Data, templateName: String) -> [CapturedResult]
   

Parameters

fileBytes: A NSData object that points to a file in memory.

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.

Return Value

An array of DSCapturedResult objects.

captureMultiPagesFromFileFetcher

Capture data from a multi-page file via a DSFileFetcher.

• Objective-C
• Swift

1. - (NSArray<DSCapturedResult *> *)captureMultiPagesFromFileFetcher:(DSFileFetcher *)fetcher
                                                    templateName:(NSString *)templateName;
   

2. func captureMultiPagesFromFileFetcher(_ fetcher: FileFetcher, templateName: String) -> [CapturedResult]
   

Parameters

fetcher: A DSFileFetcher object.

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.

Return Value

An array of DSCapturedResult objects.