写在前面

喜欢AVFoundation资料的同学可以关注我的专题:《AVFoundation》专辑
也可以关注我的简书账号

正文

AVAssetImageGenerator提供asset的缩略图或预览图像，该功能与Playback无关。

数据结构

AVAssetImageGenerator数据结构如下：

AVAssetImageGenerator

AVAssetImageGeneratorApertureMode

光圈模式的类型。
主要包括如下选项：

AVF_EXPORT AVAssetImageGeneratorApertureMode const AVAssetImageGeneratorApertureModeCleanAperture NS_AVAILABLE(10_7, 4_0);

属性名	AVAssetImageGeneratorApertureModeCleanAperture
解释	将应用像素长宽比和透明光圈。
备注	图像的clean aperture是视频区域，由于没有由信号编码引起的过渡artifacts。

AVF_EXPORT AVAssetImageGeneratorApertureMode const AVAssetImageGeneratorApertureModeProductionAperture NS_AVAILABLE(10_7, 4_0);

属性名	AVAssetImageGeneratorApertureModeProductionAperture
解释	仅应用像素长宽比。
备注	图像不会裁剪到透明的光圈区域，但会根据像素长宽比进行缩放。如果要查看视频中的所有像素（包括边缘），请使用此选项。

AVF_EXPORT AVAssetImageGeneratorApertureMode const AVAssetImageGeneratorApertureModeEncodedPixels NS_AVAILABLE(10_7, 4_0);

属性名	AVAssetImageGeneratorApertureModeEncodedPixels
解释	不会应用像素长宽比和透明光圈。
备注	图像不会被裁剪到透明的光圈区域，并且不会根据像素长宽比进行缩放。显示图像描述的编码尺寸。

AVAssetImageGeneratorResult

结果有如下三种选项：

• AVAssetImageGeneratorSucceeded（成功）
• AVAssetImageGeneratorFailed（失败）
• AVAssetImageGeneratorCancelled（取消）

AVAssetImageGenerator

@property (nonatomic, readonly) AVAsset *asset NS_AVAILABLE(10_9, 6_0);

指示初始化 AVAssetImageGenerator的AVAsset实例。

@property (nonatomic) BOOL appliesPreferredTrackTransform;

指定在从asset中提取图像时是否应用track的preferredTransform（AVAssetTrack preferredTransform中会有详细说明）。
默认为NO。仅支持旋转90度，180度或270度。

@property (nonatomic) CGSize maximumSize;

指定生成的图像的最大尺寸。默认（CGSizeZero）是asset的未缩放尺寸。

AVAssetImageGenerator将缩放图像，使其适合定义的边界框。
图像永远不会放大。缩放图像的宽高比将由apertureMode属性定义。

@property (nonatomic, readonly, nullable) id <AVVideoCompositing> customVideoCompositor NS_AVAILABLE(10_9, 7_0);

表示使用的自定义视频合成器实例（如果有的话）

@property (nonatomic) CMTime requestedTimeToleranceBefore NS_AVAILABLE(10_7, 5_0);
@property (nonatomic) CMTime requestedTimeToleranceAfter NS_AVAILABLE(10_7, 5_0);

生成的图像的实际时间将在[requestedTime-toleranceBefore，requestedTime + toleranceAfter]范围内，并且可能与请求的效率时间不同。

通过kCMTimeZero for toleranceBefore和toleranceAfter请求帧精确图像生成;这可能会导致额外的解码延迟。

默认值是kCMTimePositiveInfinity。

+ (instancetype)assetImageGeneratorWithAsset:(AVAsset *)asset;

函数名	assetImageGeneratorWithAsset:
解释	返回AVAssetImageGenerator的实例以与指定的asset一起使用。
参数	asset: 将从中提取图像的asset。
返回值	返回AVAssetImageGenerator的一个实例
备注	即使asset在初始化时没有视觉tracks，该方法也可能成功。 客户端可能希望测试资产是否具有具有视觉特征的轨道- [AVAsset tracksWithMediaCharacteristic：]。 注意，属于AVAsset，AVMutableComposition或AVMutableMovie的可变子类的asset可能会在初始化关联的AVAssetImageGenerator后获得可视轨迹。 但是，如果在生成图像时发生asset突变，则图像生成的结果是不确定的。 AVAssetImageGenerator将使用默认启用的视频轨道来生成图像。

- (instancetype)initWithAsset:(AVAsset *)asset NS_DESIGNATED_INITIALIZER;

函数名	initWithAsset:
解释	初始化AVAssetImageGenerator的实例以与指定的asset一起使用。
参数	asset: 将从中提取图像的asset。
返回值	返回一个AVAssetImageGenerator的实例
备注	即使asset在初始化时没有视觉轨迹，该方法也可能成功。 客户端可能希望通过以下方式测试asset是否具有具有视觉特征的轨迹- [AVAsset tracksWithMediaCharacteristic：]。 注意，属于AVAsset，AVMutableComposition或AVMutableMovie的可变子类的asset可能会在初始化关联的AVAssetImageGenerator后获得可视轨迹。 但是，如果在生成图像时发生asset突变，则图像生成的结果是不确定的。 AVAssetImageGenerator将使用默认启用的视频轨道来生成图像。

- (nullable CGImageRef)copyCGImageAtTime:(CMTime)requestedTime actualTime:(nullable CMTime *)actualTime error:(NSError * _Nullable * _Nullable)outError CF_RETURNS_RETAINED;

函数名	copyCGImageAtTime:actualTime:error:
解释	返回指定时间或附近的asset的CFRetained CGImageRef。
参数	requestedTime: 创建asset图像的时间。 actualTime: 指向CMTime的指针，用于接收实际生成图像的时间。 在此信息中，传递NULL。 outError: 如果此方法返回NULL，则描述失败原因的错误对象。
返回值	返回CGImageRef类型的对象
备注	同步返回CGImage。所有权遵循创建规则。

typedef void (^AVAssetImageGeneratorCompletionHandler)(CMTime requestedTime, CGImageRef _Nullable image, CMTime actualTime, AVAssetImageGeneratorResult result, NSError * _Nullable error);

如果结果是AVAssetImageGeneratorFailed，则错误对象指示失败的原因。

- (void)generateCGImagesAsynchronouslyForTimes:(NSArray<NSValue *> *)requestedTimes completionHandler:(AVAssetImageGeneratorCompletionHandler)handler;

函数名	generateCGImagesAsynchronouslyForTimes:completionHandler:
解释	返回指定时间或附近的资产的一系列CGImageRefs。
参数	requestedTimes: NSValues的NSArray，每个都包含CMTime，指定请求图像的asset时间。 handler: 图像请求完成时将调用的block。
备注	采用有效的“批处理模式”，按时间顺序获取图像。 客户端将在requestedTimes中为每个请求的时间收到一个处理程序回调。 对生成器属性的更改（快照行为，最大大小等...）不会影响未完成的异步映像生成请求。 生成的图像不会保留。如果客户希望在完成处理程序返回后保留图像，则客户端应保留该图像。

- (void)cancelAllCGImageGeneration;

函数名	cancelAllCGImageGeneration
解释	取消所有未完成的图像生成请求。
备注	在以前每次调用-generateCGImagesAsynchronouslyForTimes：completionHandler：为尚未提供图像的每个图像时间调用带有AVAssetImageGeneratorCancelled的处理程序block。

上一章	目录	下一章