Dart SDK

Overview

Cloudinary's Dart SDK provides simple, yet comprehensive image and video transformation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing Dart application.

The Dart SDK allows you to transform and deliver assets that are already in your Cloudinary repository. See Dart image and video upload to upload using the upload method of Cloudinary's Upload API.

On this page:

• Overview
  • Key features
• Get started
  • Add the Dart SDK dependency
  • Add your Cloudinary configuration
• Examples

Rate this page:

Key features

• Uses Cloudinary's new SDK action based syntax with enhanced code autocomplete.
• Build dynamic URLs for delivering images and videos.
• Actions and transformations are immutable, for easier and safer code reuse.

Get started

Install and configure the SDK in your project to get started.

Add the Dart SDK dependency

To use this SDK, add Cloudinary as a dependency in your pubspec.yaml file.

dependencies:
  cloudinary_url_gen: ^1.0.0
  cloudinary_api: ^1.0.0

Add your Cloudinary configuration

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 configuration credentials in the API Keys page of the Cloudinary Console Settings.

To set configuration parameters in your Dart application, use Cloudinary.fromStringUrl and pass your API environment variable:

var cloudinary = Cloudinary.fromStringUrl('cloudinary://<your-api-key>:<your-api-secret>@<your-cloud-name>');

Define optional configuration parameters by adding them to your configuration file. For example, set the secure optional configuration parameter to true in the configuration file named cloudinary:

cloudinary.config.urlConfig.secure = true;

Examples

Here's a simple example for generating a Cloudinary image URL, including a resize transformation, using the Dart SDK:

(cloudinary.image('sample.jpg')
  ..transformation(Transformation()
    ..resize(Resize.crop()
      ..width(100)
      ..height(150))))
  .toString();

Here's a simple example for generating a Cloudinary video URL, including a resize transformation with boomerang and vignette effects, using the Dart SDK:

 (cloudinary.video('ski_jump')
    ..transformation(Transformation()
      ..effect(Effect.boomerang())
      ..effect(Effect.vignette(30))
      ..resize(Resize.pad()
        ..height(360)
        ..width(480))))
      .toString();