https://github.com/imagekit-developer/imagekit-android

Android SDK for Imagekit.io
https://github.com/imagekit-developer/imagekit-android

hacktoberfest image-manipulation image-optimization

Last synced: 7 days ago
JSON representation

Android SDK for Imagekit.io

Host: GitHub
URL: https://github.com/imagekit-developer/imagekit-android
Owner: imagekit-developer
License: mit
Created: 2019-06-11T11:22:34.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2023-08-29T10:43:06.000Z (over 2 years ago)
Last Synced: 2026-03-06T12:49:55.111Z (about 1 month ago)
Topics: hacktoberfest, image-manipulation, image-optimization
Language: Kotlin
Homepage: https://imagekit.io
Size: 24.8 MB
Stars: 22
Watchers: 6
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[](https://imagekit.io)

# ImageKit.io Android SDK

[![Release](https://jitpack.io/v/imagekit-developer/imagekit-android.svg)](https://jitpack.io/#imagekit-developer/imagekit-android)
![Build](https://github.com/imagekit-developer/imagekit-android/workflows/Gradle%20Tests/badge.svg)
[![codecov](https://codecov.io/gh/imagekit-developer/imagekit-android/branch/master/graph/badge.svg?token=BeabJwhQoh)](https://codecov.io/gh/imagekit-developer/imagekit-android/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/imagekitio)

Android SDK for [ImageKit.io](https://imagekit.io) implements client-side upload and URL generation for use inside an Android application.

ImageKit is a complete media storage, optimization, and transformation solution that comes with an image and video CDN. It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.

## Table of contents
* [Installation](#installation)
* [Initialization](#initialization)
* [URL construction](#url-construction)
* [Components](#components)
* [ImageKit](#imagekit)
* [List of supported transformations](#list-of-supported-transformations)
* [Responsive image loading](#responsive-image-loading)
* [Constructing Video URLs](#constructing-video-urls)
* [Adaptive bitrate streaming](#adaptive-bitrate-streaming)
* [File Upload](#file-upload)
* [Upload policy](#uploadpolicy)
* [Upload preprocessing](#upload-preprocessing)
* [Image preprocessing](#image-preprocessing)
* [Video preprocessing](#video-preprocessing)
* [Third-party integrations](#third-party-integrations)
* [Glide](#glide)
* [Picasso](#picasso)
* [Coil](#coil)
* [Fresco](#fresco)
* [Support](#support)
* [Links](#links)
* [License](#license)

## Installation

### Requirements
The library requires Android version 5.0.0 (API level 21 - Lollipop) or above.

### Installation
In your root build.gradle file, add:
```gradle
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
```

In the module build.gradle file, add:
```gradle
implementation 'com.github.imagekit-developer.imagekit-android:imagekit-android:'
```

## Usage

### Initialization
`urlEndpoint` is the required parameter. You can get the value of the URL-endpoint from your ImageKit dashboard - https://imagekit.io/dashboard#url-endpoints.

`transformationPosition` is optional. The default value for this parameter is `TransformationPosition.PATH`. Acceptable values are `TransformationPosition.PATH` & `TransformationPosition.QUERY`.

`defaultUploadPolicy` is optional and only needed if you want to use the SDK for client-side file upload. This sets the default constraints for all the upload requests.

_Note: Do not include your Private Key in any client-side code, including this SDK or its initialization._

```kotlin
// In kotlin
import com.imagekit.android.ImageKit

ImageKit.init(
context = applicationContext,
publicKey = "your_public_api_key",
urlEndpoint = "https://ik.imagekit.io/your_imagekit_id",
transformationPosition = TransformationPosition.PATH,
defaultUploadPolicy = UploadPolicy.Builder()
.requireNetworkType(UploadPolicy.NetworkType.ANY)
.setMaxRetries(3)
.build()
)
```

```java
// In Java
import com.imagekit.android.ImageKit;

### Quick Examples

### URL construction
#### Using image path
```kotlin
// Kotlin
// https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-400.00,ar-3-2
ImageKit.getInstance()
.url(
path = "default-image.jpg",
transformationPosition = TransformationPosition.QUERY
)
.height(400f)
.aspectRatio(3, 2)
.create()
```

```java
// Java
// https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-400.00,ar-3-2
ImageKit.Companion.getInstance()
.url(
"default-image.jpg",
TransformationPosition.QUERY
)
.height(400f)
.aspectRatio(3, 2)
.create()
```

#### Using full image URL
```kotlin
// https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg?tr=oi-logo-white_SJwqB4Nfe.png,ox-10,oy-20
ImageKit.getInstance()
.url(
src = "https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg",
transformationPosition = TransformationPosition.PATH
)
.create()
```

```java
// https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg?tr=oi-logo-white_SJwqB4Nfe.png,ox-10,oy-20
ImageKit.Companion.getInstance()
.url(
"https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg",
TransformationPosition.PATH
)
.create()
```

#### Using a custom parameter
```kotlin
// https://ik.imagekit.io/your_imagekit_id/plant.jpeg?tr=w-400,ot-Hand with a green plant,otc-264120,ots-30,ox-10,oy-10
ImageKit.getInstance()
.url(src = "https://ik.imagekit.io/your_imagekit_id/plant.jpeg?tr=oi-logo-white_SJwqB4Nfe.png,ox-10,oy-20")
.addCustomTransformation("w", "400")
.create()
```

```java
// Java
// https://ik.imagekit.io/your_imagekit_id/plant.jpeg?tr=w-400,ot-Hand with a green plant,otc-264120,ots-30,ox-10,oy-10
ImageKit.Companion.getInstance()
.url("https://ik.imagekit.io/your_imagekit_id/plant.jpeg?tr=oi-logo-white_SJwqB4Nfe.png,ox-10,oy-20")
.addCustomTransformation("w", "400")
.create()
```

#### Upload file from bitmap
``` kotlin
// Kotlin
ImageKit.getInstance().uploader().uploadImage(
file = bitmap!!,
fileName = filename,
useUniqueFilename = false,
tags = arrayOf("nice", "copy", "books"),
folder = "/dummy/folder/",
imageKitCallback = this
)
```

``` kotlin
// Java
ImageKit.Companion.getInstance().uploader().uploadImage(
bitmap,
filename,
false, // useUniqueFilename
new String[]{"nice", "copy", "books"}, // tags,
"/dummy/folder/",
imageKitCallback
)
```

#### Upload file from a remote URL
``` kotlin
// Kotlin
ImageKit.getInstance().uploader().upload(
file = "https://ik.imagekit.io/demo/img/default-image.jpg",
fileName = filename,
useUniqueFilename = false,
tags = arrayOf("nice", "copy", "books"),
folder = "/dummy/folder/",
imageKitCallback = this
)
```

``` java
// Java
ImageKit.Companion.getInstance().uploader().upload(
"https://ik.imagekit.io/demo/img/default-image.jpg",
filename,
false, // useUniqueFilename
new String[]{"nice", "copy", "books"}, // tags,
"/dummy/folder/",
imageKitCallback
)
```

#### Upload file using binary
```kotlin
// Kotlin
ImageKit.getInstance().uploader().upload(
file = file!!,
fileName = file!!.name,
useUniqueFilename = true,
tags = arrayOf("nice", "copy", "books"),
folder = "/dummy/folder/",
imageKitCallback = this
)
```

```java
// Java
ImageKit.Companion.getInstance().uploader().upload(
file,
filename,
false, // useUniqueFilename
new String[]{"nice", "copy", "books"}, // tags,
"/dummy/folder/",
imageKitCallback
)
```

## Demo application
You can run the demo application in [sample](/sample) folder.

## Components

The library includes 3 Primary Classes:

* [`ImageKit`](#ImageKit) for defining options like `urlEndpoint` for the application to use.
* `ImageKitURLConstructor` for [constructing image urls](#constructing-image-urls).
* `ImageKitUploader`for client-side [file uploading](#file-upload).
* `UploadPolicy` for setting a set of policy constraints that need to be validated for an upload request to be executed.
* `ImagePreprocess` to set the parameters for preprocessing the image to be uploaded.
* `VideoPreprocess` to set the parameters for preprocessing the video to be uploaded.

## ImageKit
In order to use the SDK, you need to provide it with a few configuration parameters.
```kotlin
// In kotlin
import com.imagekit.android.ImageKit

```java
// In Java
import com.imagekit.android.ImageKit;

ImageKit.Companion.init(
getApplicationContext(),
"your_public_api_key",
"https://ik.imagekit.io/your_imagekit_id",
TransformationPosition.PATH,
UploadPolicy.Builder()
.requireNetworkType(UploadPolicy.NetworkType.ANY)
.setMaxRetries(3)
.build()
);
```
* `urlEndpoint` is required to use the SDK. You can get URL-endpoint from your ImageKit dashboard - https://imagekit.io/dashboard#url-endpoints.
* `transformationPosition` is optional. The default value for this parameter is `TransformationPosition.PATH`. Acceptable values are `TransformationPosition.PATH` & `TransformationPosition.QUERY`.
* `defaultUploadPolicy` is optional and only needed if you want to use the SDK for client-side [file uploading](#file-upload). This sets the default constraints for all the upload requests.

> Note: Do not include your Private Key in any client-side code.

## Constructing Image URLs
The `ImageKitURLConstructor` is used to create a url that can be used for rendering and manipulating images in real time. `ImageKitURLConstructor` consists of functions that can be chained together to perform transformations.

`ImageKitURLConstructor` can be initialized by calling `ImageKit.getInstance().url(...)` with a set of parameters defined below.

| Parameter | Type | Description |
|:-----------------------|:-------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| urlEndpoint | String | Optional. The base URL to be appended before the path of the image. If not specified, the URL endpoint specified in the parent `IKContext` component is used. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/ |
| path | String | Conditional. This is the path at which the image exists. For example, `/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation. |
| src | String | Conditional. This is the complete URL of an image already mapped to ImageKit. For example, `https://ik.imagekit.io/your_imagekit_id/endpoint/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation. |
| transformationPosition | [TransformationPosition](/imagekit/src/main/java/com/imagekit/android/ImagekitUrlConstructor.kt) | Optional. The default value is `.PATH` that places the transformation string as a URL path parameter. It can also be specified as `.QUERY`, which adds the transformation string as the URL's query parameter i.e.`tr`. If you use `src` parameter to create the URL, then the transformation string is always added as a query parameter. |

The transformations to be applied to the URL can be chained to `ImageKit.getInstance().url(...)`. See the list of [different tranformations](#list-of-supported-transformations). Different steps of a [chained transformation](https://docs.imagekit.io/features/image-transformations/chained-transformations) can be added by calling the function `chainTransformation`.

### Basic Examples
```kotlin
// Kotlin
// https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-400.00,ar-3-2
ImageKit.getInstance()
.url(
path = "default-image.jpg",
transformationPosition = TransformationPosition.QUERY
)
.height(400f)
.aspectRatio(3, 2)
.create()
```

More Examples can be found in [URLGenerationTests.kt](imagekit/src/test/java/com/imagekit/android/URLGenerationTests.kt)

### List of supported transformations
The complete list of transformations supported and their usage in ImageKit can be found [here](https://docs.imagekit.io/imagekit-docs/image-transformations). The SDK provides a function for each transformation parameter, making the code simpler and readable. If a transformation is supported in ImageKit, but if a name for it cannot be found in the table below, then use the `addCustomTransformation` function and pass the transformation code from ImageKit docs as the first parameter and value as the second parameter. For example - `.addCustomTransformation("w", "400")`

Expand

| Supported Transformation Name | Transformation Function Prototypes | Translates to parameter |
|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| height | height(height: Int) | h |
| width | width(width: Int) | w |
| aspectRatio | aspectRatio(width: Int, height: Int) | ar |
| quality | quality(quality: Int) | q |
| crop | crop(cropType: CropType) | c |
| cropMode | cropMode(cropMode: CropMode) | cm |
| x, y | focus(x: Int, y: Int) | x, y |
| focus | focus(focusType: FocusType) | fo |
| format | format(format: Format) | f |
| radius | radius(radius: Int) | r |
| background | background(backgroundColor: String) | bg |
| border | border(borderWidth: Int, borderColor: String) | b |
| rotation | rotation(rotation: Rotation) | rt |
| blur | blur(blur: Int) | bl |
| named | named(namedTransformation: String) | n |
| progressive | progressive(flag: Boolean) | pr |
| lossless | lossless(flag: Boolean) | lo |
| trim | trim(flag: Boolean)
trim(value: Int) | t |
| metadata | metadata(flag: Boolean) | md |
| colorProfile | colorProfile(flag: Boolean) | cp |
| defaultImage | defaultImage(defaultImage: String) | di |
| dpr | dpr(dpr: Float) | dpr |
| effectSharpen | effectSharpen(value: Int = 0) | e-sharpen |
| effectUSM | effectUSM( radius: Float, sigma: Float, amount: Float, threshold: Float) | e-usm |
| effectContrast | effectContrast(flag: Boolean) | e-contrast |
| effectGray | effectGray(flag: Boolean) | e-grayscale |
| original | original(flag: Boolean) | orig |
| Raw param string | raw(params: String) | - |

### Responsive image loading
ImageKit URL constructor can be set to input any Android View and determine the parameters for image height and width based on the dimensions of the view. If the view's dimensions are not set at the time, it uses the display's dimensions as the fallback. It also sets the DPR of the image automatically to match that of the device display.
To automatically set the dimensions and pixel ratio of the image , call `ImageKit.getInstance().url(...).setResponsive(...)` with a set of parameters defined below:

| Parameter | Type | Description |
|:----------|:------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| view | [View](https://developer.android.com/reference/android/view/View) | Specifies the reference of the view of which the dimensions are to be taken into consideration for image sizing. |
| minSize | Int | Optional. Explicitly sets the minimum size for image dimensions. Defaults to 0. Passing a negative value will throw an `IllegalArgumentException`. |
| maxSize | Int | Optional. Explicitly sets the maximum size for image dimensions. Defaults to `Int.MAX_VALUE`. Passing a negative value will throw an `IllegalArgumentException`. |
| step | Int | Optional. Explicitly sets the step in pixels for rounding the dimensions to the nearest next multiple of `step`. Defaults to 100. Passing a negative value will throw an `IllegalArgumentException`. |
| crop | CropMode | Optional. Explicitly sets the mode for image cropping. Defaults to `CropMode.RESIZE`. |
| focus | FocusType | Optional. Specifies the area of the image to be set as the focal point for crop transform. Defaults to `FocusType.CENTER`. |

Code example:
```kotlin
// Kotlin
// https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-400.00,w-400.00,
ImageKit.getInstance()
.url(
path = "default-image.jpg",
transformationPosition = TransformationPosition.QUERY
)
.setResponsive(
view = displayView,
crop = CropMode.EXTRACT,
focus = FocusType.TOP_LEFT
)
.create()
```

```java
// Java
// https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-400.00,w-400.00,
ImageKit.Companion.getInstance()
.url(
"default-image.jpg",
TransformationPosition.QUERY
)
.setResponsive(displayView, CropMode.EXTRACT, FocusType.TOP_LEFT)
.create();
```

## Constructing Video URLs
The `ImageKitURLConstructor` can also be used to create a url that can be used for streaming videos with real-time transformations. `ImageKitURLConstructor` consists of functions that can be chained together to perform transformations.

The initialization is same as that for image URLs by calling `ImageKit.getInstance().url(...)` with a set of parameters defined below.

### Basic Examples
```kotlin
// Kotlin
// https://ik.imagekit.io/your_imagekit_id/default-video.mp4?tr=h-400.00,w-400.00
ImageKit.getInstance()
.url(
path = "default-video.mp4",
transformationPosition = TransformationPosition.QUERY
)
.height(400f)
.width(400f)
.create()
```

### Adaptive bitrate streaming
To obtain the video URL with adaptive streaming, call `ImageKit.getInstance().url(...).setAdaptiveStreaming(...)` with a set of parameters defined below.

| Parameter | Type | Description |
|:------------|:----------------|:--------------------------------------------------------------------------------------------------------------------------|
| format | StreamingFormat | Specifies the format for streaming video. Supported values for type are `StreamingFormat.HLS` and `StreamingFormat.DASH`. |
| resolutions | List\ | Specifies the representations of the required video resolutions. E. g. 480, 720, 1080 etc. |

Code example:
```kotlin
// Kotlin
// https://ik.imagekit.io/your_imagekit_id/default-video.mp4/ik-master.m3u8?tr=sr-240_360_480_720_1080_1440_2160
ImageKit.getInstance()
.url(
path = "default-video.mp4",
transformationPosition = TransformationPosition.QUERY
)
.setAdaptiveStreaming(
format = StreamingFormat.HLS,
resolutions = listOf(240, 360, 480, 720, 1080, 1440, 2160)
)
.create()
```

```java
// Java
// https://ik.imagekit.io/your_imagekit_id/default-video.mp4/ik-master.m3u8?tr=sr-240_360_480_720_1080_1440_2160
ImageKit.Companion.getInstance()
.url(
"default-video.mp4",
TransformationPosition.QUERY
)
.setAdaptiveStreaming(StreamingFormat.HLS,
Arrays.asList(240, 360, 480, 720, 1080, 1440, 2160)
)
.create();
```

## File Upload
The SDK provides a simple interface using the `ImageKit.getInstance().uploader().upload(...)` method to upload files to the ImageKit Media Library. It accepts all the parameters supported by the [ImageKit Upload API](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload#request-structure-multipart-form-data).

The `ImageKit.getInstance().uploader().upload(...)` accepts the following parameters

| Parameter | Type | Description |
|:------------------------|:------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| file | Binary / Bitmap / String | Required. |
| fileName | String | Required. If not specified, the file system name is picked. |
| token | String | Required. the client-generated JSON Web Token (JWT), which the ImageKit.io server uses to authenticate and check that the upload request parameters have not been tampered with after the generation of the token. Refer this [guide](https://docs.imagekit.io/api-reference/upload-file-api/secure-client-side-file-upload#how-to-implement-authenticationendpoint-endpoint) to create the token below on the page. |
| useUniqueFileName | Boolean | Optional. Accepts `true` of `false`. The default value is `true`. Specify whether to use a unique filename for this file or not. |
| tags | Array of string | Optional. Set the tags while uploading the file e.g. ["tag1","tag2"] |
| folder | String | Optional. The folder path (e.g. `/images/folder/`) in which the file has to be uploaded. If the folder doesn't exist before, a new folder is created. |
| isPrivateFile | Boolean | Optional. Accepts `true` of `false`. The default value is `false`. Specify whether to mark the file as private or not. This is only relevant for image type files |
| customCoordinates | String | Optional. Define an important area in the image. This is only relevant for image type files. To be passed as a string with the `x` and `y` coordinates of the top-left corner, and `width` and `height` of the area of interest in format `x,y,width,height`. For example - `10,10,100,100` |
| responseFields | Array of string | Optional. Values of the fields that you want upload API to return in the response. For example, set the value of this field to `["tags", "customCoordinates", "isPrivateFile"]` to get value of `tags`, `customCoordinates`, and `isPrivateFile` in the response. |
| extensions | List> | Optional. array of extensions to be processed on the image. For reference about extensions [read here](https://docs.imagekit.io/extensions/overview). |
| webhookUrl | String | Optional. Final status of pending extensions will be sent to this URL. To learn more about how ImageKit uses webhooks, [read here](https://docs.imagekit.io/extensions/overview#webhooks). |
| overwriteFile | Boolean | Optional. Default is `true`. If `overwriteFile` is set to false and `useUniqueFileName` is also false, and a file already exists at the exact location, upload API will return an error immediately. |
| overwriteAITags | Boolean | Optional. Default is `true`. If set to `true` and a file already exists at the exact location, its AITags will be removed. Set this to `false` to preserve AITags. |
| overwriteTags | Boolean | Optional. Default is `true`. If the request does not have `tags`, `overwriteTags` is set to `true` and if a file already exists at the exact location, exiting `tags` will be removed. In case the request body has `tags`, setting `overwriteTags` to `false` has no effect and request's `tags` are set on the asset. |
| overwriteCustomMetadata | Boolean | Optional. Default is `true`. If the request does not have `customMetadata`, `overwriteCustomMetadata` is set to `true` and if a file already exists at the exact location, exiting `customMetadata` will be removed. In case the request body has `customMetadata`, setting `overwriteCustomMetadata` to `false` has no effect and request's `customMetadata` is set on the asset. |
| customMetadata | Map | Optional. Key-value data to be associated with the uploaded file. Check `overwriteCustomMetadata` parameter to understand default behaviour. Before setting any custom metadata on an asset you have to create the field using [custom metadata fields API](https://docs.imagekit.io/api-reference/custom-metadata-fields-api). |
| policy | [UploadPolicy](README.md#UploadPolicy) | Optional. Set the custom policy to override the default policy for this upload request only. This doesn't modify the default upload policy. |
| preprocess | [ImagePreprocess](README.md#ImagePreprocess)/[VideoPreprocess](README.md#VideoPreprocess) | Optional. Set the set the parameters for preprocessing the image/video before uploads. This doesn't modify the default upload policy. |
| imageKitCallback | [ImageKitCallback](imagekit/src/main/java/com/imagekit/android/ImageKitCallback.kt) | Required. |

Note: Sending a JWT that has been used in the past will result in a validation error. Even if your previous request resulted in an error, you should always send a new JWT as the token parameter.
Warning: JWT must be generated on the server-side because it is generated using your account's private API key. This field is required for authentication when uploading a file from the client-side.

Sample Usage
```kotlin
ImageKit.getInstance().uploader().upload(
file = image,
fileName = "sample-image.jpg",
useUniqueFilename = true,
tags = ["demo"],
folder = "/",
isPrivateFile = false,
customCoordinates = "",
responseFields = "",
extensions = listOf(mapOf("name" to "google-auto-tagging", "minConfidence" to 80, "maxTags" to 10)),
webhookUrl = "https://abc.xyz",
overwriteFile = false,
overwriteAITags = true,
overwriteTags = true,
overwriteCustomMetadata = true,
customMetadata = mapOf("SKU" to "VS882HJ2JD", "price" to 599.99, "brand" to "H&M"),
policy = UploadPolicy.Builder()
.requireNetworkType(UploadPolicy.UploadPolicy.NetworkType.UNMETERED)
.setMaxRetries(5)
.build(),
preprocessor = ImageUploadPreprocessor.Builder()
.limit(512, 512)
.rotate(90f)
.build(),
imageKitCallback = object: ImageKitCallback {
override fun onSuccess(uploadResponse: UploadResponse) {
// Handle Success Response
}
override fun onError(uploadError: UploadError) {
// Handle Upload Error
}
}
)
```

### UploadPolicy
The `UploadPolicy` class represents a set of conditions that need to be met for an upload request to be executed.

`UploadPolicy.Builder` class is responsible for building the UploadPolicy instances. This class provides following methods to access and modify the policy parameters:

| Parameter | Type | Description |
|:---------------------------------------------------|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| requireNetworkType(type: NetworkType ) | UploadPolicy.Builder | Specifies the network type required for the upload request. Possible values are `UploadPolicy.NetworkPolicy.ANY` and `UploadPolicy.NetworkPolicy.UNMETERED`. Defaults to `NetworkPolicy.ANY`. |
| requiresBatteryCharging(requiresCharging: Boolean) | UploadPolicy.Builder | Sets whether the device needs to be connected to a charger for the upload request. Defaults to `false`. |
| requiresDeviceIdle(requiresIdle: Boolean) | UploadPolicy.Builder | Sets whether the device needs to be idle for the upload request. Defaults to `false`. |
| setMaxRetries(count: Int) | UploadPolicy.Builder | Sets the maximum number of retries for the upload request. Negative value will throw an `IllegalArgumentException`. Defaults to 5. |
| setRetryBackoff(interval, BackoffPolicy policy) | UploadPolicy.Builder | Sets the backoff interval in milliseconds and policy (`UploadPolicy.BackoffPolicy.LINEAR` or `UploadPolicy.BackoffPolicy.EXPONENTIAL`) for retry attempts. Defaults to interval of 10000ms and policy of `BackoffPolicy.LINEAR`. This increases the gap between each upload retry in either linear or exponential manner. E. g. if the `interval` is set to 3 seconds, then delay for each retry (n) will increase as following:

With linear backoff: 3, 6, 9, 12 seconds.. (`interval` * n).

With exponential backoff: 3, 6, 12, 24 seconds.. (`interval` * 2^n-1).

Example code
```kotlin
val policy = UploadPolicy.Builder()
.requireNetworkType(UploadPolicy.NetworkType.UNMETERED)
.requiresCharging(true)
.requiresDeviceIdle(false)
.setMaxRetries(5)
.setRetryBackoff(60000L, UploadPolicy.BackoffPolicy.EXPONENTIAL)
.build()
```
This code snippet will set the policy to allow the upload request to be placed only when the connected network in unmetered (e. g. over a Wi-Fi network) and the device battery is charging. Also the upload request will get the maximum of 5 retry attempts in case of failure, with the initial timeout of 60000ms which will increase exponentially for each subsequent retry.

## Upload preprocessing
### Image preprocessing
The `ImageUploadPreprocessor` class encapsulates a set of methods to apply certain transformations to an image before uploading. This will create a copy of the selected image, which will be transformed as per the given parameters before uploading.

`ImageUploadPreprocessor.Builder` class is responsible for building the ImageUploadPreprocessor instances. This class provides following methods to access and modify the policy parameters:

| Parameter | Type | Description |
|:------------------------------------------------------------------------------------------------------------------------|:--------------------------|:-------------------------------------------------------------------------|
| limit(width: Int, height: Int) | ImageUploadPreprocessor.Builder | Specifies the maximum width and height of the image |
| crop(p1: Point, p2: Point) | ImageUploadPreprocessor.Builder | Specifies the two points on the diagonal of the rectangle to be cropped. |
| format(format: [Bitmap.CompressFormat](https://developer.android.com/reference/android/graphics/Bitmap.CompressFormat)) | ImageUploadPreprocessor.Builder | Specify the target image format. |
| rotate(degrees: Float) | ImageUploadPreprocessor.Builder | Specify the rotation angle of the target image. |

Example code
```kotlin
val preprocessor = ImageUploadPreprocessor.Builder()
.limit(1280, 720)
.format(Bitmap.CompressFormat.WEBP)
.rotate(45f)
.build()
```
### Video preprocessing
The `VideoUploadPreprocessor` class encapsulates a set of methods to apply certain transformations to a video before uploading. This will create a copy of the selected video, which will be transformed as per the given parameters before uploading.

`VideoUploadPreprocessor.Builder` class is responsible for building the VideoUploadPreprocessor instances. This class provides the following methods to access and modify the policy parameters:

| Parameter | Type | Description |
|:-------------------------------------|:--------------------------|:-----------------------------------------------------|
| limit(width: Int, height: Int) | VideoUploadPreprocessor.Builder | Specifies the maximum width and height of the video. |
| frameRate(frameRateValue: Int) | VideoUploadPreprocessor.Builder | Specifies the target frame rate of the video. |
| keyFramesInterval(interval: Int) | VideoUploadPreprocessor.Builder | Specify the target keyframes interval of video. |
| targetAudioBitrateKbps(bitrate: Int) | VideoUploadPreprocessor.Builder | Specify the target audio bitrate of the video. |
| targetVideoBitrateKbps(bitrate: Int) | VideoUploadPreprocessor.Builder | Specify the target video bitrate of the video. |

Example code
```kotlin
val preprocessor = VideoUploadPreprocessor.Builder()
.frameRate(90)
.targetAudioBitrateKbps(320)
.targetVideoBitrateKbps(480)
.build()
```

## Third-party integrations

### Glide
In the module build.gradle file, add:
```gradle
implementation 'com.github.imagekit-developer.imagekit-android:imagekit-glide-extension:'
```
Then add the `createWithGlide()` extension function to the ImageKit URL constructor chain to get Glide's `RequestBuilder` instance to load into any target.
The `placeholderImage` and `errorImage` parameters can be optionally set to pass the drawables to show for placeholder and error states respectively.
```kotlin
ImageKit.getInstance()
.url(
path = "default-image.jpg",
transformationPosition = TransformationPosition.QUERY
)
.height(400f)
.aspectRatio(3, 2)
.createWithGlide(
placeholderImage = context.getDrawable(R.id.placeholder),
errorImage = context.getDrawable(R.id.error)
)
.circleCrop()
.into(imageView)
```
```java
IKGlideExtension.createWithGlide(
ImageKit.Companion.getInstance()
.url("default-image.jpg", TransformationPosition.QUERY)
.height(400)
.aspectRatio(3, 2),
context.getDrawable(R.id.placeholder),
context.getDrawable(R.id.error)
).circleCrop().into(imageView);
```

### Picasso
In the module build.gradle file, add:
```gradle
implementation 'com.github.imagekit-developer.imagekit-android:imagekit-picasso-extension:'
```
Then add the `createWithPicasso()` extension function to the ImageKit URL constructor chain to get Picasso's `RequestCreator` instance to load into any target.
The `placeholderImage` and `errorImage` parameters can be optionally set to pass the drawables to show for placeholder and error states respectively.
```kotlin
ImageKit.getInstance()
.url(
path = "default-image.jpg",
transformationPosition = TransformationPosition.QUERY
)
.height(400f)
.aspectRatio(3, 2)
.createWithPicasso(
placeholderImage = context.getDrawable(R.id.placeholder),
errorImage = context.getDrawable(R.id.error)
)
.centerCrop()
.into(imageView)
```
```java
IKPicassoExtension.createWithPicasso(
ImageKit.Companion.getInstance()
.url("default-image.jpg", TransformationPosition.QUERY)
.height(400)
.aspectRatio(3, 2),
context.getDrawable(R.id.placeholder),
context.getDrawable(R.id.error)
).centerCrop().into(imageView);
```

### Coil
In the module build.gradle file, add:
```gradle
implementation 'com.github.imagekit-developer.imagekit-android:imagekit-coil-extension:'
```
Then add the `createWithCoil()` extension function to the ImageKit URL constructor chain to get Coil's `ImageRequest.Builder` instance to load into any target, which can be enqueued with an `ImageLoader` instance.
The `placeholderImage` and `errorImage` parameters can be optionally set to pass the drawables to show for placeholder and error states respectively.
```kotlin
Coil.imageLoader(context)
.enqueue(ImageKit.getInstance()
.url(
path = "default-image.jpg",
transformationPosition = TransformationPosition.QUERY
)
.height(400f)
.aspectRatio(3, 2)
.createWithCoil(
placeholderImage = context.getDrawable(R.id.placeholder),
errorImage = context.getDrawable(R.id.error)
)
.target(imageView)
.build()
)
```
```java
Coil.imageLoader(context)
.enqueue(
IKCoilExtension.createWithCoil(
ImageKit.Companion.getInstance()
.url("default-image.jpg", TransformationPosition.QUERY)
.height(400)
.aspectRatio(3, 2),
context.getDrawable(R.id.placeholder),
context.getDrawable(R.id.error)
)
.target(imageView)
.build()
);
```

### Fresco
In the module build.gradle file, add:
```gradle
implementation 'com.github.imagekit-developer.imagekit-android:imagekit-fresco-extension:'
```
Then add the `createWithFresco()` extension function to the ImageKit URL constructor chain to get Fresco's `ImageRequest` instance to load into any target, which can be loaded into the controller of target `DraweeView` provided by Fresco by calling the `buildWithTarget()` method.
The `postprocessor` parameter can be optionally set to pass a `Postprocessor` for [post-precessing of images](https://frescolib.org/docs/modifying-image.html).
```kotlin
ImageKit.getInstance()
.url(
path = "default-image.jpg",
transformationPosition = TransformationPosition.QUERY
)
.height(400f)
.aspectRatio(3, 2)
.createWithFresco(
postprocessor = WatermarkPostprocessor()
)
.buildWithTarget(simpleDraweeView)
```
```java
IKFrescoExtension.buildWithTarget(
IKFrescoExtension.createWithFresco(
ImageKit.Companion.getInstance()
.url("default-image.jpg", TransformationPosition.QUERY)
.height(400)
.aspectRatio(3, 2),
WatermarkPostprocessor()
),
simpleDraweeView
);
```

## Support
For any feedback or to report any issues or general implementation support, please reach out to [support@imagekit.io](mailto:support@imagekit.io)

## Links
* [Documentation](https://docs.imagekit.io)
* [Main website](https://imagekit.io)

## License

Released under the MIT license.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/imagekit-developer/imagekit-android

Awesome Lists containing this project

README