The Aviary SDK is now part of the Adobe Creative SDK

The Aviary SDK is now the Image Editing component in the Adobe Creative SDK. Visit CreativeSDK.com to access the latest Image Editing SDK and brand new SDK components by Adobe, offering features like store to Creative Cloud and publish to Behance.

Aviary SDK Intent Parameters

Revision 3.6.3

This document explains all the optional parameters supported in the calling Intent, used to start the FeatherActivity class.

The only mandatory input parameter required by the Aviary-SDK is the image uri. The minimal Intent is:

Intent newIntent = new Intent( this, FeatherActivity.class );
newIntent.setData( Uri.parse("content://media/external/images/media/32705") );
startActivityForResult( newIntent, 1 ); 

There are a number of optional Extra parameters that can be added to the calling Intent. This document will explain all the optional extras available for the FeatherActivity Activity.

Example

The optional intent parameters can be added as follows:

newIntent.putExtra(Constants.EXTRA_OUTPUT, Uri.parse("file:///mnt/sdcard/..."));

Extra Parameters

Note All of the following constants are included in the com.aviary.android.feather.library.Constants class.


Constants.EXTRA_OUTPUT

By default Aviary creates the result image file and its path is returned inside the Intent object received in the onActivityResult method. You can specify which file must be used as output file instead. The value must be a valid file Uri and the file must exist. You can use this feature to overwrite an existing file.


Constants.EXTRA_OUTPUT_FORMAT

This is used to determine the bitmap output format. For valid values see Bitmap.CompressFormat.


Constants.EXTRA_OUTPUT_QUALITY

This is used to determine the output quality ( only if compress format is jpeg ). Valid value range is between 0 and 100 ( by default 95 is used ).


Constants.EXTRA_TOOLS_LIST

If tools-list is passed among the intent to Aviary-SDK then only the selected list of tools will be shown. The value must be a string array, and valid values are:

  • SHARPNESS
  • EFFECTS
  • REDEYE
  • CROP
  • WHITEN
  • DRAW
  • STICKERS
  • TEXT
  • BLEMISH
  • MEME
  • ORIENTATION
  • ENHANCE
  • FRAMES
  • SPLASH
  • FOCUS
  • BLUR
  • VIGNETTE
  • LIGHTING
  • COLOR
  • OVERLAYS

Constants.EXTRA_HIDE_EXIT_UNSAVE_CONFIRMATION

When the user clicks on the back button and the image contains unsaved data, a confirmation dialog appears by default. Setting this flag to true will hide that confirmation and the application will terminate.


Constants.EXTRA_EFFECTS_ENABLE_FAST_PREVIEW

Depending on the current image size and the current user device, some tools can take longer than expected to render the image. You can use this intent flag to adjust Aviary behavior in those situations.

  • Passing true will cause all pannels to display a small progress loader in the toolbar
  • Passing false will cause the editor to use a modal progress loader.

If you omit this extra in the calling intent, Aviary will determine this value reading the device CPU speed. Slow CPU's will see the modal, fast CPU's will see the progress loader.


Constants.EXTRA_IN_PREVIEW_MAX_SIZE

By default Aviary will resize the image loaded based on the device memory, screen size and other environment variables. If you want to set the max image size allowed at runtime, pass an integer value which represents the maximum size, in pixels, of the image width and height.

Note: this parameter does not affect the high resolution post processing. It only affects the preview image being edited by the user.


Constants.EXTRA_IN_HIRES_MEGAPIXELS

If you want to enable the hi-res image post processing you need to pass the maximum number of megapixels you want to save with this intent parameter. You can, for example, pass this to limit your hires images to 3 MP:

newIntent.putExtra( Constants.EXTRA_IN_HIRES_MEGAPIXELS, MegaPixels.Mp3.ordinal() );

You can post process images from 3MP up to 30MP (megapixels).


Constants.EXTRA_TOOLS_DISABLE_VIBRATION

Passing this parameter in the calling intent, with any value, will disable the haptic vibration used in certain tools.


Constants.EXTRA_IN_SAVE_ON_NO_CHANGES

A boolean to indicate how to manage a click on the "done" button even when no changes were made to the image.

  • Passing true will cause saved image to return RESULT_OK to your onActivityResult and in the returned Intent there will be the extra EXTRA_OUT_BITMAP_CHANGED with the value "false".
  • If false is passed then you will receive a RESULT_CANCELED and the image will not be saved at all.

The returned Intent will contain the EXTRA_OUT_BITMAP_CHANGED extra.

By default this value is true.


Constants.EXTRA_OUT_BITMAP_CHANGED

Note: this is an extra inside the output intent.

This value will be available in the result Intent of your onActivityResult method.
A Boolean to indicate if the user modified the bitmap or just clicked the "done" button without performing any operation (this behaviour depends on the value of EXTRA_IN_SAVE_ON_NO_CHANGES extra).


Constants.EXTRA_WHITELABEL

If your application has the required permissions, then passing this extra with a boolean value of true in the incoming Intent will remove from the Aviary Editor the feedback button and the Aviary logo.

Update: The Premium Upgrades are in the process of being deprecated. High resolution output is now free, and white label is no longer available for purchase.


Constants.EXTRA_IN_API_KEY_SECRET

This extra is required and it's the secret of your api key. You can find your secret key in the Aviary Dashboard: http://aviary.com/dashboard/apps


Constants.EXTRA_IN_BILLING_PUBLIC_KEY

