Last updated: Oct-31-2023
Cloudinary provides support for uploading media directly from your mobile application to your Cloudinary product environment, without going through your servers first. This method allows for faster uploading and a better user experience. It also reduces load on your servers and reduces the complexity of your applications.
You can also take advantage of upload presets for predefining upload parameters. For details on all the available upload parameters, see the Media upload documentation and the upload method of the Upload API Reference.
For security reasons, mobile applications shouldn't contain your Cloudinary product environment credentials. You can use a signed upload, but that requires generating an authentication signature on your backend. In most cases, you will probably use unsigned uploads that generally provide all the functionality you need for your mobile application, while restricting upload options that require more security.
Thanks for your time!
The upload request is managed by the
upload method, which accepts the file to upload as its only parameter. The file can be specified as either a
The OS attempts to initiate the upload immediately but the upload may be rescheduled depending on the system's current network, memory and cpu needs. The upload results are dispatched asynchronously and callbacks can be defined per request.
The following simple example uploads an image called
imageFile.jpg using the default settings:
The result of the upload API call is a
CLDUploadResult object that provides information about the uploaded image, including the assigned public ID of the image and its URL.
CLDImagePreprocessChain()object, and setting the encoder to
Unsigned upload is an option for performing upload without the need to generate a signature on your backend. Unsigned upload options are controlled by an upload preset: to use this feature, you first need to enable unsigned uploading for your Cloudinary product environment from the Upload page of your Cloudinary.
An upload preset is used to define which upload options will be applied to media assets that are uploaded unsigned with that preset specified. You can edit the preset at any point in time (or create additional upload presets).
Signed uploads require a signature which needs to be created using your api_secret. You should never expose your secret in client side code and therefore you need to generate an authentication signature on your backend. iOS signed upload with backend support should be implemented in conjunction with one of Cloudinary's backend frameworks (Java, .NET, etc). The various backend frameworks implement helpers to be used in conjunction with iOS, as well as automatically generate the authentication signature for the upload.
To implement signed uploads from an iOS device to your Cloudinary product environment you must:
- Provide a signature generated on your backend.
- Include the
apiKeyconfiguration parameter in your front end iOS configuration.
- Add the signature and timestamp to the upload options with the
- Call the
signedUploadmethod to upload the file.
For example, to upload an image called
imageFile.jpg, set the publicId to
newId, and sign the upload request:
You can pass an instance of
CLDUploadRequestParams, with any extra parameters you'd want to pass, as part of the upload request. For example, to upload an image called
imageFile.jpg using an upload preset called
If you want to include more than one upload parameter in the request you can chain them together. For example, to upload an image called
dog.jpg, set the publicId to
MyDog, and add the tag
The SDK includes the
uploadLarge method which offers more tolerance for network issues. This method uploads a large file to the cloud in chunks, and is required for any files that are larger than 100 MB. By default, the chunk size is set to 20 Megabytes but can be set to as low as 5 Megabytes with the
chunkSize parameter. For example, uploading a large video file called
myVid.mp4 and setting the chunk size to 6 Megabytes:
If you need to cancel an upload in progress, you can use the
You can track the upload progress by passing a
progress closure as part of the upload request, that is called periodically during the data transfer. For example:
You can also handle the response by adding a
completionHandler closure to be called once the upload request has finished. For example:
You can pass an instance of
CLDImagePreprocessChain, with any steps for preprocessing the image before uploading, as part of the upload request. The following types of processing steps are currently available:
|limit||(width, height)||Scales down the image to fit within a bounding box of the given dimensions.|
|rotate||(degrees)||Rotates the image by the requested degrees (clockwise).|
|dimensionsValidator||(minWidth, maxWidth, minHeight, maxHeight)||Verifies the minimum and maximum dimensions for the image. Throws an error if the image does not fit within these dimensions.|
|customImageEncoder||(format, quality)||Saves the image using the given format (EncodingFormat.JPEG or EncodingFormat.PNG) and quality.|
For example, to limit an image to a size of 500x500 pixels, make sure that the image is at least 10x10 pixels in size, rotate the image by 90 degrees and change the format to PNG with a quality of 70:
CLDProcessStepclosure with the
The iOS upload widget offers an interactive user interface that enables your users to edit and then upload files to your Cloudinary product environment. The widget, requiring just a couple lines of code to integrate, eliminates the need to develop certain in-house interactive media upload capabilities. Currently, the widget provides an interactive cropping capability and allows rotation of an image before uploading.
You call the upload widget by instantiating a new
CLDUploaderWidget and calling its
presentWidget() method with the calling ViewController (using
self in this example):
The upload widget takes five parameters that control its basic behavior:
|cloudinary||CLDCloudinary||No||The Cloudinary instance used for uploading.|
|configuration||CLDWidgetConfiguration||yes||See the table below.|
|images||UIImage Array||yes||Images to preload into the widget.|
|videos||AVPlayerItem Array||yes||Videos to preload into the widget|
|delegate||CLDUploaderWidgetDelegate||yes||Delegate for upload widgets callbacks. This is used to get notified when the widget is closed or canceled.|
|allowRotate||Bool||true||Whether to allow rotation of images in the widget|
|initialAspectLockState||AspectRatioLockState (enum)||enabledAndOff||Sets up the mode of the aspect ratio lock.|
|uploadType||CLDUploadType (enum: signed or unsigned+preset)||signed||Signed upload or unsigned (also provide the preset).|
A code example with more options:
A class implementing the
CLDUploaderWidgetDelegate is used to receive callbacks from the widget. It's common practice to have the calling view controller implement that protocol and send
self to the widget's constructor (such as in the example above).
The protocol has three methods:
func uploadWidget(_ widget: CLDUploaderWidget, willCall uploadRequests: [CLDUploadRequest])
This is the main callback - it informs the caller that the uploads are starting, passing on the list of references to active uploads. This allows the caller to set up callbacks per request (if required), track progress and cancel the requests. This is the same request object returned from the regular iOS upload methods.
func widgetDidCancel(_ widget: CLDUploaderWidget)
Notifies the caller that the widget was canceled.
Notifies the caller that the widget was dismissed and is no longer visible.
Add your own callback code by calling
uploadRequests within a controller that implements the