Skip to main content
You're viewing documentation for a previous version of this software.Switch to the latest stable version


The PhotoEditor SDK for Android can easily be tailored to meet your business needs. Learn how to swiftly create the editor your use-case requires.


The SettingsList provides a lot of functions for customizing the Editor. To modify this configuration you need to generate a new SettingsList object and configurate the different models. Afterwards, you add the modified SettingsList to the CameraPreviewBuilder or the PhotoEditorBuilder.

public class EditorDemoActivity extends Activity implements PermissionRequest.Response {
// Important permission request for Android 6.0 and above, don't forget to add this!
public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
PermissionRequest.onRequestPermissionsResult(requestCode, permissions, grantResults);
super.onRequestPermissionsResult(requestCode, permissions, grantResults);
public void permissionGranted() {}
public 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.
// Set custom editor image export settings
.setExportDir(Directory.DCIM, "SomeFolderName")
return settingsList;
protected void onCreate(Bundle savedInstanceState) {
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 {
"No Gallery APP installed",
private void openEditor(Uri inputImage) {
SettingsList settingsList = createPesdkSettingsList();
// Set input image
new EditorBuilder(this)
.startActivityForResult(this, PESDK_RESULT);
protected 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();
} 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 gallery
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 serialisation
SettingsList lastState = data.getSettingsList();
try {
new IMGLYFileWriter(lastState).writeJson(new File(
} catch (IOException e) { e.printStackTrace(); }
} else if (resultCode == RESULT_CANCELED && requestCode == PESDK_RESULT) {
// Editor was canceled
EditorSDKResult data = new EditorSDKResult(intent);
Uri sourceURI = data.getSourceUri();
// TODO: Do something with the source...

Toolset configuration#

Editor Tools

In order to change the tools or rearrange them, use the setToolList method of the UiConfigMainMenu object. Before this, you can use the getTools() method to get an ArrayList containing the default tools. You can use the clear() method to clear the list and refill it with your selection of tools in the preferred order or update it directly. You can also add custom tools by extending the AbstractToolPanel class.

A single ToolItem object takes three parameters:

  1. ID of the tool panel
  2. The tool name
  3. ImageSource of the icon
// Obtain the config
UiConfigMainMenu uiConfigMainMenu = settingsList.getSettingsModel(UiConfigMainMenu.class);
// Set the tools you want keep sure you license is cover the feature and do not forget to include the correct modules in your build.gradle
new ToolItem(TransformToolPanel.TOOL_ID, R.string.pesdk_transform_title_name, ImageSource.create(R.drawable.imgly_icon_tool_transform)),
new ToolItem(FilterToolPanel.TOOL_ID, R.string.pesdk_filter_title_name, ImageSource.create(R.drawable.imgly_icon_tool_filters)),
new ToolItem(AdjustmentToolPanel.TOOL_ID, R.string.pesdk_adjustments_title_name, ImageSource.create(R.drawable.imgly_icon_tool_adjust)),
new ToolItem(StickerToolPanel.TOOL_ID, R.string.pesdk_sticker_title_name, ImageSource.create(R.drawable.imgly_icon_tool_sticker)),
new ToolItem(TextDesignToolPanel.TOOL_ID, R.string.pesdk_textDesign_title_name, ImageSource.create(R.drawable.imgly_icon_tool_text_design)),
new ToolItem(TextToolPanel.TOOL_ID, R.string.pesdk_text_title_name, ImageSource.create(R.drawable.imgly_icon_tool_text)),
new ToolItem(OverlayToolPanel.TOOL_ID, R.string.pesdk_overlay_title_name, ImageSource.create(R.drawable.imgly_icon_tool_overlay)),
new ToolItem(FrameToolPanel.TOOL_ID, R.string.pesdk_frame_title_name, ImageSource.create(R.drawable.imgly_icon_tool_frame)),
new ToolItem(BrushToolPanel.TOOL_ID, R.string.pesdk_brush_title_name, ImageSource.create(R.drawable.imgly_icon_tool_brush)),
new ToolItem(FocusToolPanel.TOOL_ID, R.string.pesdk_focus_title_name, ImageSource.create(R.drawable.imgly_icon_tool_focus))

Select available crop ratios#

Check out our transform documentation.

Configuring available fonts#

Take a look at the text documentation.

Adding or removing stickers#

Take a look at the stickers documentation.

Adding or removing filters#

Take a look at the filters documentation.