- 父类:NSObject
提供获取或生成预览缩略图和全尺寸图片,或者视频数据的方法。
一、概述
使用这些方法来获取全尺寸图片资源或缩略图,或者获取AV Foundation
对象来播放、输出、控制视频资源。
加载图片或视频数据:
- 使用PHAsset类来获取你想要的资源。
- 调用
+ (PHImageManager *)defaultManager;
方法来获取图片管理单例对象。 - 使用“请求图片”和“请求视频对象”中的方法来加载资源的图片或视频数据。
图片管理器会缓存它提供过的图像和数据,所以之后向同一个资源请求同样的参数会很快速的返回。
如果你需要同时加载很多资源的图片数据,如果你想要很快速的加载图片请使用PHCachingImageManager预加载缓存。例如,你在一个展示资源的视图中想要使用缩略图填充,你可以在滚动到位置之前提前缓冲。
二、内容
1. 获得图片管理器
+ (PHImageManager *)defaultManager;
获得图片管理器单例。
2. 请求图片
- (PHImageRequestID)requestImageForAsset:(PHAsset *)asset targetSize:(CGSize)targetSize contentMode:(PHImageContentMode)contentMode options:(nullable PHImageRequestOptions *)options resultHandler:(void (^)(UIImage *__nullable result, NSDictionary *__nullable info))resultHandler;
- asset PHAsset - 要获取的资源。
- targetSize CGSize - 想要获取的图片的大小。
- contentMode PHImageContentMode - 图片的大小与纵横比的关系。
- options PHImageRequestOptions - 告诉Photos如何处理请求,如何格式化图片,并且通知你的应用处理过程和错误。
- resultHandler block - 加载完成图片后被调用。
- result UIImage - 获取到的图片
- info NSDictionary - 关于请求状态的信息。查看Image Result Info Keys获取可能出现的键合值。
获取给定资源的图片。
当你调用这个方法,Photos会加载或生成一个和你给定的大小一样或接近的图片。然后,它会调用你的resultHandler
回调来返回这张图片。为了更快速的反应你的请求,Photos可能会提供一个略大于给定大小的图片——因为这张图片可能已经被缓存或者可以更有效率的生成这张图片。根据你给定的options
以及资源的当前状态,Photos可能会从网络下载这个资源的数据。
默认情况下这个方法是异步执行的。如果你在后台的线程中调用这个方法,那么你可能需要改变options
参数中的synchronous
属性为YES
以阻塞线程,直到图片被准备好或者发生错误,这个时候Photos会调用你的resultHandler
。
对于一个异步请求,Photos可能会不止一次的调用你的resultHandler
回调。Photos第一次调用回调会提供一个合适的低质量图片作为临时展示,然后它会去准备一个高质量的图片。(如果低质量的图片立刻可以返回,那么第一次调用回调可能在方法返回一个返回值之前调用。)当高质量的图片准备好,Photos会再次调用你的resultHandler
来提供这张图片。如果图片管理器已经缓存了请求的图片的全质量图片,Photos只会调用一次你的resultHandler
。当Photos提供一个临时的低质量图片的时候,resultHandler
中的info
参数中的PHImageResultIsDegradedKey
键会标示。
你可以使用这个方法获取照片和视频资源——对于一个视频资源,一个图片请求将提供一个缩略图或者关键帧。
PHImageContentMode
typedef NS_ENUM(NSInteger, PHImageContentMode) {
PHImageContentModeAspectFit = 0, // 缩放图像,用更大的尺寸填充给定的目标尺寸。
PHImageContentModeAspectFill = 1, // 缩放图像,使其完全填充给定的目标尺寸。
PHImageContentModeDefault = PHImageContentModeAspectFit // 默认,PHImageContentModeAspectFit
} PHOTOS_ENUM_AVAILABLE_IOS_TVOS(8_0, 10_0);
- (PHImageRequestID)requestImageDataForAsset:(PHAsset *)asset options:(nullable PHImageRequestOptions *)options resultHandler:(void(^)(NSData *__nullable imageData, NSString *__nullable dataUTI, UIImageOrientation orientation, NSDictionary *__nullable info))resultHandler;
- asset PHAsset - 要获取的资源。
- options PHImageRequestOptions - 告诉Photos如何处理请求,如何格式化图片,并且通知你的应用处理过程和错误。
- resultHandler block - 加载完成图片后被调用。
- imageData NSData - 获取到的图片数据。
- dataUTI NSString - 请求的图片。
- orientation UIImageOrientation - 图片的想要展示的方向。
- info NSDictionary - 关于请求状态的信息。查看Image Result Info Keys获取可能出现的键合值。
获取给定资源的全尺寸图片。
当你调用这个方法,Photos加载这个图片资源的最大的表现形式,然后会调用你的resultHandler
回调来提供这个数据。根据你给定的options
以及资源的当前状态,Photos可能会从网络下载这个资源的数据。
默认情况下这个方法是异步执行的。如果你在后台的线程中调用这个方法,那么你可能需要改变options
参数中的synchronous
属性为YES
以阻塞线程,直到图片被准备好或者发生错误,这个时候Photos会调用你的resultHandler
。这个方法忽略deliveryMode
选项——Photos只会调用一次你的resultHandler
。
如果version
选项被设置为PHImageRequestOptionsVersionCurrent
,Photos将会提供渲染的图片数据,包含了所有对资源内容的编辑结果。否则,Photos将会提供资源的最原始图像。
3. 请求视频对象
- (PHImageRequestID)requestPlayerItemForVideo:(PHAsset *)asset options:(nullable PHVideoRequestOptions *)options resultHandler:(void (^)(AVPlayerItem *__nullable playerItem, NSDictionary *__nullable info))resultHandler;
- asset PHAsset - 要播放的视频资源。
- options PHVideoRequestOptions - 告诉Photos如何处理请求,并且通知你的应用处理过程和错误。
- resultHandler block - 加载资源数据后被调用。
- playerItem AVPlayerItem - 获取到的视频数据。
- info NSDictionary - 关于请求状态的信息。查看Image Result Info Keys获取可能出现的键合值。
获取要播放的视频资源的表现形式,将被异步加载。
当你调用这个方法,Photos会下载这个视频数据(如果需要的话)并且创建一个播放项。然后调用你的resultHandler
回调来提供请求获取的视频。
当你想要简单的播放存在的视频资源请使用这个方法。对于更多的选项详细信息或者使用资源的音频和视频轨道工作,则使用- (PHImageRequestID)requestAVAssetForVideo:(PHAsset *)asset options:(PHVideoRequestOptions *)options resultHandler:(void (^)(AVAsset *asset, AVAudioMix *audioMix, NSDictionary *info))resultHandler;
方法。
- (PHImageRequestID)requestExportSessionForVideo:(PHAsset *)asset options:(nullable PHVideoRequestOptions *)options exportPreset:(NSString *)exportPreset resultHandler:(void (^)(AVAssetExportSession *__nullable exportSession, NSDictionary *__nullable info))resultHandler;
- asset PHAsset - 将要被创建导出会话的视频资源。
- options PHVideoRequestOptions - 告诉Photos如何处理请求,并且通知你的应用处理过程和错误。
- exportPreset NSString - 要导出的资源的导出预设名。请查看AVAssetExportSession。
- resultHandler block - 加载资源数据并且准备导出会话后被调用。
- exportSession AVAssetExportSession - 使用这个将视频资源数据写入文件
- info NSDictionary - 关于请求状态的信息。查看Image Result Info Keys获取可能出现的键合值。
获取一个将视频资源的数据写入文件的导出会话,将被异步加载。
当你调用这个方法,Photos会下载这个视频数据(如果需要的话)并且创建一个导出会话。然后调用你的resultHandler
回调来提供请求获取的视频。
对于额外的导出选项,使用- (PHImageRequestID)requestAVAssetForVideo:(PHAsset *)asset options:(PHVideoRequestOptions *)options resultHandler:(void (^)(AVAsset *asset, AVAudioMix *audioMix, NSDictionary *info))resultHandler;
方法并且创建AVAssetReader和AVAssetWriter对象来转换和输出视频资源数据。
- (PHImageRequestID)requestAVAssetForVideo:(PHAsset *)asset options:(nullable PHVideoRequestOptions *)options resultHandler:(void (^)(AVAsset *__nullable asset, AVAudioMix *__nullable audioMix, NSDictionary *__nullable info))resultHandler;
- asset PHAsset - 将要被加载的视频资源。
- options PHVideoRequestOptions - 告诉Photos如何处理请求,并且通知你的应用处理过程和错误。
- resultHandler block - 加载资源数据后被调用。
- asset AVAsset - 提供了访问视频资源轨道和数据的对象。关于AVAsset对象的更详细内容请查看AVFoundation Programming Guide。
- audioMix AVAudioMix - 使用这个对象可以重新排列资源的音频轨道,编辑在组合中的附加音频,或者配置用来输出资源音频数据的AVAssetReaderOutput对象。如果这个参数为
nil
,那么这个资源使用的是默认音频组合。 - info NSDictionary - 关于请求状态的信息。查看Image Result Info Keys获取可能出现的键合值。
请求代表了视频资源内容和状态的AV Foundation
对象,将被异步加载。
当你调用这个方法,Photos会下载这个视频数据(如果需要的话)并且创建一个AV Foundation
对象。然后调用你的resultHandler
回调来提供请求获取的视频。
当你想要使用一个资源内容的音频和视频轨道工作请使用这个方法。如果你只想要播放资源,请使用- (PHImageRequestID)requestPlayerItemForVideo:(PHAsset *)asset options:(PHVideoRequestOptions *)options resultHandler:(void (^)(AVPlayerItem *playerItem, NSDictionary *info))resultHandler;
方法。如果你想要导出资源数据,请调用- (PHImageRequestID)requestExportSessionForVideo:(PHAsset *)asset options:(PHVideoRequestOptions *)options exportPreset:(NSString *)exportPreset resultHandler:(void (^)(AVAssetExportSession *exportSession, NSDictionary *info))resultHandler;
方法。
4. 请求Live Photos
- (PHImageRequestID)requestLivePhotoForAsset:(PHAsset *)asset targetSize:(CGSize)targetSize contentMode:(PHImageContentMode)contentMode options:(nullable PHLivePhotoRequestOptions *)options resultHandler:(void (^)(PHLivePhoto *__nullable livePhoto, NSDictionary *__nullable info))resultHandler;
从给定资源中获取Live Photos。
一张Live Photo是一张图片,只有支持的设备才可以拍摄,它包含了捕捉之前和之后时刻的动作和声音。就像一个UIImage
对象代表了一张随时可用的图片,一个PHLivePhoto对象代表了一个准备展示的图片、声音、动作数据的Live Photo。使用这个方法获取资源中的Live Photo,获取之后Photos会调用你的resultHandler
回调来返回这个Live Photo,你可以使用PHLivePhotoView来展示Live Photo。
注意
当你要展示Live Photo的动作和声音内容时使用这个方法。如果你只想展示Live Photo资源的静止图片——例如,当在照片选择界面加载缩略图来展示时——请使用- (PHImageRequestID)requestImageForAsset:(PHAsset *)asset targetSize:(CGSize)targetSize contentMode:(PHImageContentMode)contentMode options:(PHImageRequestOptions *)options resultHandler:(void (^)(UIImage *result, NSDictionary *info))resultHandler;
方法。
当你调用这个方法,Photos会加载或生成一个和你提供的大小相近或相等大小的PHLivePhoto对象。然后调用你的resultHandler
回调提供这个图片。为了更快速的反应你的请求,Photos可能会提供一个略大于给定大小的图片——因为这张图片可能已经被缓存或者可以更有效率的生成这张图片。根据你给定的options
以及资源的当前状态,Photos可能会从网络下载这个资源的数据。此方法总是异步执行。
Photos可能会不止一次的调用你的resultHandler
回调。Photos第一次调用回调会提供一个合适的低质量图片作为临时展示,然后它会去准备一个高质量的图片。(如果低质量的图片立刻可以返回,那么第一次调用回调可能在方法返回一个返回值之前调用。)当高质量的图片准备好,Photos会再次调用你的resultHandler
来提供这张图片。如果图片管理器已经缓存了请求的图片的全质量图片,Photos只会调用一次你的resultHandler
。当Photos提供一个临时的低质量图片的时候,resultHandler
中的info
参数中的PHImageResultIsDegradedKey
键会被标示。
5. 取消一个请求
- (void)cancelImageRequest:(PHImageRequestID)requestID;
取消一个异步请求。
当你使用- (PHImageRequestID)requestImageForAsset:(PHAsset *)asset targetSize:(CGSize)targetSize contentMode:(PHImageContentMode)contentMode options:(PHImageRequestOptions *)options resultHandler:(void (^)(UIImage *result, NSDictionary *info))resultHandler;
方法执行一个异步请求来请求图片数据,或者对一个视频对象使用上面的“请求视频对象”中的方法,图片管理器都会返回一个对应该请求的数字标识。想要在请求完成之前取消,请调用该方法并传入对应的数字标识。