Android Scanbot SDK/io.scanbot.sdk.ocr.pdf/OcrPdfGenerator/generate

generate

abstract fun generate(imageFileUris: List<Uri>, sourceFilesEncrypted: Boolean = false, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Result<File>

Creates sandwiched OCR PDF file from given image file URIs and provided source list of Page OCR data.

Return

Result.Success with generated PDF File if PDF was generated successfully, Result.*Error otherwise.

Parameters

imageFileUris

list of image file URIs

sourceFilesEncrypted

if true, the image files are encrypted and will be decrypted before OCR

pdfConfig

the PDF configuration

sourceOcrPages

the source list of Page OCR data.

abstract fun generate(imageFileUris: List<Uri>, outputFile: File, sourceFilesEncrypted: Boolean = false, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Result<Unit>

Creates sandwiched OCR PDF file from given image file URIs and provided source list of Page OCR data.

Return

Result.Success if PDF was generated successfully, Result.*Error otherwise

Parameters

imageFileUris

list of image file URIs

outputFile

the output PDF file

sourceFilesEncrypted

if true, the image files are encrypted and will be decrypted before OCR

pdfConfig

the PDF configuration

sourceOcrPages

the source list of Page OCR data

abstract fun generate(document: Document, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Result<Unit>

Creates sandwiched OCR PDF file from given Document and provided source list of Page OCR data with provided languages. Uses the document image from a io.scanbot.sdk.docprocessing.Page.

Return

Result.Success if PDF was generated successfully, Result.*Error otherwise.

Parameters

document

the document to perform OCR on and create a PDF from.

pdfConfig

the PDF configuration.

sourceOcrPages

the source list of Page OCR data.

abstract fun generate(document: Document, outputFile: File, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Result<Unit>

Creates sandwiched OCR PDF file from given Document and provided source list of Page OCR data with provided languages.. Uses the document image from a io.scanbot.sdk.docprocessing.Page.

Return

Result.Success if PDF was generated successfully, Result.*Error otherwise.

Parameters

document

the document to perform OCR on and create a PDF from.

outputFile

the output PDF file

pdfConfig

the PDF configuration.

sourceOcrPages

the source list of Page OCR data.

abstract fun generate(pages: List<Page>, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Result<File>

Deprecated

Use generateWithOcrPagesFromDocument() instead

Creates sandwiched OCR PDF file from given Page objects and provided source list of Page OCR data with provided languages. Uses the document image from a Page.

Return

Result.Success with generated PDF File if PDF was generated successfully, Result.*Error otherwise.

Parameters

pages

list of Page objects.

pdfConfig

the PDF configuration.

sourceOcrPages

the source list of Page OCR data.

abstract fun generate(pages: List<Page>, outputFile: File, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Result<Unit>

Deprecated

Use generateWithOcrPagesFromDocument() instead

Creates sandwiched OCR PDF file from given Page objects and provided source list of Page OCR data with provided languages. Uses the document image from a Page.

Return

Result.Success if PDF was generated successfully, Result.*Error otherwise

Parameters

pages

list of Page objects.

outputFile

the output PDF file

pdfConfig

the PDF configuration

sourceOcrPages

the source list of Page OCR data.