Android Scanbot SDK API reference

7.1.1

Android Scanbot SDK API reference/io.scanbot.sdk.pdf/PdfiumSdk

PdfiumSdk

class PdfiumSdk

Constructors

constructor()

Types

object Companion

Properties

val currentDpi: Int = 72

val documentMeta: Meta

Get metadata for given document

mFileDescriptor

var mFileDescriptor: ParcelFileDescriptor?

var mNativeDocPtr: Long

mNativePagesPtr

val mNativePagesPtr: MutableMap<Int, Long>

val pageCount: Int

Get total number of pages in document

tableOfContents

val tableOfContents: List<Bookmark>

Get table of contents (bookmarks) for given document

Functions

fun closeDocument()

Release native resources and opened file

fun getPageHeight(index: Int): Int

Get page height in pixels.

This method requires page to be opened.

getPageHeightPoint

fun getPageHeightPoint(index: Int): Int

Get page height in PostScript points (1/72th of an inch).

This method requires page to be opened.

fun getPageLinks(pageIndex: Int): List<Link>

Get all links from given page

getPageRotation

fun getPageRotation(index: Int): Int

Get the rotation of page

fun getPageSize(index: Int): Size

Get size of page in pixels.

This method does not require given page to be opened.

fun getPageWidth(index: Int): Int

Get page width in pixels.

This method requires page to be opened.

getPageWidthPoint

fun getPageWidthPoint(index: Int): Int

Get page width in PostScript points (1/72th of an inch).

This method requires page to be opened.

mapPageCoordinateToDevice

fun mapPageCoordinateToDevice(pageIndex: Int, startX: Int, startY: Int, sizeX: Int, sizeY: Int, rotate: Int, coords: RectF): RectF

mapPageCoordsToDevice

fun mapPageCoordsToDevice(pageIndex: Int, startX: Int, startY: Int, sizeX: Int, sizeY: Int, rotate: Int, pageX: Double, pageY: Double): Point

Map page coordinates to device screen coordinates

nativeCloseDocument

external fun nativeCloseDocument(docPtr: Long)

nativeClosePage

external fun nativeClosePage(pagePtr: Long)

nativeClosePages

external fun nativeClosePages(pagesPtr: LongArray)

nativeGetBookmarkDestIndex

external fun nativeGetBookmarkDestIndex(docPtr: Long, bookmarkPtr: Long): Long

nativeGetBookmarkTitle

external fun nativeGetBookmarkTitle(bookmarkPtr: Long): String?

nativeGetDestPageIndex

external fun nativeGetDestPageIndex(docPtr: Long, linkPtr: Long): Int?

nativeGetDocumentMetaText

external fun nativeGetDocumentMetaText(docPtr: Long, tag: String): String?

nativeGetFirstChildBookmark

external fun nativeGetFirstChildBookmark(docPtr: Long, bookmarkPtr: Long?): Long?

nativeGetLinkRect

external fun nativeGetLinkRect(linkPtr: Long): RectF?

nativeGetLinkURI

external fun nativeGetLinkURI(docPtr: Long, linkPtr: Long): String?

nativeGetPageCount

external fun nativeGetPageCount(docPtr: Long): Int

nativeGetPageHeightPixel

external fun nativeGetPageHeightPixel(pagePtr: Long, dpi: Int): Int

nativeGetPageHeightPoint

external fun nativeGetPageHeightPoint(pagePtr: Long): Int

nativeGetPageLinks

external fun nativeGetPageLinks(pagePtr: Long): LongArray

nativeGetPageRotation

external fun nativeGetPageRotation(pagePtr: Long): Int

nativeGetPageSizeByIndex

external fun nativeGetPageSizeByIndex(docPtr: Long, pageIndex: Int, dpi: Int): Size

nativeGetPageWidthPixel

external fun nativeGetPageWidthPixel(pagePtr: Long, dpi: Int): Int

nativeGetPageWidthPoint

external fun nativeGetPageWidthPoint(pagePtr: Long): Int

nativeGetSiblingBookmark

external fun nativeGetSiblingBookmark(docPtr: Long, bookmarkPtr: Long): Long?

external fun nativeLoadPage(docPtr: Long, pageIndex: Int): Long

nativeLoadPages

external fun nativeLoadPages(docPtr: Long, fromIndex: Int, toIndex: Int): LongArray

nativeOpenDocument

external fun nativeOpenDocument(fd: Int, password: String?): Long

nativeOpenMemDocument

external fun nativeOpenMemDocument(data: ByteArray, password: String): Long

nativePageCoordinateToDevice

external fun nativePageCoordinateToDevice(pagePtr: Long, startX: Int, startY: Int, sizeX: Int, sizeY: Int, rotate: Int, pageX: Double, pageY: Double): Point

nativeRenderPage

external fun nativeRenderPage(pagePtr: Long, surface: Surface, dpi: Int, startX: Int, startY: Int, drawSizeHor: Int, drawSizeVer: Int, renderAnnot: Boolean)

nativeRenderPageBitmap

external fun nativeRenderPageBitmap(pagePtr: Long, bitmap: Bitmap, dpi: Int, startX: Int, startY: Int, drawSizeHor: Int, drawSizeVer: Int, renderAnnot: Boolean, docPtr: Long)

fun newDocument(fd: ParcelFileDescriptor)

Create new document from file

fun newDocument(fileDescriptor: ParcelFileDescriptor, password: String?)

Create new document from file with password

fun openPage(pageIndex: Int): Long

Open page and store native pointer

fun openPage(fromIndex: Int, toIndex: Int): LongArray

Open range of pages and store native pointers

recursiveGetBookmark

fun recursiveGetBookmark(tree: ArrayList<Bookmark>, bookmarkPtr: Long)

fun renderPage(surface: Surface, pageIndex: Int, startX: Int, startY: Int, drawSizeX: Int, drawSizeY: Int, renderAnnot: Boolean = false)

Render page fragment on Surface.

Page must be opened before rendering.

renderPageBitmap

fun renderPageBitmap(bitmap: Bitmap, pageIndex: Int, startX: Int, startY: Int, drawSizeX: Int, drawSizeY: Int, renderAnnot: Boolean = false)

Render page fragment on Bitmap. This method allows to render annotations.

Page must be opened before rendering.