kmp-bundle-sdk/io.scanbot.sdk.kmp.image/SaveImageOptions

SaveImageOptions

data class SaveImageOptions(var quality: Int = -1, var optimize: Boolean = false, var encryptionMode: EncryptionMode = EncryptionMode.AUTO)

Options for saving image to a path.

Constructors

SaveImageOptions

constructor(quality: Int = -1, optimize: Boolean = false, encryptionMode: EncryptionMode = EncryptionMode.AUTO)

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

Types

object Companion

Properties

var encryptionMode: EncryptionMode

Encryption mode.

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 toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JsonObject

fun toJsonString(config: ToJsonConfiguration = ToJsonConfiguration.default()): String