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

• generateFromPages

  @Deprecated(message = "Use generateFromDocument() instead") abstract File generateFromPages(Array<Page> pages, PdfConfiguration pdfConfig)

  Generate PDF from given array of Page objects

  Parameters:

  pages - array of source pages

  pdfConfig - extra PDF configuration

• generateFromPages

  @Deprecated(message = "Use generateFromDocument() instead") abstract Boolean generateFromPages(Array<Page> pages, File outputFile, PdfConfiguration pdfConfig)

  Generate PDF from given array of Page objects

  Parameters:

  pages - array of source pages

  outputFile - target PDF file

  pdfConfig - extra PDF configuration

• generateFromDocument

   abstract Boolean generateFromDocument(Document document, PdfConfiguration pdfConfig)

  Generate PDF from given Document

  Parameters:

  document - source document

  pdfConfig - extra PDF configuration

• generateFromDocument

   abstract Boolean generateFromDocument(Document document, File outputFile, PdfConfiguration pdfConfig)

  Generate PDF from given Document

  Parameters:

  document - source document

  outputFile - target PDF file

  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

• generateWithOcrFromDocument

   abstract Boolean generateWithOcrFromDocument(Document document, PdfConfiguration pdfConfig, OcrEngine.OcrConfig ocrConfig)

  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.

  Parameters:

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

  pdfConfig - the PDF configuration.

  ocrConfig - the OCR configuration.

• generateWithOcrFromDocument

   abstract Boolean generateWithOcrFromDocument(Document document, File outputFile, PdfConfiguration pdfConfig, OcrEngine.OcrConfig ocrConfig)

  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.

  Parameters:

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

  outputFile - the output PDF file

  pdfConfig - the PDF configuration.

  ocrConfig - the OCR configuration.

• generateWithOcrPagesFromUris

   abstract File generateWithOcrPagesFromUris(List<Uri> imageFileUris, Boolean sourceFilesEncrypted, PdfConfiguration pdfConfig, List<Page> sourceOcrPages)

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

  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 io.scanbot.sdk.ocr.model.Page OCR data.

• generateWithOcrPagesFromUris

   abstract File generateWithOcrPagesFromUris(List<Uri> imageFileUris, File outputFile, Boolean sourceFilesEncrypted, PdfConfiguration pdfConfig, List<Page> sourceOcrPages)

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

  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 io.scanbot.sdk.ocr.model.Page OCR data

• generateWithOcrPagesFromPages

  @Deprecated(message = "Use generateWithOcrPagesFromDocument() instead") abstract File generateWithOcrPagesFromPages(List<Page> pages, PdfConfiguration pdfConfig, List<Page> sourceOcrPages)

  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.

  Parameters:

  pages - list of Page objects.

  pdfConfig - the PDF configuration.

  sourceOcrPages - the source list of io.scanbot.sdk.ocr.model.Page OCR data.

• generateWithOcrPagesFromPages

  @Deprecated(message = "Use generateWithOcrPagesFromDocument() instead") abstract Boolean generateWithOcrPagesFromPages(List<Page> pages, File outputFile, PdfConfiguration pdfConfig, List<Page> sourceOcrPages)

  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.

  Parameters:

  pages - list of Page objects.

  outputFile - the output PDF file

  pdfConfig - the PDF configuration

  sourceOcrPages - the source list of io.scanbot.sdk.ocr.model.Page OCR data.

• generateWithOcrPagesFromDocument

   abstract Boolean generateWithOcrPagesFromDocument(Document document, PdfConfiguration pdfConfig, List<Page> sourceOcrPages)

  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.

  Parameters:

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

  pdfConfig - the PDF configuration.

  sourceOcrPages - the source list of io.scanbot.sdk.ocr.model.Page OCR data.

• generateWithOcrPagesFromDocument

   abstract Boolean generateWithOcrPagesFromDocument(Document document, File outputFile, PdfConfiguration pdfConfig, List<Page> sourceOcrPages)

  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.

  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 io.scanbot.sdk.ocr.model.Page OCR data.