iOS SDK

Overview

Cloudinary's iOS 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 iOS application.

 

We invite you to try the free Introduction to Cloudinary's iOS SDK online course, where you can learn how to upload, transform and optimize your assets, explore the native video player and deliver images for seamless asset downloading.

Quick example: Transformations

Take a look at the following transformation code and the image it delivers:

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.

Quick example: File upload

The following Swift code uses an unsigned upload preset to upload the dog.mp4 video. When the video upload is complete, the specified notification URL will receive details about the uploaded media asset.

iOS SDK features

• 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
• Support chunked upload for large files
• Preprocess files before uploading
• Handle asynchronous upload callbacks
• Automatic error handling for network disconnections, timeouts, etc.
• Save bandwidth with a cache-enabled resource downloader
• Support code in Objective-C

Installation

The following instructions detail the installation of the Cloudinary iOS library. Use one of the following options:

CocoaPods installation

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. Add the Cloudinary dependency to your Podfile:

Then, run the command:

This will run a script to install the Cloudinary header files in your Pods roots folder.

Carthage installation

Carthage is a decentralized dependency manager for Cocoa.

1. Create your Cartfile. Go to the application directory and run the following command:
   touch Cartfile
2. Add the following line to your Cartfile:
   github "cloudinary/cloudinary_ios" ~> 5.1.0
3. Run the following command:
   carthage update --use-xcframeworks

Swift Package Manager installation

The Swift Package Manager is a tool for managing the distribution of Swift code. It's integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies. Once you have your Swift package set up:

Option 1 - in your code, add Cloudinary to the dependencies value of your Package.swift file:

Option 2 - via your environment:

1. Select File > Add Packages
2. Add the repository URL: https://github.com/cloudinary/cloudinary_ios.git
3. Select "Up to Next Major" with version "5.1.0"

Manual installation

If you prefer not to use a dependency manager, you can add Cloudinary manually by adding it as a submodule to your project.

1. If your project is not initialized as a git repository, run the command:
   $ git init
2. To add Cloudinary as a git submodule, run the command:
   $ git submodule add https://github.com/cloudinary/cloudinary_ios.git
3. Open Terminal and navigate to your project's top level directory.
4. Drag Cloudinary.xcodeproj into the Project Navigator of your application's Xcode project. It should appear under your application's blue project icon.
5. Select Cloudinary.xcodeproj and make sure the deployment target matches that of your application target.
6. Select your application project. Under TARGETS select your application, open the General tab, click on the + button under Embedded Binaries and select Cloudinary.framework.

Setup

To use the Cloudinary iOS library you have to configure at least your cloudName. You can additionally define a number of optional configuration parameters if relevant. You can find your Cloud name in the Programmable Media Dashboard of the Cloudinary Console, and you can find all of your credentials, including API Key and API Secret, on the API Keys page of the Cloudinary Console Settings.

The entry point of the library is the CLDCloudinary object, which is initialized with an instance of CLDConfiguration with the desired params, for example:

Another option is to pass a cloudinaryURL in the form cloudinary://@[CLOUD_NAME]?{URL config parameters}, for example:

iOS capitalization and data type guidelines

When using the iOS SDK, keep these guidelines in mind:

• Parameter names: camelCase. For example: fileUrl
• Classes: PascalCase. For example: CLDTransformation
• Methods: camelCase. For example: createUploader
• Pass parameter data as a Dictionary

Sample project

The iOS example project gives a sample of using the iOS SDK to perform some of Cloudinary's functionality.