Skip to main content

Image Export

In addition to exporting scanned documents as PDF, you can also retrieve the pages of the currently scanned document as image files (JPG).

Initialization​

Export scanned pages as image files​

Write images to local files​

In order to write the currently scanned pages to local JPG files, you can use the Document.writeImage method. Pass the page you want to export as JPG and the target path where to save it:

import DocutainSDK from '@docutain/react-native-docutain-sdk';

//...
//scan a document
//...

const pageCount = await DocutainSDK.pageCount();
for(let i = 1; i <= pageCount; i++){
    const filePath = RNFS.DocumentDirectoryPath + `/image${i}.jpg`;
    const rc = await DocutainSDK.writeImage(i, filePath);
}

Get images as Base64 encoded string​

You also have the possibility to get the images as Base64 encoded string:

import DocutainSDK from '@docutain/react-native-docutain-sdk';

//...
//scan a document
//...

const pageCount = await DocutainSDK.pageCount();
for(let i = 1; i <= pageCount; i++){
    const rc = await DocutainSDK.getImageBytes(i, PageSourceType.CUT_FILTER);
}

PageSourceType​

When getting the images as Base64 encoded string, you can define a PageSourceType.

You have the following options:

ValueDescription
CUT_FILTERThe cut and filtered image, which is the one the user sees when finishing the scan process. This is the default value.
CUT_ONLYThe cut but unfiltered image. If you for example use the image for further processing in your own OCR pipeline which uses custom filter operations, this option might improve your OCR results as opposed to CUT_FILTER. But this is no general rule and highly depends on your pipeline.
ORIGINALThe uncut, unfiltered image as it was provided by the camera.