Android Scanbot SDK API reference/io.scanbot.sdk.process/PdfGenerator

PdfGenerator

interface PdfGenerator

Provides methods for PDF generation.

Inheritors

Functions

Link copied to clipboard
abstract fun generateFromDocument(document: Document, pdfConfig: PdfConfiguration = PdfConfiguration.default()): Boolean
abstract fun generateFromDocument(document: Document, outputFile: File, pdfConfig: PdfConfiguration = PdfConfiguration.default()): Boolean

Generate PDF from given Document

Link copied to clipboard
abstract fun generateFromPages(pages: Array<Page>, pdfConfig: PdfConfiguration = PdfConfiguration.default()): File?
abstract fun generateFromPages(pages: Array<Page>, outputFile: File, pdfConfig: PdfConfiguration = PdfConfiguration.default()): Boolean

Generate PDF from given array of Page objects

Link copied to clipboard
abstract fun generateFromUris(imageFileUris: Array<Uri>, sourceFilesEncrypted: Boolean = false, pdfConfig: PdfConfiguration = PdfConfiguration.default()): File?
abstract fun generateFromUris(imageFileUris: Array<Uri>, outputFile: File, sourceFilesEncrypted: Boolean = false, pdfConfig: PdfConfiguration = PdfConfiguration.default()): Boolean

Generate PDF from given images uris

Link copied to clipboard
abstract fun generateWithOcrFromDocument(document: Document, pdfConfig: PdfConfiguration = PdfConfiguration.default(), ocrConfig: OcrEngine.OcrConfig = OcrEngine.OcrConfig()): Boolean
abstract fun generateWithOcrFromDocument(document: Document, outputFile: File, pdfConfig: PdfConfiguration = PdfConfiguration.default(), ocrConfig: OcrEngine.OcrConfig = OcrEngine.OcrConfig()): Boolean

Performs OCR and creates sandwiched OCR PDF file (from given Document. Use the document image from a io.scanbot.sdk.docprocessing.Page.) with provided languages.

Link copied to clipboard
abstract fun generateWithOcrFromPages(pages: List<Page>, pdfConfig: PdfConfiguration = PdfConfiguration.default(), ocrConfig: OcrEngine.OcrConfig = OcrEngine.OcrConfig()): File?
abstract fun generateWithOcrFromPages(pages: List<Page>, outputFile: File, pdfConfig: PdfConfiguration = PdfConfiguration.default(), ocrConfig: OcrEngine.OcrConfig = OcrEngine.OcrConfig()): Boolean

Performs OCR and creates sandwiched OCR PDF file (from given Page objects. Use the document image from a Page.) with provided languages.

Link copied to clipboard
abstract fun generateWithOcrFromUris(imageFileUris: List<Uri>, sourceFilesEncrypted: Boolean = false, pdfConfig: PdfConfiguration = PdfConfiguration.default(), ocrConfig: OcrEngine.OcrConfig = OcrEngine.OcrConfig()): File?
abstract fun generateWithOcrFromUris(imageFileUris: List<Uri>, outputFile: File, sourceFilesEncrypted: Boolean = false, pdfConfig: PdfConfiguration = PdfConfiguration.default(), ocrConfig: OcrEngine.OcrConfig = OcrEngine.OcrConfig()): File?

Performs OCR and creates sandwiched OCR PDF file (from given image file URIs) with provided languages.

Link copied to clipboard
abstract fun generateWithOcrPagesFromDocument(document: Document, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Boolean
abstract fun generateWithOcrPagesFromDocument(document: Document, outputFile: File, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Boolean

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

Link copied to clipboard
abstract fun generateWithOcrPagesFromPages(pages: List<Page>, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): File?
abstract fun generateWithOcrPagesFromPages(pages: List<Page>, outputFile: File, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): Boolean

Creates sandwiched OCR PDF file from given Page objects and provided source list of io.scanbot.sdk.ocr.model.Page OCR data. Use the document image from a Page. with provided languages.

Link copied to clipboard
abstract fun generateWithOcrPagesFromUris(imageFileUris: List<Uri>, sourceFilesEncrypted: Boolean = false, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): File?
abstract fun generateWithOcrPagesFromUris(imageFileUris: List<Uri>, outputFile: File, sourceFilesEncrypted: Boolean = false, pdfConfig: PdfConfiguration = PdfConfiguration.default(), sourceOcrPages: List<Page> = emptyList()): File?

Creates sandwiched OCR PDF file from given image file URIs and provided source list of io.scanbot.sdk.ocr.model.Page OCR data.