If you're a PCN partner then the Aviary SDK will offer in-app products to your users. You need to pass your Google public key in order to enable this feature.

Aviary SDK Intent Parameters

Revision 3.6.3

This document explains all the optional parameters supported in the calling Intent, used to start the FeatherActivity class.

The only mandatory input parameter required by the Aviary-SDK is the image uri. The minimal Intent is:

Intent newIntent = new Intent( this, FeatherActivity.class );
newIntent.setData( Uri.parse("content://media/external/images/media/32705") );
startActivityForResult( newIntent, 1 ); 

There are a number of optional Extra parameters that can be added to the calling Intent. This document will explain all the optional extras available for the FeatherActivity Activity.

Example

The optional intent parameters can be added as follows:

newIntent.putExtra(Constants.EXTRA_OUTPUT, Uri.parse("file:///mnt/sdcard/..."));

Extra Parameters

Note All of the following constants are included in the com.aviary.android.feather.library.Constants class.


Constants.EXTRA_OUTPUT

By default Aviary creates the result image file and its path is returned inside the Intent object received in the onActivityResult method. You can specify which file must be used as output file instead. The value must be a valid file Uri and the file must exist. You can use this feature to overwrite an existing file.


Constants.EXTRA_OUTPUT_FORMAT

This is used to determine the bitmap output format. For valid values see Bitmap.CompressFormat.


Constants.EXTRA_OUTPUT_QUALITY

This is used to determine the output quality ( only if compress format is jpeg ). Valid value range is between 0 and 100 ( by default 95 is used ).


Constants.EXTRA_TOOLS_LIST

If tools-list is passed among the intent to Aviary-SDK then only the selected list of tools will be shown. The value must be a string array, and valid values are:

  • SHARPNESS
  • EFFECTS
  • REDEYE
  • CROP
  • WHITEN
  • DRAW
  • STICKERS
  • TEXT
  • BLEMISH
  • MEME
  • ORIENTATION
  • ENHANCE
  • FRAMES
  • SPLASH
  • FOCUS
  • BLUR
  • VIGNETTE
  • LIGHTING
  • COLOR
  • OVERLAYS

Constants.EXTRA_HIDE_EXIT_UNSAVE_CONFIRMATION

When the user clicks on the back button and the image contains unsaved data, a confirmation dialog appears by default. Setting this flag to true will hide that confirmation and the application will terminate.


Constants.EXTRA_EFFECTS_ENABLE_FAST_PREVIEW

Depending on the current image size and the current user device, some tools can take longer than expected to render the image. You can use this intent flag to adjust Aviary behavior in those situations.

  • Passing true will cause all pannels to display a small progress loader in the toolbar
  • Passing false will cause the editor to use a modal progress loader.

If you omit this extra in the calling intent, Aviary will determine this value reading the device CPU speed. Slow CPU's will see the modal, fast CPU's will see the progress loader.


Constants.EXTRA_IN_PREVIEW_MAX_SIZE

By default Aviary will resize the image loaded based on the device memory, screen size and other environment variables. If you want to set the max image size allowed at runtime, pass an integer value which represents the maximum size, in pixels, of the image width and height.

Note: this parameter does not affect the high resolution post processing. It only affects the preview image being edited by the user.


Constants.EXTRA_IN_HIRES_MEGAPIXELS

If you want to enable the hi-res image post processing you need to pass the maximum number of megapixels you want to save with this intent parameter. You can, for example, pass this to limit your hires images to 3 MP:

newIntent.putExtra( Constants.EXTRA_IN_HIRES_MEGAPIXELS, MegaPixels.Mp3.ordinal() );

You can post process images from 3MP up to 30MP (megapixels).


Constants.EXTRA_TOOLS_DISABLE_VIBRATION

Passing this parameter in the calling intent, with any value, will disable the haptic vibration used in certain tools.


Constants.EXTRA_IN_SAVE_ON_NO_CHANGES

A boolean to indicate how to manage a click on the "done" button even when no changes were made to the image.

  • Passing true will cause saved image to return RESULT_OK to your onActivityResult and in the returned Intent there will be the extra EXTRA_OUT_BITMAP_CHANGED with the value "false".
  • If false is passed then you will receive a RESULT_CANCELED and the image will not be saved at all.

The returned Intent will contain the EXTRA_OUT_BITMAP_CHANGED extra.

By default this value is true.


Constants.EXTRA_OUT_BITMAP_CHANGED

Note: this is an extra inside the output intent.

This value will be available in the result Intent of your onActivityResult method.
A Boolean to indicate if the user modified the bitmap or just clicked the "done" button without performing any operation (this behaviour depends on the value of EXTRA_IN_SAVE_ON_NO_CHANGES extra).


Constants.EXTRA_WHITELABEL

If your application has the required permissions, then passing this extra with a boolean value of true in the incoming Intent will remove from the Aviary Editor the feedback button and the Aviary logo.

Update: The Premium Upgrades are in the process of being deprecated. High resolution output is now free, and white label is no longer available for purchase.


Constants.EXTRA_IN_API_KEY_SECRET

This extra is required and it's the secret of your api key. You can find your secret key in the Aviary Dashboard: http://aviary.com/dashboard/apps


Constants.EXTRA_IN_BILLING_PUBLIC_KEY

If you're a PCN partner then the Aviary SDK will offer in-app products to your users. You need to pass your Google public key in order to enable this feature.