Android Scanbot SDK API reference

7.1.0

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

ImageRef

class ImageRef(uniqueId: UUID, acquireStrongReference: Boolean) : Parcelable, AutoCloseable

Constructors

constructor(uniqueId: UUID, acquireStrongReference: Boolean)

Types

object CREATOR : Parcelable.Creator<ImageRef?>

Properties

var uniqueId: UUID?

Unique id of the native resource the object points to.

Functions

fun clear()

Releases native resources stored by the ref. If two different ImageRef objects have the same uniqueId both of them become cleared.

external fun clone(): ImageRef?

Creates a deep copy of the image.

open override fun close()

Releases strong reference to the image

describeContents

open override fun describeContents(): Int

external fun encodeImage(options: EncodeImageOptions = EncodeImageOptions()): ByteArray

Returns the stored image encoded with the given options.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

external fun hibernate()

Compresses ImageRef and stores it either on disk or in memory according to global settings.

external fun info(): ImageInfo?

Information about stored image.

external fun saveImage(path: String, options: SaveImageOptions = SaveImageOptions()): Boolean

Saves the stored image with the given options.

fun serialize(): String

Converts ImageRef to serialized string representation with acquiring serialized reference to the native resource. You must eventually call deserialize, otherwise the reference will leak

external fun toBitmap(): Bitmap?

Returns stored image as a bitmap

fun toJson(imageSerializationMode: ImageSerializationMode): JSONObject

Converts the Image Ref to Json representation If serialization mode is REFERENCE effectively calls serialize If serialization mode is BUFFER stores the image inplace in base64 format

open override fun writeToParcel(parcel: Parcel, flags: Int)