Getting Started
This document guides you through the process of integrating the PhotoEditor SDK into your Android application.
Update for AndroidX#
You are now able to use AndroidX without affecting our PhotoEditor SDK. Google provides a new build tools version which fixes the bug. So please use buildToolsVersion '29.0.2' when you are using AndroidX.
Integration Tutorial#
We made an awesome video tutorial for you.
Using a Trial License#
Make sure you have a standard license before adding it properly to your running project. A trial license is valid for only 30 days and will afterwards disable the export function for your customers. Your trial license should therefore be removed and substituted by a standard license. More information can be found here>.
Prerequisites#
The following software is required:
- Mac OS X, Windows, or Linux
- Android Studio 3.0+
- Android Minimum SDK 16+ (Android 4.1.0 released 27 June 2012)
- Gradle 3.0+
- Android Build Tools 29.0.2+
- Android Support Repository 28.0.0+
- License*
*You will need a valid license file in order to use the PhotoEditor SDK in your own application. You can request a trial license at here. As our example app comes bundled with its own license, you can use this right away, if you just want to take a quick look.
Supported Android versions#
The PhotoEditor SDK supports Android 4.1.0+ API 16 as the minSdkVersion
, but it must be
compiled with compileSdkVersion
and targetSdkVersion
Level 27+ to support Android 8.1 and above.
Add your license file#
Before using any components of the PhotoEditor SDK, you have to add your license file to your applications assets folder. The expected default name of the license file is "LICENSE". In order to change this, see licencePath option of PESDKConfig in your gradle file.
The license is digitally signed and can't be altered without becoming invalid. Our sample app comes with its own license, so you can try that right away. To try our SDK in your own app, you need to request a trial license that's bound to your bundle identifier. You can start a trial here and download your license file from your dashboard.
Once the license file has been added the application will validate its presence upon launch.
Setting up the workspace#
Please ensure that our artifactory repository is listed in your repositories in the project's build.gradle
file:
// Add the PESDK repository and plugin dependencybuildscript {repositories {google()gradlePluginPortal()maven { url 'https://artifactory.img.ly/artifactory/imgly' }}dependencies {// Insert the latest SDK version number here. You will find it here https://github.com/imgly/pesdk-android-demo/releasesclasspath 'ly.img.android.pesdk:plugin:7.6.5'// Add the Kotlin pluginclasspath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.61"}}
You will also have to add the pesdk plugin and PESDKConfig into your module's build.gradle
file:
// Apply the Android Pluginapply plugin: 'com.android.application'// Apply the PESDKPluginapply plugin: 'ly.img.android.sdk'// Apply Kotlin Pluginapply plugin: 'kotlin-android'// Configure the PESDKPluginimglyConfig {pesdk {enabled truelicencePath 'pesdk_android_license'}// Define the modules you are needmodules {// Add all the UI modules you are needinclude 'ui:core'include 'ui:text'include 'ui:focus'include 'ui:frame'include 'ui:brush'include 'ui:filter'include 'ui:camera'include 'ui:sticker'include 'ui:overlay'include 'ui:transform'include 'ui:adjustment'include 'ui:text-design'// Add the serializer if you needinclude 'backend:serializer'// Add asset packs if you needinclude 'assets:font-basic'include 'assets:frame-basic'include 'assets:filter-basic'include 'assets:overlay-basic'include 'assets:sticker-shapes'include 'assets:sticker-emoticons'}}// Do your Android Configurations... ex.android {/* Set the compileSdkVersion at 29 or greater and set the buildToolsVersion at '29.0.2' or greater.* We can't provide support for Bugs, that are the result of older SDK versions.*/compileSdkVersion 29buildToolsVersion '29.0.2'defaultConfig {/** Replace with your App-ID and keep sure that it match with your license!* @see http://tools.android.com/tech-docs/new-build-system/applicationid-vs-packagename*/applicationId "my.domain.application"/* Set the minimum supported SDK Version to 16 (Android 4.1.0) or higher */minSdkVersion 16/* Set the target SDK Version at minimum to 29 or higher */targetSdkVersion 29}/* Set Java Language level to Java 1.8+ */compileOptions {sourceCompatibility JavaVersion.VERSION_1_8targetCompatibility JavaVersion.VERSION_1_8}}
Sync your project with the Gradle files after every edit! For more information about Gradle, please take a look at the Android Developer Documentation
Android Permissions#
The PhotoEditor SDK requires two permissions: The "Write access to external storage" and the "Camera" permission (if you include the Camera module). You can grant this permissions yourself otherwise the SDK will automatically grant these permissions
Please take a look at the hint in the next step in order to integrate the Android 6.0 permission request correct!
Integration#
In order to open the camera preview and pass the resulting image to the editor, create a
CameraPreviewBuilder
and start the CameraPreviewActivity
with startActivityForResult(android.app.Activity, int)
:
Please make sure you delegate the
onRequestPermissionsResult()
toonRequestPermissionsResult()
as demonstrated in the following example. This ensures correct behavior on Android 6.0 and above.
public class CameraDemoActivity extends Activity implements PermissionRequest.Response {// Important permission request for Android 6.0 and above, don't forget to add this!@Overridepublic void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {PermissionRequest.onRequestPermissionsResult(requestCode, permissions, grantResults);super.onRequestPermissionsResult(requestCode, permissions, grantResults);}@Overridepublic void permissionGranted() {}@Overridepublic void permissionDenied() {/* TODO: The Permission was rejected by the user. The Editor was not opened,* Show a hint to the user and try again. */}public static int PESDK_RESULT = 1;private SettingsList createPesdkSettingsList() {// Create a empty new SettingsList and apply the changes on this referance.SettingsList settingsList = new SettingsList();// If you include our asset Packs and you use our UI you also need to add them to the UI,// otherwise they are only available for the backend// See the specific feature sections of our guides if you want to know how to add our own Assets.settingsList.getSettingsModel(UiConfigFilter.class).setFilterList(FilterPackBasic.getFilterPack());settingsList.getSettingsModel(UiConfigText.class).setFontList(FontPackBasic.getFontPack());settingsList.getSettingsModel(UiConfigFrame.class).setFrameList(FramePackBasic.getFramePack());settingsList.getSettingsModel(UiConfigOverlay.class).setOverlayList(OverlayPackBasic.getOverlayPack());settingsList.getSettingsModel(UiConfigSticker.class).setStickerLists(StickerPackEmoticons.getStickerCategory(),StickerPackShapes.getStickerCategory());// Set custom camera image export settingssettingsList.getSettingsModel(CameraSettings.class).setExportDir(Directory.DCIM, "SomeFolderName").setExportPrefix("camera_");// Set custom editor image export settingssettingsList.getSettingsModel(SaveSettings.class).setExportDir(Directory.DCIM, "SomeFolderName").setExportPrefix("result_").setSavePolicy(SaveSettings.SavePolicy.RETURN_ALWAYS_ONLY_OUTPUT);return settingsList;}@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);openCamera();}private void openCamera() {SettingsList settingsList = createPesdkSettingsList();new CameraPreviewBuilder(this).setSettingsList(settingsList).startActivityForResult(this, PESDK_RESULT);}@Overrideprotected void onActivityResult(int requestCode, int resultCode, android.content.Intent intent) {super.onActivityResult(requestCode, resultCode, intent);if (resultCode == RESULT_OK && requestCode == PESDK_RESULT) {// Editor has saved an Image.EditorSDKResult data = new EditorSDKResult(intent);data.notifyGallery(EditorSDKResult.UPDATE_RESULT & EditorSDKResult.UPDATE_SOURCE);Log.i("PESDK", "Source image is located here " + data.getSourceUri());Log.i("PESDK", "Result image is located here " + data.getResultUri());// TODO: Do something with the result image// OPTIONAL: read the latest state to save it as a serialisationSettingsList lastState = data.getSettingsList();try {new IMGLYFileWriter(lastState).writeJson(new File(Environment.getExternalStorageDirectory(),"serialisationReadyToReadWithPESDKFileReader.json"));} catch (IOException e) { e.printStackTrace(); }} else if (resultCode == RESULT_CANCELED && requestCode == PESDK_RESULT) {// Editor was canceledEditorSDKResult data = new EditorSDKResult(intent);Uri sourceURI = data.getSourceUri();// TODO: Do something...}}}
Start Editor standalone (without camera).#
If you want to open the editor directly with an existing image look at this example:
public class EditorDemoActivity extends Activity implements PermissionRequest.Response {// Important permission request for Android 6.0 and above, don't forget to add this!@Overridepublic void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {PermissionRequest.onRequestPermissionsResult(requestCode, permissions, grantResults);super.onRequestPermissionsResult(requestCode, permissions, grantResults);}@Overridepublic void permissionGranted() {}@Overridepublic void permissionDenied() {/* TODO: The Permission was rejected by the user. The Editor was not opened,* Show a hint to the user and try again. */}public static int PESDK_RESULT = 1;public static int GALLERY_RESULT = 2;private SettingsList createPesdkSettingsList() {// Create a empty new SettingsList and apply the changes on this referance.SettingsList settingsList = new SettingsList();// If you include our asset Packs and you use our UI you also need to add them to the UI,// otherwise they are only available for the backend// See the specific feature sections of our guides if you want to know how to add our own Assets.settingsList.getSettingsModel(UiConfigFilter.class).setFilterList(FilterPackBasic.getFilterPack());settingsList.getSettingsModel(UiConfigText.class).setFontList(FontPackBasic.getFontPack());settingsList.getSettingsModel(UiConfigFrame.class).setFrameList(FramePackBasic.getFramePack());settingsList.getSettingsModel(UiConfigOverlay.class).setOverlayList(OverlayPackBasic.getOverlayPack());settingsList.getSettingsModel(UiConfigSticker.class).setStickerLists(StickerPackEmoticons.getStickerCategory(),StickerPackShapes.getStickerCategory());// Set custom editor image export settingssettingsList.getSettingsModel(SaveSettings.class).setExportDir(Directory.DCIM, "SomeFolderName").setExportPrefix("result_").setSavePolicy(SaveSettings.SavePolicy.RETURN_ALWAYS_ONLY_OUTPUT);return settingsList;}@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);openSystemGalleryToSelectAnImage();}private void openSystemGalleryToSelectAnImage() {Intent intent = new Intent(Intent.ACTION_PICK, MediaStore.Images.Media.EXTERNAL_CONTENT_URI);if (intent.resolveActivity(getPackageManager()) != null) {startActivityForResult(intent, GALLERY_RESULT);} else {Toast.makeText(this,"No Gallery APP installed",Toast.LENGTH_LONG).show();}}private void openEditor(Uri inputImage) {SettingsList settingsList = createPesdkSettingsList();// Set input imagesettingsList.getSettingsModel(LoadSettings.class).setSource(inputImage);new EditorBuilder(this).setSettingsList(settingsList).startActivityForResult(this, PESDK_RESULT);}@Overrideprotected void onActivityResult(int requestCode, int resultCode, Intent intent) {super.onActivityResult(requestCode, resultCode, intent);if (resultCode == RESULT_OK && requestCode == GALLERY_RESULT) {// Open Editor with some uri in this case with an image selected from the system gallery.Uri selectedImage = intent.getData();openEditor(selectedImage);} else if (resultCode == RESULT_OK && requestCode == PESDK_RESULT) {// Editor has saved an Image.EditorSDKResult data = new EditorSDKResult(intent);// This adds the result and source image to Android's gallerydata.notifyGallery(EditorSDKResult.UPDATE_RESULT & EditorSDKResult.UPDATE_SOURCE);Log.i("PESDK", "Source image is located here " + data.getSourceUri());Log.i("PESDK", "Result image is located here " + data.getResultUri());// TODO: Do something with the result image// OPTIONAL: read the latest state to save it as a serialisationSettingsList lastState = data.getSettingsList();try {new IMGLYFileWriter(lastState).writeJson(new File(Environment.getExternalStorageDirectory(),"serialisationReadyToReadWithPESDKFileReader.json"));} catch (IOException e) { e.printStackTrace(); }} else if (resultCode == RESULT_CANCELED && requestCode == PESDK_RESULT) {// Editor was canceledEditorSDKResult data = new EditorSDKResult(intent);Uri sourceURI = data.getSourceUri();// TODO: Do something with the source...}}}
Sample Application#
You can access the source code for our demo application from our demo repository.