iOS PHLivePhotoView

一个PHLivePhotoView对象是一个展示一个Live Photo的视图。

一、概述

获取一个PHLivePhoto对象之后，使用一个Live Photo视图来展示这个照片并且控制播放它的动作和声音内容。在iOS和tvOS中，你可以使用UIImagePickerController或者PHAsset以及PHImageManager类或者通过创建一个从照片库中导出的资源来从照片库中获取Live Photo对象。在MacOS中，Live Photo对象只在运行Photos应用中的一个照片编辑扩展中编辑Live Photo的内容时有效。——查看PHContentEditingInput类在编辑会话中获取Live Photo内容。

注意
关于如何将Live Photo和你的应用的用户体验整合到一起，请查看iOS Human Interface Guidelines中的Live Photos。

默认情况下，一个Live Photo视图使用它自己的手势识别器来允许用户播放一个Live Photo中的动作和声音内容，交互以及视觉效果和Photos应用中的一样。想要自定义这个手势识别器——例如，想要在一个不同视图中安装它来适当的处理你的应用的视图层级事件——使用playbackGestureRecognizer属性。

通常情况下，一个应用不需要直接控制Live Photo的播放。在某些情况下，它可以使用一个简短的动画来标示用户这个图片是一个Live Photo。想要这样做，使用- (void)startPlaybackWithStyle:(PHLivePhotoViewPlaybackStyle)playbackStyle;方法并传入PHLivePhotoViewPlaybackStyleHint类型参数。

提示
想要在网页上展示Live Photo的内容，请使用LivePhotosKit JS框架。

二、内容

1. 选择一个Live Photo来展示

@property(readwrite, nonatomic, strong) PHLivePhoto *livePhoto;

视图中展示的Live Photo。

2. 播放管理

@property(readonly, nonatomic, strong) UIGestureRecognizer *playbackGestureRecognizer;

一个控制视图中Live Photo播放的点手势识别器。

Live Photo视图自动创建并安装这个手势识别器。使用这个属性来自定义手势识别器的行为。例如，你可以用它在代理方法中影响他如何同其他手势识别器交互，或者安装他在其他的视图中来确保在你的应用的视图层级中适当的处理事件。

@property(readwrite, nonatomic, assign, getter=isMuted) BOOL muted;

是否禁止播放Live Photo的音频内容。

这个属性的默认值为NO，表示视图会随着Live Photo的动作播放音频内容。这个属性的值变为YES则表示会播放动作但是不会播放音频。

@property(readwrite, nonatomic, assign) float audioVolume;

Live Photo的动作内容播放时的声音大小。

这个属性的值必须在0.0到1.0之间。这个值为1.0时（默认值）将以最大音量（相对于系统音量的最大音量）来播放Live Photo的音频。这个值为0.0时相当于设置muted属性为YES。

3. 响应播放事件

@property(readwrite, nonatomic, weak) id delegate;

当Live Photo开始播放或结束播放时通知的对象。

4. 手动播放Live Photo内容

- (void)startPlaybackWithStyle:(PHLivePhotoViewPlaybackStyle)playbackStyle;

在视图中开始播放Live Photo的内容。

使用playbackStyle属性来选择播放Live Photo的整个动作和声音内容还是只播放简短的一部分。

通常情况下，一个应用不需要直接控制播放，因为一个Live Photo视图提供交互式播放控制。当没有恰当的交互播放时使用这个方法——例如，一个简短的动画表明一个视图的内容是一个Live Photo。

PHLivePhotoViewPlaybackStyle

typedef NS_ENUM(NSInteger, PHLivePhotoViewPlaybackStyle) {
    PHLivePhotoViewPlaybackStyleUndefined = 0, // 这个值对用户无效
    PHLivePhotoViewPlaybackStyleFull, // 播放Live Photo的整个动作和声音内容，包括开始和结束的过渡效果。
    PHLivePhotoViewPlaybackStyleHint, // 只播放Live Photo的一段简短的动作内容，没有声音。
} PHOTOS_ENUM_AVAILABLE_IOS_TVOS(9_1, 10_0);

- (void)stopPlayback;

结束在视图中播放的Live Photo内容。

5. 获取Live Photo的用户界面图标

+ (UIImage *)livePhotoBadgeImageWithOptions:(PHLivePhotoBadgeOptions)badgeOptions;

返回给定的Live Photo语义选项的图片图像。

使用这个方法为用户填充Live Photo界面元素来获取图标图像。例如，你可以使用这个方法获取的图标在自一个自定义资源浏览器界面来标示出那个资源是Live Photo而不是普通静态图像，或者标示用户选择分享一个带有还是不带有动作和声音内容的Live Photo。

默认情况下，这个方法返回一个适合用作模版图像的纯色图像，你可以在特定背景下对其着色并显示。（使用UIImage类创建模版图像。）当你计划使用动起来的Live Photo内容覆盖图标时，添加PHLivePhotoBadgeOptionsOverContent选项来获取一个图像（不适用于模版使用）提供额外的背景对比。

typedef NS_OPTIONS(NSUInteger, PHLivePhotoBadgeOptions) {
    PHLivePhotoBadgeOptionsOverContent  = 1 << 0, // 返回一个标示不选择动作和声音内容的图标
    PHLivePhotoBadgeOptionsLiveOff      = 1 << 1, // 返回一个标示Live Photo的变量图标
} PHOTOS_ENUM_AVAILABLE_IOS_TVOS(9_1, 10_0);

@property(readonly, nonatomic, strong) NSView *livePhotoBadgeView;

一个展示Live Photo状态的视图。

PHLivePhotoView使用这个子视图来展示图标，这个图标标示了Live Photo内容是否存在或者状态。Photos管理在badge view上展示的内容，所以你不需要对这个视图的内容做任何事情——相反，这个属性提供访问badge view，所以如果需要的话你可以改变它在你的视图中的显示层级。例如，如果你在一个scroll view中展示一个Live Photo视图，你可以移动这个badge view以便于scroll view滑动时保持它的位置不动。