Class

PHContentEditingOutput

A container to which you provide the results of editing the photo, video, or Live Photo content of a Photos asset.

Declaration

class PHContentEditingOutput : NSObject

Overview

To edit an asset’s photo or video content:

  1. Fetch a PHAsset object that represents the photo or video to be edited.

  2. Call the asset’s requestContentEditingInput(with:completionHandler:) method to retrieve a PHContentEditingInput object. This object provides information about the asset, the asset data to be edited, and a preview image for display.

  3. Apply your edits to the asset. To allow a user to continue working with the edit later (for example, to adjust the parameters of a photo filter), create a PHAdjustmentData object describing the changes.

  4. Initialize a PHContentEditingOutput object. For photo- or video-only assets, provide the edited content with the renderedContentURL property. For Live Photo assets, create a PHLivePhotoEditingContext object to edit the Live Photo content and pass your content editing output to the saveLivePhoto(to:options:completionHandler:) method.

    For all asset types, provide your adjustment data with the adjustmentData property of the content editing output.

  5. Use a photo library change block to commit the edit. (For details, see PHPhotoLibrary.) In the block, create a PHAssetChangeRequest object and set its contentEditingOutput property to the editing output that you created.

    Each PHPhotoLibraryperformChanges call prompts the user for permission to edit the contents of the photo library—to edit multiple assets in one batch, create multiple PHAssetChangeRequest objects within the same change block, each with its own corresponding PHContentEditingOutput object.

You can also edit assets from photo editing extensions. In this case, instead of working with a PHAsset object, you implement methods in the PHContentEditingController protocol. Photos provides a PHContentEditingOutput object when your extension begins editing. When editing is complete, Photos requests a PHContentEditingOutput object that contains the edited asset content.

Topics

Creating an Output Object to Edit an Existing Asset

init(contentEditingInput: PHContentEditingInput)

Creates an editing output from the specified editing input.

Creating an Output Object to Edit a Newly Created Asset

init(placeholderForCreatedAsset: PHObjectPlaceholder)

Creates an editing output for use in adding a new asset to the photo library.

Providing Edit and Adjustment Data

var adjustmentData: PHAdjustmentData?

An object describing the changes made to the asset.

var renderedContentURL: URL

The URL at which to write a file containing edited asset content.

Relationships

Inherits From

Conforms To

See Also

Editing an Asset

Editing Asset Content

Make a request to modify and save a photo or video asset.

class PHContentEditingInput

A container that provides information about and access to the image, video, or Live Photo content of an asset to be edited.

class PHAdjustmentData

A description of the edits made to an asset's photo, video, or Live Photo content, which allows your app to reconstruct or revert the effects of prior editing sessions.

class PHContentEditingInputRequestOptions

A set of options affecting the delivery of image or video data when you request to edit the content of a Photos asset.

class PHLivePhotoEditingContext

An editing session for modifying the photo, video, and audio content of a Live Photo.

protocol PHLivePhotoFrame

A container that provides image content for a single frame of a Live Photo in an editing context.

func canPerform(PHAssetEditOperation) -> Bool

Returns whether the asset supports the specified editing operation.

enum PHAssetEditOperation

Values identifying possible actions an asset can support, used by the canPerform(_:) method.

func cancelContentEditingInputRequest(PHContentEditingInputRequestID)

Cancels a request for editing the asset’s content.

typealias PHContentEditingInputRequestID

An identifier for an asset content editing session.

Editing Request Info Keys

Keys indicating the status of an asset content editing request, used in the completion handler of the requestContentEditingInput(with:completionHandler:) method.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software