Last updated: Nov-14-2022
Cloudinary's Android SDK provides simple, yet comprehensive image and video upload, transformation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing Android application.
Take a look at the following transformation code and the image it delivers:
MediaManager.get().url().transformation(new Transformation() .width(150).height(150).gravity("face").crop("thumb").chain() .radius(20).chain() .effect("sepia").chain() .overlay(new Layer().publicId("cloudinary_icon_blue")).gravity("south_east").x(5).y(5).width(50).opacity(60).effect("brightness:200").chain() .angle(10)).secure(true).generate("front_face.png");
This relatively simple code performs all of the following on the original front_face.jpg image before delivering it:
- Crop to a 150x150 thumbnail using face-detection gravity to automatically determine the location for the crop
- Round the corners with a 20 pixel radius
- Apply a sepia effect
- Overlay the Cloudinary logo on the southeast corner of the image (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness and partial transparency (opacity = 60%)
- Rotate the resulting image (including the overlay) by 10 degrees
- Convert and deliver the image in PNG format (the originally uploaded image was a JPG)
And here's the URL that would be included in the image tag that's automatically generated from the above code:
In a similar way, you can transform a video.
The following Android code uses an unsigned upload preset to upload the
dog.mp4 video to the specified sub-folder using the public_id,
my_dog. When the video upload is complete, the specified notification URL will receive details about the uploaded media asset.
String requestId = MediaManager.get().upload("dog.mp4") .unsigned("preset1") .option("resource_type", "video") .option("folder", "myfolder/mysubfolder/") .option("public_id", "my_dog") .option("notification_url", "https://mysite.example.com/notify_endpoint") .dispatch();
- Build dynamic URLs for delivering images and videos with on-the-fly transformations
- Implement direct file upload from your mobile application directly to your Cloudinary product environment
- Preprocess files before uploading
- Handle asynchronous upload callbacks
- Upload policy options (upload only on non-metered networks, only when charging, etc.) globally or per upload request
- Automatic error handling for network disconnections, timeouts, etc.
The Cloudinary Android SDK is available in modules. Select the modules to install based on the following table:
|Transformations, Upload, Client side responsive||Java core: 'com.cloudinary:cloudinary-core:[version]'|
|Image and video upload preprocessing||Core|
|Seamless integrations with 3rd party download libraries.||Core|
|Native upload widget with preview and preprocess UI||Preprocess|
|All of the above||All of the above (explicitly and implicitly).|
The following instructions detail the installation of the Cloudinary Android library. Note that there is no need for any ProGuard configuration. Use one of the following options:
Add the module(s) within the dependencies section of your
build.gradle file. For example:
// All: implementation 'com.cloudinary:cloudinary-android:2.2.0' // Download + Preprocess: compile group: 'com.cloudinary', name: 'cloudinary-android-preprocess', version: '2.2.0' compile group: 'com.cloudinary', name: 'cloudinary-android-download', version: '2.2.0'
2.2.0is the latest version at the time of publishing these docs. It's recommended to modify that value to the latest released version of the Cloudinary Android library in the code above.
Add the module(s) within the dependencies tag in your
pom.xml file. For example
// All: <dependency> <groupId>com.cloudinary</groupId> <artifactId>cloudinary-android</artifactId> <version>2.2.0</version> </dependency> // Download + Preprocess: <dependency> <groupId>com.cloudinary</groupId> <artifactId>cloudinary-android-download</artifactId> <version>2.2.0</version> </dependency> <dependency> <groupId>com.cloudinary</groupId> <artifactId>cloudinary-android-preprocess</artifactId> <version>2.2.0</version> </dependency>
Download the following 2 files and put them in your
To use the Cloudinary Android library you have to configure at least your
cloud_name. You can additionally define a number of optional configuration parameters if relevant. You can find your product environment credentials in the dashboard of our Cloudinary Console.
- Most functionality implemented on the client side does not require authentication, so only your
cloud_nameis required to be configured, and not your API key or secret. Your API secret should never be exposed on the client side, so if you want to use signed uploads or generate delivery signatures, you'll also need server-side code, for which you can use one of our backend SDKs.
- For backward compatibility reasons, the default value of the optional
secureconfiguration parameter is
false. However, for most modern applications, it's recommended to configure the
trueto ensure that your transformation URLs are always generated as HTTPS.
The entry point of the library is the
MediaManager object. The
MediaManager.init() method must be called once per application lifecycle before using the Android library, preferably in
Application.onCreate(). Setting the configuration parameters can be done either when initializing the library, or by using the
CLOUDINARY_URL meta-data property in the
To set the configuration parameters programmatically while initializing the MediaManager, pass a HashMap with parameters as the second argument of the
init method. For example:
Map config = new HashMap(); config.put("cloud_name", "myCloudName"); config.put("secure", true); MediaManager.init(this, config);
Alternatively, you can add the
CLOUDINARY_URL meta-data property to the
AndroidManifest.xml file, within the
application tag. For example:
<meta-data android:name="CLOUDINARY_URL" android:value="cloudinary://@myCloudName"/>
When using the meta-data property, no configuration is required when initializing the MediaManager:
Thanks for your time!
When using the Android SDK, keep these guidelines in mind:
- Parameter names:
snake_case. For example: public_id
PascalCase. For example: MediaManager
camelCase. For example: upload
- Pass parameter data as:
The Android sample project uses Cloudinary's Android SDK to perform direct uploading with uploading progress indication, an image preview with advanced transformations, and video playback of adaptive streaming videos based on the ExoPlayer library.
You can also check out the Cloudinary Demo - e-commerce App. The demo showcases some of Cloudinary's features, shows how to take advantage of existing open source libraries (e.g., Picasso, Glide, Fresco, Imageloader) and integrates them within a functional app. For more info, see Introducing the Cloudinary Demo Android App, Part 1.
- Learn more about uploading images and videos using the Android SDK.
- See examples of powerful image and video transformations using Android code
and see our image transformations and video transformation docs.
- Stay tuned for updates, tips and tutorials in Product Updates and Blog Posts.
- Take a look at our Kotlin SDK as an alternative for Android development with Cloudinary.