Package io.scanbot.sdk.process

Interface PdfGenerator

  • All Implemented Interfaces:
    
public interface PdfGenerator

    Provides methods for PDF generation.

    • Constructor Detail

    • Method Detail

      • generateFromUris

         abstract File generateFromUris(Array<Uri> imageFileUris, Boolean sourceFilesEncrypted, PdfConfiguration pdfConfig)

        Generate PDF from given images uris

        Parameters:
        imageFileUris - array of source images uris
        sourceFilesEncrypted - should be true if source files are encrypted with Scanbot SDK encryption mechanism, otherwise - false
        pdfConfig - extra PDF configuration

      • generateFromUris

         abstract Boolean generateFromUris(Array<Uri> imageFileUris, File outputFile, Boolean sourceFilesEncrypted, PdfConfiguration pdfConfig)

        Generate PDF from given images uris

        Parameters:
        imageFileUris - array of source images uris
        outputFile - target PDF file
        sourceFilesEncrypted - should be true if source files are encrypted with Scanbot SDK encryption mechanism, otherwise - false
        pdfConfig - extra PDF configuration

      • generateWithOcrFromUris

         abstract File generateWithOcrFromUris(List<Uri> imageFileUris, Boolean sourceFilesEncrypted, PdfConfiguration pdfConfig, OcrEngine.OcrConfig ocrConfig)

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

        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
        ocrConfig - the OCR configuration

      • generateWithOcrFromUris

         abstract File generateWithOcrFromUris(List<Uri> imageFileUris, File outputFile, Boolean sourceFilesEncrypted, PdfConfiguration pdfConfig, OcrEngine.OcrConfig ocrConfig)

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

        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
        ocrConfig - the OCR configuration

      • generateWithOcrFromPages

        @Deprecated(message = "Use generateWithOcrFromDocument() instead") abstract File generateWithOcrFromPages(List<Page> pages, PdfConfiguration pdfConfig, OcrEngine.OcrConfig ocrConfig)

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

        Parameters:
        pages - list of Page objects.
        pdfConfig - the PDF configuration
        ocrConfig - the OCR configuration

      • generateWithOcrFromPages

        @Deprecated(message = "Use generateWithOcrFromDocument() instead") abstract Boolean generateWithOcrFromPages(List<Page> pages, File outputFile, PdfConfiguration pdfConfig, OcrEngine.OcrConfig ocrConfig)

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

        Parameters:
        pages - list of Page objects.
        outputFile - the output PDF file
        pdfConfig - the PDF configuration
        ocrConfig - the OCR configuration