Inherits from UIViewController
Declared in AdobeUXImageEditorViewController.h

Overview

This class encapsulates the Adobe Image SDK photo editor. Present this view controller to provide the user with a fast and powerful image editor. Be sure that you don’t forget to set the delegate property to an object that conforms to the AdobeUXImageEditorViewControllerDelegate protocol.

Properties

)

An AdobeImageEditorSession instance that tracks user actions within the photo editor. This can be used for high-resolution processing. Usage of this property for generating high resolution output has been deprecated in favor of the enqueueHighResolutionRenderWithImage:maximumSize:completion: and enqueueHighResolutionRenderWithImage:completion: methods.

@property (nonatomic, strong, readonly) AdobeImageEditorSession *DEPRECATED_MSG_ATTRIBUTE ( "This property has been deprecated for high resolution output " "in favor of -enqueueHighResolutionRenderWithImage:completion." )

Discussion

An AdobeImageEditorSession instance that tracks user actions within the photo editor. This can be used for high-resolution processing. Usage of this property for generating high resolution output has been deprecated in favor of the enqueueHighResolutionRenderWithImage:maximumSize:completion: and enqueueHighResolutionRenderWithImage:completion: methods.

Declared In

AdobeUXImageEditorViewController+Compatibility.h

delegate

The photo editor’s delegate.

@property (nonatomic, weak, nullable) id<AdobeUXImageEditorViewControllerDelegate> delegate

Discussion

The photo editor’s delegate.

Declared In

AdobeUXImageEditorViewController.h

isImageModified

Returns whether any edits have been applied to the inputted image.

@property (nonatomic, assign, readonly) BOOL isImageModified

Discussion

Returns whether any edits have been applied to the inputted image.

Declared In

AdobeUXImageEditorViewController.h

Class Methods

inAppPurchaseManager

The handler object for purchasing consumable content. In order for in-app purchase to function correctly, you must add the object returned by this method as an observer of the default SKPaymentQueue. In your app delegate’s -finishedLaunchingWithOptions: method, you should call startObservingTransactions on the in app purchase manager.

+ (id<AdobeImageEditorInAppPurchaseManager>)inAppPurchaseManager

Return Value

The manager.

Discussion

The handler object for purchasing consumable content. In order for in-app purchase to function correctly, you must add the object returned by this method as an observer of the default SKPaymentQueue. In your app delegate’s -finishedLaunchingWithOptions: method, you should call startObservingTransactions on the in app purchase manager.

Please see the iOS SDK In-App Purchase Guide for more information about in-app purchases.

Declared In

AdobeUXImageEditorViewController+InAppPurchase.h

setPremiumAddOns:

This method is provided purely for compatibility with the legacy Aviary SDK. Calls to this API have no effect. High resolution output is now free for all SDK integrations. White labelling is no longer offered in the Creative SDK.

+ (void)setPremiumAddOns:(AdobeImageEditorPremiumAddOn)premiumAddOns

Parameters

premiumAddOns

bitmask of the add-ons to enable

Discussion

This method is provided purely for compatibility with the legacy Aviary SDK. Calls to this API have no effect. High resolution output is now free for all SDK integrations. White labelling is no longer offered in the Creative SDK.

Declared In

AdobeUXImageEditorViewController+Compatibility.h

Instance Methods

enqueueHighResolutionRenderWithImage:completion:

Replays all actions made in the generating AdobeUXImageEditorViewController on the provided image.

- (id<AdobeImageEditorRender>)enqueueHighResolutionRenderWithImage:(UIImage *)image completion:(AdobeImageEditorRenderCompletion)completion

Parameters

image

The image to replay the edits on.

completion

The block to be called when the image’s render is complete.

Discussion

Replays all actions made in the generating AdobeUXImageEditorViewController on the provided image.

The completion block will be called when the render has finished and the result parameter will contain the edited image. If the user pressed “Cancel” or took no actions before pressing “Done”, the result UIImage in the completion block will be nil and the appropriate error parameter will be provided. If the render is cancelled by developer action, then the completion block will be called with a nil result parameter and the appropriate error parameter.

Warning: Calling this method from any thread other in the main thread may result in undefined behavior.

Declared In

AdobeUXImageEditorViewController.h

enqueueHighResolutionRenderWithImage:maximumSize:completion:

Replays all actions made in the generating AdobeUXImageEditorViewController on the provided image.

- (id<AdobeImageEditorRender>)enqueueHighResolutionRenderWithImage:(UIImage *)image maximumSize:(CGSize)maxSize completion:(AdobeImageEditorRenderCompletion)completion

Parameters

image

The image to replay the edits on.

maxSize

The size to resize the input image to before replaying edits on it.

completion

The block to be called when the image’s render is complete.

Discussion

Replays all actions made in the generating AdobeUXImageEditorViewController on the provided image.

The provided image will be resized to fit within the maxSize parameter provided before any edits are performed.

The completion block will be called when the render has finished and the result parameter will contain the edited image. If the user pressed “Cancel” or took no actions before pressing “Done”, the result UIImage in the completion block will be nil and the appropriate error parameter will be provided. If the render is cancelled by developer action, then the completion block will be called with a nil result parameter and the appropriate error parameter.

Warning: Calling this method from any thread other in the main thread may result in undefined behavior.

Declared In

AdobeUXImageEditorViewController.h

initWithImage:

Initialize the photo editor controller with an image.

- (instancetype)initWithImage:(UIImage *)image

Parameters

image

The image to edit.

Discussion

Initialize the photo editor controller with an image.

Declared In

AdobeUXImageEditorViewController.h