Class

PHLivePhotoView

A view that displays a Live Photo—a picture that also includes motion and sound from the moments just before and after its capture.

Declaration

iOS, Mac Catalyst, tvOS

@interface PHLivePhotoView : UIView

macOS

@interface PHLivePhotoView : NSView

Overview

Use a Live Photo view to display the photo and control playback of its motion and sound content. In iOS and tvOS, you can obtain Live Photo objects from the Photos library, using the UIImagePickerController or PHAsset and PHImageManager classes, or by creating one from asset resources exported from a Photos library. In macOS, Live Photo objects are available only when editing Live Photo content in a photo editing extension that runs in the Photos app—see the PHContentEditingInput class to access Live Photo content in an editing session.

By default, a Live Photo view uses its own gesture recognizer to allow the user to play the motion and sound content of a Live Photo with the same interactions and visual effects seen in the Photos app. To customize this gesture recognizer—for example, to install it on a different view for proper event handling in your app’s view hierarchy—use the playbackGestureRecognizer property.

To animate the view briefly to hint that a picture is a Live Photo, use the startPlaybackWithStyle: method with the PHLivePhotoViewPlaybackStyleHint option.

Topics

Choosing a Live Photo to Display

livePhoto

The Live Photo displayed in the view.

Managing Playback

playbackGestureRecognizer

A gesture recognizer that controls playback of the Live Photo in the view.

muted

A Boolean value that determines whether the view plays the audio content of its Live Photo.

audioVolume

The audio gain to apply to the Live Photo’s movie content during playback.

Responding to Playback Events

delegate

An object to be notified when Live Photo playback begins or ends.

PHLivePhotoViewDelegate

The PHLivePhotoViewDelegate protocol describes messages sent by a PHLivePhotoView instance in response to playback events when playing the motion and sound content associated with a Live Photo. To receive these messages, implement the methods in this protocol in one of your controller objects and assign that object to the delegate property of a Live Photo view.

Manually Playing Live Photo Content

- startPlaybackWithStyle:

Begins playback of Live Photo content in the view.

- stopPlayback

Ends playback of Live Photo content in the view.

- stopPlaybackAnimated:

Accessing User Interface Icons for Live Photos

+ livePhotoBadgeImageWithOptions:

Returns an icon image for the specified Live Photo semantic options.

livePhotoBadgeView

A view for displaying Live Photo status.

Setting the Content Mode

contentMode

PHLivePhotoViewContentMode

Constants

PHLivePhotoViewPlaybackStyle

Options for how much of the motion and sound content of a Live Photo to play, used in the startPlaybackWithStyle: method and in messages to the view’s delegate object.

PHLivePhotoBadgeOptions

Options for the semantic use and display style of icons for badging Live Photo assets, used by the livePhotoBadgeImageWithOptions: method.

Relationships

Inherits From

NSView
,
UIView