cloudinary / cloudinary_kotlin

Cloudinary Kotlin SDK library

Cloudinary Kotlin SDK

About

The Cloudinary Kotlin SDK allows you to quickly and easily integrate your application with Cloudinary. Effortlessly optimize and transform your cloud's assets.

Additional documentation

This Readme provides basic installation and usage information. For the complete documentation, see the Kotlin SDK Guide.

Table of Contents

• Key Features
• Version Support
• Installation
• Usage
  • Setup
  • Transform and Optimize Assets
  • Uploading Assets

Key Features

• Transform and optimize assets.

Version Support

SDK Version	Kotlin Version
1.x	> 1.0

Installation

Add the SDK to your project as a dependency, we recommend using a build management tool such as Maven or Gradle to do this.

Using Gradle:

Add the Cloudinary Kotlin SDK to the dependencies section of your build.gradle file.

implementation 'com.cloudinary:kotlin-url-gen:1.8.0'

Using Maven:

Add the Cloudinary Kotlin SDK to the list of dependencies in your pom.xml file.

<dependency>
  <groupId>com.cloudinary</groupId>
  <artifactId>kotlin-url-gen</artifactId>
  <version>1.8.0</version>
  <type>pom</type>
</dependency>

Usage

Setup

The Cloudinary class is the main entry point for using the library. Your cloud_name is required to create an instance of this class. Your api_key and api_secret are also needed to perform secure API calls to Cloudinary (e.g., image and video uploads). Setting the configuration parameters can be done either programmatically using an appropriate constructor of the Cloudinary class or globally using an environment variable. You can find your account-specific configuration parameters in the Dashboard page of your account console.

Here's an example of setting configuration parameters in your Kotlin application:

import com.cloudinary.*

...
private val cloudinary = Cloudinary("cloudinary://<your-api-key>:<your-api-secret>@<your-cloud-name>")

Transform and Optimize Assets

Generate a Cloudinary URL using the cloudinary.media helper method and pass this to your image or video view:

For example, to generate a url for an image called sample on the demo account, and resize it using the fill method:

A transformation is also added to the image - cropping and using the sepia effect:

 val cloudinary = Cloudinary("cloudinary://@demo")
 val url = cloudinary.image {
   publicId("sample")
   resize(Resize.fill {
     width(100)
     height(150)
   })
 }
 println(url.generate())

This will output the following url: https://res.cloudinary.com/demo/image/upload/c_fill,h_150,w_100/sample.jpg

Uploading Assets

To upload a file you need to call you cloudinary object with uploader(), here's an example:

cloudinary.uploader().upload(imageFile) { 
    params {
      uploadPreset = "sample_preset"
    }
    options {
      unsigned = true
    }
}

Contributions

See contributing guidelines.

Get Help

If you run into an issue or have a question, you can either:

• Open a Github issue (for issues related to the SDK)
• Open a support ticket (for issues related to your account)

About Cloudinary

Cloudinary is a powerful media API for websites and mobile apps alike, Cloudinary enables developers to efficiently manage, transform, optimize, and deliver images and videos through multiple CDNs. Ultimately, viewers enjoy responsive and personalized visual-media experiences—irrespective of the viewing device.

Additional Resources

• Cloudinary Transformation and REST API References: Comprehensive references, including syntax and examples for all SDKs.
• MediaJams.dev: Bite-size use-case tutorials written by and for Cloudinary Developers
• DevJams: Cloudinary developer podcasts on YouTube.
• Cloudinary Academy: Free self-paced courses, instructor-led virtual courses, and on-site courses.
• Code Explorers and Feature Demos: A one-stop shop for all code explorers, Postman collections, and feature demos found in the docs.
• Cloudinary Roadmap: Your chance to follow, vote, or suggest what Cloudinary should develop next.
• Cloudinary Facebook Community: Learn from and offer help to other Cloudinary developers.
• Cloudinary Account Registration: Free Cloudinary account registration.
• Cloudinary Website

Licence

Released under the MIT license.

cloudinary_kotlin's Issues

SDK not dropping exisitng image/upload in the URL

When the URL to be processed contains image/upload, that should be dropped from path to remove duplicacy.

For example:
This URL
https://something.furlenco.com/image/upload/v1/bucket/products/5900/hero/1702711218.jpg

should be processed to
https://res.cloudinary.com/key/image/upload/dpr_1.0,named_trans,w_500/v1/bucket/products/5900/hero/1702711218.jpg? (iOS SDK does this transformation, removing image/upload from the end path)

But Kotlin SDK sends out this
https://res.cloudinary.com/key/image/upload/named_trans/c_scale,w_500/dpr_1.0/image/upload/v1/bucket/products/5900/hero/1702711218.jpg? (notice a couple of image/upload)

Checking the iOS SDK, it does have logic to find and drop things like image/upload..

Can you help me understand why is Kotlin SDK not equipped with a similar logic? Due to this we are not able use the same URL format for both Android and iOS clients.

Support raw transformations

I greatly appreciate the type-safety this SDK provides when working with Cloudinary. However, for certain images, my use case requires the ability to add a set of predefined raw transformations at runtime, as provided by our backend.

The iOS SDK contains a rawTransformation function, as documented here: https://cloudinary.com/documentation/ios_image_manipulation#add_transformations

Requesting the addition of a similar function for the Kotlin SDK. As a workaround I am needing to manipulate the final generated URL which is not ideal.