AVFoundation编程指南11-AVAsset缓存和下载
2019-05-17 本文已影响15人
张芳涛
写在前面
喜欢AVFoundation资料的同学可以关注我的专题:《AVFoundation》专辑
也可以关注我的简书账号
正文
本文所述结构图如下：
结构图
AVAsset缓存
AVAsset缓存需要AVAssetCache类来实现。
@property (nonatomic, readonly, getter=isPlayableOffline) BOOL playableOffline;
| 属性名称 | playableOffline |
|---|---|
| 解释 | 如果可以在没有网络连接的情况下播放AVAsset的完整再现，则返回YES。 |
| 备注 |
YES的答案并不表示任何给定的媒体选择可用于离线播放。要确定特定媒体选择是否可脱机使用，请参阅mediaSelectionOptionsInMediaSelectionGroup：。 |
- (NSArray<AVMediaSelectionOption *> *)mediaSelectionOptionsInMediaSelectionGroup:(AVMediaSelectionGroup *)mediaSelectionGroup;
返回AVMediaSelectionGroup中可用于脱机操作的AVMediaSelectionOptions数组，例如playback。
AVAssetDownloadStorageManager
AVAssetDownloadStorageManager管理自动清除下载的AVAssets的策略。该策略作为AVAssetDownloadStorageManagementPolicy对象提供。
需要在
asset上设置management策略时，需要获取sharedDownloadStorageManager单例。然后，可以使用setStorageManagementPolicy和下载asset的位置来设置新的策略。
typedef NSString *AVAssetDownloadedAssetEvictionPriority NS_STRING_ENUM API_AVAILABLE(ios(11.0)) API_UNAVAILABLE(macos, tvos, watchos);
AVAssetDownloadedAssetEvictionPriority字符串常量，由AVAssetDownloadStorageManagementPolicy使用。
AVF_EXPORT AVAssetDownloadedAssetEvictionPriority const AVAssetDownloadedAssetEvictionPriorityImportant API_AVAILABLE(ios(11.0)) API_UNAVAILABLE(macos, tvos, watchos);
AVF_EXPORT AVAssetDownloadedAssetEvictionPriority const AVAssetDownloadedAssetEvictionPriorityDefault API_AVAILABLE(ios(11.0)) API_UNAVAILABLE(macos, tvos, watchos);
| 枚举名称 | AVAssetDownloadedAssetEvictionPriority |
|---|---|
| 解释 | 这些常量表示下载asset的优先级。AVAssetDownloadedAssetEvictionPriorityImportant用于标记具有最高优先级的 asset。它们将会最后被清理。AVAssetDownloadedAssetEvictionPriorityDefault用于标记 asset具有默认优先级。它们将会最先被清理。 |
AVAssetDownloadStorageManager
+ (AVAssetDownloadStorageManager *)sharedDownloadStorageManager;
该函数会返回一个单例。
- (void)setStorageManagementPolicy:(AVAssetDownloadStorageManagementPolicy *)storageManagementPolicy forURL:(NSURL *)downloadStorageURL;
| 函数名称 | setStorageManagementPolicy: forURL |
|---|---|
| 解释 | 在downloadStorageURL中设置具有磁盘备份的asset的策略。 |
| 参数 |
downloadStorageURL:下载 asset的位置。 |
- (nullable AVAssetDownloadStorageManagementPolicy *)storageManagementPolicyForURL:(NSURL *)downloadStorageURL;
| 函数名 | storageManagementPolicyForURL:downloadStorageURL |
|---|---|
| 解释 | 返回downloadStorageURL下载的asset的存储管理策略。如果从未在下载的asset上设置storageManagementPolicy，则此值可能为nil。 |
| 参数 |
downloadStorageURL:下载 asset的位置。 |
AVAssetDownloadStorageManagementPolicy
@property (nonatomic, readonly, copy) AVAssetDownloadedAssetEvictionPriority priority;
| 属性名 | priority |
|---|---|
| 解释 | 表示下载asset的eviction优先级。 |
| 备注 | 具有默认优先级的asset将首先在具有较高优先级的asset之前清除。如果未设置，则使用默认优先级。 |
@property (nonatomic, readonly, copy) NSDate *expirationDate;
返回asset的过期时间。
AVMutableAssetDownloadStorageManagementPolicy
@property (nonatomic, copy) AVAssetDownloadedAssetEvictionPriority priority;
| 属性名称 | priority |
|---|---|
| 解释 | 表示下载asset的priority优先级。 |
| 备注 | 具有默认优先级的asset将首先在具有较高优先级的asset之前清除。如果未设置，则使用默认优先级。 |
@property (nonatomic, copy) NSDate *expirationDate;
返回asset的过期时间。
AVAssetDownloadTask
AVAssetDownloadTask是一个NSURLSessionTask，接受远程AVURLAssets在本地下载。
应使用- [AVAssetDownloadURLSession assetDownloadTaskWithURLAsset：assetTitle：assetArtworkData：options：]创建。要利用本地数据回放正在进行的下载，请重新使用初始化中提供的URLAsset。 AVAssetDownloadTask可以使用指向磁盘上现有asset的destinationURL进行实例化，以完成或扩充下载的asset。
AVF_EXPORT NSString *const AVAssetDownloadTaskMinimumRequiredMediaBitrateKey API_AVAILABLE(ios(9.0)) API_UNAVAILABLE(macos, tvos, watchos);
| key名称 | AVAssetDownloadTaskMinimumRequiredMediaBitrateKey |
|---|---|
| 解释 | 将选择大于或等于此值的最低媒体比特率。值应为bps中的NSNumber。如果未找到合适的媒体比特率，则将选择最高媒体比特率。此键的值应为 NSNumber。 |
| 备注 | 默认情况下，将选择最高媒体比特率进行下载。 |
AVF_EXPORT NSString *const AVAssetDownloadTaskMediaSelectionKey API_AVAILABLE(ios(9.0)) API_UNAVAILABLE(macos, tvos, watchos);
| Key名称 | AVAssetDownloadTaskMediaSelectionKey |
|---|---|
| 解释 | 此下载的媒体选择。 这个 Key的值应是AVMediaSelection。 |
| 备注 | 默认情况下，将自动选择AVAssetDownloadTask的媒体选择。 |
AVAssetDownloadTask
@property (nonatomic, readonly) AVURLAsset *URLAsset;
初始化时提供给下载任务的asset。
@property (nonatomic, readonly) NSURL *destinationURL NS_DEPRECATED_IOS(9_0, 10_0);
初始化时提供给下载任务的文件URL。
此
URL可能已附加了asset的相应扩展名。
@property (nonatomic, readonly, nullable) NSDictionary<NSString *, id> *options;
初始化时提供给下载任务的选项。
@property (nonatomic, readonly) NSArray<NSValue *> *loadedTimeRanges;
此属性提供下载任务已下载并可播放的媒体数据的时间范围集合。提供的范围可能是不连续的。
返回包含CMTimeRanges的NSValues的NSArray。
@property (readonly, copy) NSURLRequest *originalRequest NS_UNAVAILABLE;
@property (readonly, copy) NSURLRequest *currentRequest NS_UNAVAILABLE;
@property (readonly, copy) NSURLResponse *response NS_UNAVAILABLE;
NSURLRequest和NSURLResponse对象不适用于AVAssetDownloadTask。
AVAggregateAssetDownloadTask
@property (nonatomic, readonly) AVURLAsset *URLAsset;
初始化时提供给下载任务的asset。
@property (readonly, copy) NSURLRequest *originalRequest NS_UNAVAILABLE;
@property (readonly, copy) NSURLRequest *currentRequest NS_UNAVAILABLE;
@property (readonly, copy) NSURLResponse *response NS_UNAVAILABLE;
NSURLRequest和NSURLResponse对象不适用于AVAggregateAssetDownloadTask。
AVAssetDownloadDelegate代理方法
- (void)URLSession:(NSURLSession *)session assetDownloadTask:(AVAssetDownloadTask *)assetDownloadTask didFinishDownloadingToURL:(NSURL *)location NS_AVAILABLE_IOS(10_0);
| 函数名称 | URLSession:assetDownloadTask:didFinishDownloadingToURL: |
|---|---|
| 解释 | 已完成下载的下载任务时发送。 |
| 参数 |
session:asset下载任务所在的会话。assetDownloadTask:已下载完成的 AVAssetDownloadTask。location:asset已下载到的位置。 |
| 备注 | 与NSURLSessionDownloadDelegate不同，委托在调用文件后不应该从该目录移动该文件。下载的asset必须保留在系统提供的URL中。 URLSession：task：didCompleteWithError：仍将被调用。 |
- (void)URLSession:(NSURLSession *)session assetDownloadTask:(AVAssetDownloadTask *)assetDownloadTask didLoadTimeRange:(CMTimeRange)timeRange totalTimeRangesLoaded:(NSArray<NSValue *> *)loadedTimeRanges timeRangeExpectedToLoad:(CMTimeRange)timeRangeExpectedToLoad NS_AVAILABLE_IOS(9_0);
| 函数名称 | URLSession:assetDownloadTask:didLoadTimeRange:totalTimeRangesLoaded:timeRangeExpectedToLoad: |
|---|---|
| 解释 | 用于订阅AVAssetDownloadTask的进度更新的方法。 |
| 参数 |
session:asset下载任务所在的会话。assetDownloadTask:正在更新的 AVAssetDownloadTask。timeRange:一个 CMTimeRange，指示自上次调用此方法以来加载的时间范围。loadedTimeRanges:CMTimeRanges的NSValues的NSArray，指示此asset下载任务加载的所有时间范围。timeRangeExpectedToLoadz:CMTimeRange，指示下载完成时预期要加载的单个时间范围。 |
- (void)URLSession:(NSURLSession *)session assetDownloadTask:(AVAssetDownloadTask *)assetDownloadTask didResolveMediaSelection:(AVMediaSelection *)resolvedMediaSelection NS_AVAILABLE_IOS(9_0);
| 函数名称 | URLSession:assetDownloadTask:didResolveMediaSelection: |
|---|---|
| 解释 | 完全解析下载媒体选择时调用的方法，包括任何自动的选择。 |
| 参数 |
session:asset下载任务所在的会话。assetDownloadTask正在更新的 AVAssetDownloadTask。resolvedMediaSelection:已下载任务的已解析媒体选择。为了在没有进一步网络 I/O的情况下播放下载内容的最佳机会，请将此选择应用于后续AVPlayerItem。 |
- (void)URLSession:(NSURLSession *)session aggregateAssetDownloadTask:(AVAggregateAssetDownloadTask *)aggregateAssetDownloadTask willDownloadToURL:(NSURL *)location NS_AVAILABLE_IOS(11_0);
| 函数名称 | URLSession:aggregateAssetDownloadTask:willDownloadToURL: |
|---|---|
| 解释 | 聚合下载任务确定此asset将下载到的位置时调用的方法。 |
| 参数 |
session:聚合 asset下载任务所在的会话。aggregateAssetDownloadTask:AVAggregateAssetDownloadTask。location:此任务将文件 URL下载到的文件URL。 |
| 备注 | 应保存此URL以用于AVAsset的未来实例化。虽然此内容已存在AVAsset，但建议重新使用该实例。 |
- (void)URLSession:(NSURLSession *)session aggregateAssetDownloadTask:(AVAggregateAssetDownloadTask *)aggregateAssetDownloadTask didCompleteForMediaSelection:(AVMediaSelection *)mediaSelection NS_AVAILABLE_IOS(11_0);
| 函数名称 | URLSession:aggregateAssetDownloadTask:didCompleteForMediaSelection: |
|---|---|
| 解释 |
AVAssetDownloadTask子类完成时调用的方法。 |
| 参数 |
session:聚合 asset下载任务所在的会话。aggregateAssetDownloadTask:AVAggregateAssetDownloadTask。mediaSelection:AVMediaSelection现在完全可供离线使用。 |
- (void)URLSession:(NSURLSession *)session aggregateAssetDownloadTask:(AVAggregateAssetDownloadTask *)aggregateAssetDownloadTask didLoadTimeRange:(CMTimeRange)timeRange totalTimeRangesLoaded:(NSArray<NSValue *> *)loadedTimeRanges timeRangeExpectedToLoad:(CMTimeRange)timeRangeExpectedToLoad forMediaSelection:(AVMediaSelection *)mediaSelection NS_AVAILABLE_IOS(11_0);
| 函数名称 | URLSession:aggregateAssetDownloadTask:didLoadTimeRange:totalTimeRangesLoaded:timeRangeExpectedToLoad:forMediaSelection: |
|---|---|
| 解释 | 用于订阅AVAggregateAssetDownloadTask的进度更新的方法 |
| 参数 |
session:asset下载任务所在的会话。aggregateAssetDownloadTask:AVAggregateAssetDownloadTask。timeRange:CMTimeRange，指示为下载的媒体选择加载的时间范围。loadedTimeRanges:CMTimeRanges的NSValues的NSArray，指示为下载的媒体选择加载的所有时间范围。timeRangeExpectedToLoad:CMTimeRange，指示在下载完媒体选择的下载时预期要加载的单个时间范围。 mediaSelection:媒体选择，其中包含用于离线使用的其他媒体数据。 |
AVAssetDownloadURLSession
+ (AVAssetDownloadURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration assetDownloadDelegate:(nullable id <AVAssetDownloadDelegate>)delegate delegateQueue:(nullable NSOperationQueue *)delegateQueue;
| 函数名称 | sessionWithConfiguration:assetDownloadDelegate:delegateQueue: |
|---|---|
| 解释 | 创建并初始化AVAssetDownloadURLSession以与AVAssetDownloadTasks一起使用。 |
| 参数 |
configuration:此 URLSession的配置。必须是后台配置。assetDownloadDelegate:委托对象，用于处理 asset下载进度更新和其他与会话相关的事件。delegateQueue:接收委托回调的队列。如果为 nil，则将提供串行队列。 |
- (nullable AVAssetDownloadTask *)assetDownloadTaskWithURLAsset:(AVURLAsset *)URLAsset destinationURL:(NSURL *)destinationURL options:(nullable NSDictionary<NSString *, id> *)options NS_DEPRECATED_IOS(9_0, 10_0);
| 函数名称 | assetDownloadTaskWithURLAsset:destinationURL:options: |
|---|---|
| 解释 | 创建并初始化要与此AVAssetDownloadURLSession一起使用的AVAssetDownloadTask。 |
| 参数 |
URLAsset:AVURLAsset可在本地下载。destinationURL:要将 asset下载到的本地URL。这必须是文件URL。options:请参阅上面的 AVAssetDownloadTask * Key。配置下载任务的非默认行为。下载HLS asset的非默认媒体选择时需要使用此参数。 |
| 备注 | 如果URLSession已失效，则此方法可能返回nil。 |
- (nullable AVAssetDownloadTask *)assetDownloadTaskWithURLAsset:(AVURLAsset *)URLAsset assetTitle:(NSString *)title assetArtworkData:(nullable NSData *)artworkData options:(nullable NSDictionary<NSString *, id> *)options NS_AVAILABLE_IOS(10_0);
| 函数名称 | assetDownloadTaskWithURLAsset:assetTitle:assetArtworkData:options: |
|---|---|
| 解释 | 创建并初始化要与此AVAssetDownloadURLSession一起使用的AVAssetDownloadTask。 |
| 参数 |
URLAsset:AVURLAsset可在本地下载。assetTitle:此 asset的human readable title，应尽可能适合用户的首选语言。将显示在设置应用的使用情况窗格中。assetArtworkData:NSData表示此asset的图稿数据。是可选的。将显示在设置应用的使用情况窗格中。必须使用+ [UIImage imageWithData：]。options:请参阅上面的 AVAssetDownloadTask * Key。配置下载任务的非默认行为。下载HLS``asset的非默认媒体选择时需要使用此参数。 |
| 备注 | 如果URLSession已失效，则此方法可能返回ni。 |
- (nullable AVAggregateAssetDownloadTask *)aggregateAssetDownloadTaskWithURLAsset:(AVURLAsset *)URLAsset mediaSelections:(NSArray <AVMediaSelection *> *)mediaSelections assetTitle:(NSString *)title assetArtworkData:(nullable NSData *)artworkData options:(nullable NSDictionary<NSString *, id> *)options NS_AVAILABLE_IOS(11_0);
| 函数名称 | aggregateAssetDownloadTaskWithURLAsset:mediaSelections:assetTitle:assetArtworkData:options: |
|---|---|
| 解释 | 创建并初始化AVAggregateAssetDownloadTask以在AVURLAsset上下载多个AVMediaSelections。 |
| 参数 |
URLAsset:AVURLAsset可在本地下载。mediaSelections:AVMediaSelections列表。每个AVMediaSelection将对应一个childAssetDownloadTask。使用- [AVAsset allMediaSelections]下载此AVAsset上的所有AVMediaSelections。assetTitle:此 asset的人类可读标题，应尽可能适合用户的首选语言。将显示在设置应用的使用情况窗格中。assetArtworkData:此 asset的图稿数据。是可选的。将显示在设置应用的使用情况窗格中。options:请参阅上面的 AVAssetDownloadTask * Key。配置下载任务的非默认行为。 |
| 备注 | 如果URLSession已失效，则此方法可能返回nil。 AVAssetDownloadTaskMediaSelectionKey的值将被忽略。 |
只能使用
AVAssetDownloadURLSession创建AVAssetDownloadTasks
+ (NSURLSession *)sharedSession NS_UNAVAILABLE;
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration NS_UNAVAILABLE;
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration delegate:(nullable id <NSURLSessionDelegate>)delegate delegateQueue:(nullable NSOperationQueue *)queue NS_UNAVAILABLE;
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request NS_UNAVAILABLE;
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url NS_UNAVAILABLE;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL NS_UNAVAILABLE;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData NS_UNAVAILABLE;
- (NSURLSessionUploadTask *)uploadTaskWithStreamedRequest:(NSURLRequest *)request NS_UNAVAILABLE;
- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request NS_UNAVAILABLE;
- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url NS_UNAVAILABLE;
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData NS_UNAVAILABLE;
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler NS_UNAVAILABLE;
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler NS_UNAVAILABLE;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler NS_UNAVAILABLE;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(nullable NSData *)bodyData completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler NS_UNAVAILABLE;
- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request completionHandler:(void (^)(NSURL *location, NSURLResponse *response, NSError *error))completionHandler NS_UNAVAILABLE;
- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSURL *location, NSURLResponse *response, NSError *error))completionHandler NS_UNAVAILABLE;
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData completionHandler:(void (^)(NSURL *location, NSURLResponse *response, NSError *error))completionHandler NS_UNAVAILABLE;
| 上一章 | 目录 | 下一章 |
|---|
