iOS integration

Overview

Cloudinary is a cloud-based service that provides an end-to-end image and video management solution. The iOS SDK provides simple, yet comprehensive file upload, administration, manipulation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing iOS application.

The Cloudinary iOS SDK supports iOS 8.0 or higher.

Quick example

The following Cloudinary URL and corresponding iOS code generates the image below including all of the following transformations:

  • A thumbnail crop to a size of 150x150 pixels using face detection gravity to automatically determine the location for the crop
  • Rotated 20 degrees
  • Sepia effect
  • Cloudinary logo overlay on the southeast corner (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness, and partial transparency (opaqueness = 60%)
  • 10 degree rotation
  • Converted to and delivered in PNG format (the originally uploaded image was a JPG)
cloudinary.createUrl()
  .setTransformation(CLDTransformation()
    .setWidth(150).setHeight(150).setGravity("face").setRadius(20).setEffect("sepia").setCrop("thumb").chain()
    .setOverlay("cloudinary_icon").setGravity("south_east").setX(5).setY(5).setWidth(50).setOpacity(60).setEffect("brightness:200").chain()
    .setAngle(10))
  .generate("front_face.png")

Example dynamic delivery URL

iOS SDK features

Cloudinary provides a Swift-based iOS library with an easy-to-use API for further simplifying the integration.

  • Build URLs for image and video transformation & manipulation.
  • Easy uploading to the cloud from your application.
  • Cache-enabled resource downloader.
  • Asynchronous upload callbacks.
  • Supports developers still using Objective-C.

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

Getting started

This section describes the information you need to know for installing and setting up iOS.

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:

pod 'Cloudinary', '~> 2.0'

Then, run the command:

$ pod install

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

Manual installation

If you prefer not 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

Open Terminal and navigate to your project's top level directory.

  1. Drag Cloudinary.xcodeproj into the Project Navigator of your application's Xcode project. It should appear under your application's blue project icon.
  2. Select Cloudinary.xcodeproj and make sure the deployment target matches that of your application target.
  3. Select your application project. Under TARGETS select your application, open the General tab, click on the + button under the Embedded Binaries and select Cloudinary.framework.
Dependencies

The Cloudinary iOS SDK depends on Alamofire. If you add Cloudinary manually you will also need to add Alamofire manually to your project. Make sure to checkout the correct version after adding the submodule.

  1. Open Terminal, navigate to Cloudinary's cloned repository folder, then add Alamofire as a git submodule by running the command:
    $ git submodule add https://github.com/Alamofire/Alamofire.git
  2. Checkout the desired Alamofire version:
    $ cd Alamofire/
    $ git checkout 4.1.0

  3. Open the new Alamofire folder and drag Alamofire.xcodeproj into the Project Navigator of Cloudinary's Xcode project.

  4. Select the Cloudinary project, and under TARGETS select Cloudinary. Then open the General tab, click on the + button under Linked Frameworks and Libraries and select Alamofire.framework.

Setup

To use the Cloudinary iOS 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 configuration parameters in the dashboard of our Management Console.

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

let config = CLDConfiguration(cloudName: "CLOUD_NAME", apiKey: "API_KEY")
let cloudinary = CLDCloudinary(configuration: config)

Another option is to pass a cloudinaryURL in the form cloudinary://[APIKEY]@[CLOUDNAME], for example:

let config = CLDConfiguration(cloudinaryUrl: "cloudinary://MY_KEY@MY_CLOUD")

Sample project

The iOS sample project uses Cloudinary's iOS SDK to perform direct uploading with uploading progress indication and an image preview with advanced transformations.