Android Scanbot SDK

9.0.0

Android Scanbot SDK/io.scanbot.sdk.image/EncodeImageOptions

EncodeImageOptions

data class EncodeImageOptions(var quality: Int = -1, var optimize: Boolean = false, var format: EncodingFormat = EncodingFormat.JPEG) : Parcelable

Options for encoding image.

Constructors

EncodeImageOptions

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(quality: Int = -1, optimize: Boolean = false, format: EncodingFormat = EncodingFormat.JPEG)

Types

object Companion

Properties

var format: EncodingFormat

Image format.

var optimize: Boolean

If true, the encoder will spend extra time when saving JPEG files to improve the compression rate. Enabling this option has no impact on quality.

var quality: Int

Quality parameter is for JPEG only and is in range 0 to 100. If -1, then the value from hibernation is used. In case the ImageRef was created in lazy load-mode and originally has the same format as the requested to save, then setting quality to -1 leads to simply copying from source to destination, which is time efficient and prevents quality loss caused by decoding the JPEG and then re-encoding it.

Functions

fun clone(): EncodeImageOptions

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject