Android Scanbot SDK API reference

7.1.0

Android Scanbot SDK API reference/io.scanbot.sdk.core/ImageRef/CREATOR

CREATOR

object CREATOR : Parcelable.Creator<ImageRef?>

Functions

acquireSerializedReference

external fun acquireSerializedReference(uniqueId: UUID): Boolean

createFromParcel

open override fun createFromParcel(parcel: Parcel): ImageRef?

fun deserialize(source: String): ImageRef

Creates ImageRef from serialized string representation with upgrading serialized reference to a strong one

external fun fromBitmap(bitmap: Bitmap, options: BasicImageLoadOptions = BasicImageLoadOptions()): ImageRef

Creates ImageRef from a bitmap.

fromEncodedBuffer

external fun fromEncodedBuffer(encodedBuffer: ByteArray, options: BufferImageLoadOptions = BufferImageLoadOptions()): ImageRef?

Creates ImageRef from encoded buffer, e.g. from jpeg.

fromInputStream

fun fromInputStream(inputStream: InputStream, options: BufferImageLoadOptions = BufferImageLoadOptions()): ImageRef?

Creates ImageRef from the given input stream of encoded bytes

fun fromJson(source: Map<String, Any?>): ImageRef

fun fromJson(source: JSONObject): ImageRef

external fun fromNv21(nv21: ByteArray, width: Int, height: Int, options: RawImageLoadOptions = RawImageLoadOptions()): ImageRef

Creates ImageRef from nv21 bytes

external fun fromPath(path: String, options: PathImageLoadOptions = PathImageLoadOptions()): ImageRef?

Creates ImageRef from the path to an image.

fromSerializedReference

fun fromSerializedReference(uniqueId: UUID): ImageRef

open override fun newArray(size: Int): Array<ImageRef?>

releaseAllImages

external fun releaseAllImages()

Releases all alive images despite any existing references.

releaseStrongReference

external fun releaseStrongReference(uniqueId: UUID): Boolean

setHibernationCacheDirPath

external fun setHibernationCacheDirPath(cacheDirPath: String?)

Sets directory in which hibernated images are stored. If null is passed, then hibernated images are stored in compressed format in memory. Can be set at most once, best when the application is initialized but in any case before any ImageRef is created.

setHibernationJpegQuality

external fun setHibernationJpegQuality(quality: Int)

Sets the quality of JPEG compression used to encode images when hibernating. The default is 80.

setStorageCryptingProvider

external fun setStorageCryptingProvider(storageCryptingProvider: CoreStreamProvider?)

Sets storageCryptingProvider that is used when an image is read/written from/to disk. The provider is used both when images are hibernated and when they are saved/loaded from disk with saveImage/fromPath. Can be set at most once, best when the application is initialized but in any case before any ImageRef is created.

upgradeSerializedReference

external fun upgradeSerializedReference(uniqueId: UUID): Boolean