ScanbotSDKMultiPageImageExtractor.h File Reference

Go to the source code of this file.

Typedefs
typedef struct scanbotsdk_multi_page_image_extractor_t	scanbotsdk_multi_page_image_extractor_t
	scanbotsdk_multi_page_image_extractor_t class

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_multi_page_image_extractor_create (scanbotsdk_multi_page_image_extractor_t **result)
	Creates a new instance of scanbotsdk_multi_page_image_extractor with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_multi_page_image_extractor_free (scanbotsdk_multi_page_image_extractor_t *self)
	Frees the memory allocated for the instance of scanbotsdk_multi_page_image_extractor_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_multi_page_image_extractor_run (scanbotsdk_multi_page_image_extractor_t *self, scanbotsdk_random_access_source_t *source, scanbotsdk_page_extraction_result_t **result)
	Extracts images from the given source. If possible, images that are originally stored in a compressed way, are not decompressed automatically but are initialized in a lazy way. This means that the image data is only decompressed when it is accessed for the first time. That's why when the images are used after extraction, it is recommended to close (dispose) (if platform uses Garbage Collector) images as soon as they are not needed anymore to prevent storing a lot of images in decompressed state in memory. After the method is executed, the source doesn't have to exist anymore.