imageselector/com.wannaverse.imageselector

Package-level declarations

Types

enum ImageCompressionFormat : Enum<ImageCompressionFormat>

Output format used during compression.

data class ImageCompressionOptions(val format: ImageCompressionFormat = ImageCompressionFormat.JPEG, val quality: Int = 90, val maxBytes: Long? = null, val minQuality: Int = 55, val qualityStep: Int = 5)

Options that control image compression.

ImageData

data class ImageData(val bytes: ByteArray?)

A container class representing a loaded image.

WindowSize

data class WindowSize(val width: Int, val height: Int)

Functions

calculateInSampleSize

fun calculateInSampleSize(options: BitmapFactory.Options, reqHeight: Int, reqWidth: Int): Int

fun calculateInSampleSize(srcWidth: Int, srcHeight: Int, reqWidth: Int, reqHeight: Int): Int

compress

fun ImageData.compress(options: ImageCompressionOptions = ImageCompressionOptions()): ImageData

Returns a compressed copy of this ImageData.

compressImage

actual fun ByteArray.compressImage(options: ImageCompressionOptions): ByteArray

expect fun ByteArray.compressImage(options: ImageCompressionOptions = ImageCompressionOptions()): ByteArray

Compresses this ByteArray if it contains a supported image.

actual fun ByteArray.compressImage(options: ImageCompressionOptions): ByteArray

compressToMaxBytes

fun ImageData.compressToMaxBytes(maxBytes: Long, format: ImageCompressionFormat = ImageCompressionFormat.JPEG, quality: Int = 90, minQuality: Int = 55, qualityStep: Int = 5): ImageData

Compresses this ImageData toward the provided maximum size.

fun ByteArray.compressToMaxBytes(maxBytes: Long, format: ImageCompressionFormat = ImageCompressionFormat.JPEG, quality: Int = 90, minQuality: Int = 55, qualityStep: Int = 5): ByteArray

Compresses this ByteArray toward the provided maximum size.

decodeSampledBitmapFromUri

fun decodeSampledBitmapFromUri(context: Context, uri: Uri, reqResolution: WindowSize): Job

downSamplingToImageBitmap

actual suspend fun ByteArray.downSamplingToImageBitmap(coroutineScope: CoroutineScope, reqHeight: Int, reqWidth: Int): ImageBitmap?

expect suspend fun ByteArray.downSamplingToImageBitmap(coroutineScope: CoroutineScope, reqHeight: Int, reqWidth: Int): ImageBitmap?

Returns a bitmap with down sampling for the current screen size.

actual suspend fun ByteArray.downSamplingToImageBitmap(coroutineScope: CoroutineScope, reqHeight: Int, reqWidth: Int): ImageBitmap?

getAppContext

fun getAppContext(): Context

getCurrentWindowSize

actual fun getCurrentWindowSize(): WindowSize

expect fun getCurrentWindowSize(): WindowSize

actual fun getCurrentWindowSize(): WindowSize

registerImageSelectorLauncher

fun ComponentActivity.registerImageSelectorLauncher()

selectImage

actual suspend fun selectImage(loadingState: (Boolean) -> Unit): ImageData?

expect suspend fun selectImage(loadingState: (Boolean) -> Unit = {}): ImageData?

Opens the platform's image picker and returns the selected ImageData, or null if the user cancels the selection. The image isn't loaded in the memory in its actual size, it's downsampled according to the current window size of the app and then loaded into memory as ImageData which is lower than the actual size eliminating the possibility of OutOfMemoryError

actual suspend fun selectImage(loadingState: (Boolean) -> Unit): ImageData?

setImageSelectorActivity

fun setImageSelectorActivity(activity: ComponentActivity)

toByteArray

actual fun ImageBitmap.toByteArray(): ByteArray

expect fun ImageBitmap.toByteArray(): ByteArray

Converts this ImageBitmap into a ByteArray

actual fun ImageBitmap.toByteArray(): ByteArray

toImageBitmap

actual fun ByteArray.toImageBitmap(): ImageBitmap

expect fun ByteArray.toImageBitmap(): ImageBitmap

Converts this ByteArray into an ImageBitmap.

actual fun ByteArray.toImageBitmap(): ImageBitmap

withAspectRatio

fun ImageBitmap.withAspectRatio(aspectRatio: Float, scale: Boolean = false, targetHeight: Int? = null): ImageBitmap

Adjusts this ImageBitmap to a target aspect ratio.