# BDImage ```objectivec @interface BDImage : UIImage ``` `BDImage` 类继承自 `UIImage`，重写了 `UIImage` 各个初始化方法，适用于加载动图或需要额外解码的场景。 ## 成员变量 | 类型 | 名称 | | --- | --- | | id\ | [decoder](#BDImage-decoder) | | BDImageCodeType | [codeType](#BDImage-codetype) | | NSString* | [filePath](#BDImage-filepath) | | NSData* | [animatedImageData](#BDImage-animatedimagedata) | | BOOL | [isAnimateImage](#BDImage-isanimateimage) | | BOOL | [isAllFramesLoaded](#BDImage-isallframesloaded) | | NSUInteger | [frameCount](#BDImage-framecount) | | NSUInteger | [loopCount](#BDImage-loopcount) | | BOOL | [isCustomHeicDecoder](#BDImage-iscustomheicdecoder) | | BOOL | [hasDownsampled](#BDImage-hasdownsampled) | | BOOL | [hasCroped](#BDImage-hascroped) | | CGSize | [originSize](#BDImage-originsize) | ## 静态函数 | 返回 | 名称 | | --- | --- | | BDImage | [imageWithContentsOfFile:](#BDImage-imagewithcontentsoffile) | | BDImage | [imageNamed:](#BDImage-imagenamed) | | BDImage | [imageWithData:](#BDImage-imagewithdata) | | BDImage | [imageWithData:scale:](#BDImage-imagewithdata-scale) | | BDImage | [imageWithData:scale:decodeForDisplay:error:](#BDImage-imagewithdata-scale-decodefordisplay-error) | | BDImage | [imageWithData:scale:decodeForDisplay:shouldScaleDown:error:](#BDImage-imagewithdata-scale-decodefordisplay-shouldscaledown-error) | | BDImage | [imageWithData:scale:decodeForDisplay:shouldScaleDown:downsampleSize:cropRect:error:](#BDImage-imagewithdata-scale-decodefordisplay-shouldscaledown-downsamplesize-croprect-error) | | BDImage | [imageWithData:config:error:](#BDImage-imagewithdata-config-error) | ## 成员函数 | 返回 | 名称 | | --- | --- | | instancetype | [initWithAnimatedBDImage:](#BDImage-initwithanimatedbdimage) | | void | [preloadAllFrames](#BDImage-preloadallframes) | | BDAnimateImageFrame | [frameAtIndex:](#BDImage-frameatindex) | | instancetype | [initWithCoderInternal:](#BDImage-initwithcoderinternal) | | void | [changeImageWithData:finished:](#BDImage-changeimagewithdata-finished) | ## 变量说明 ### decoder ```objectivec @property (nonatomic, strong) id decoder; ``` 该图片使用的解码器，详见 [BDImageDecoder](#BDImageDecoder)。 ### codeType ```objectivec @property (nonatomic, readonly)BDImageCodeType codeType; ``` 原始数据编码格式，详见 [BDImageCodeType](1262416#BDImageCodeType)。 ### filePath ```objectivec @property (nonatomic, readonly, nullable)NSString *filePath; ``` 原始文件地址，仅通过 URL 初始化时才存在。 ### animatedImageData ```objectivec @property (nullable, nonatomic, readonly) NSData *animatedImageData; ``` 当 `BDImage` 是使用多帧动图初始化时，表示为原始动图数据。 ### isAnimateImage ```objectivec @property (nonatomic, readonly)BOOL isAnimateImage; ``` 是否为帧数大于 1 的动图。 - `YES`：是 - `NO`：否 ### isAllFramesLoaded ```objectivec @property (nonatomic, readonly)BOOL isAllFramesLoaded; ``` 是否已缓存动图的所有帧。 - `YES`：是 - `NO`：否 ### frameCount ```objectivec @property (nonatomic, readonly)NSUInteger frameCount; ``` 获取图片的总帧数，静图固定为 1。 ### loopCount ```objectivec @property (nonatomic, readonly)NSUInteger loopCount; ``` 动图循环播放次数。 ### isCustomHeicDecoder ```objectivec @property (nonatomic, assign) BOOL isCustomHeicDecoder; ``` 设置是否使用自定义解码器进行解码。 - `YES`：是 - `NO`：（默认）否 ### hasDownsampled ```objectivec @property (nonatomic, assign) BOOL hasDownsampled; ``` 图片是否经过降采样处理。 - `YES`：是 - `NO`：否 ### hasCroped ```objectivec @property (nonatomic, assign) BOOL hasCroped; ``` 图片是否经过裁剪处理。 - `YES`：是 - `NO`：否 ### originSize ```objectivec @property (nonatomic, assign) CGSize originSize; ``` 降采样前的原始图片大小。 ## 函数说明 ### imageWithContentsOfFile: ```objectivec + (nullable BDImage *)imageWithContentsOfFile:(NSString * _Nonnull)path; ``` 加载指定本地路径的图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | path | NSString* | 本地图片的绝对路径。 | **返回值** 解码成功后的图片对象。若解码失败或路径无效，则返回 nil。 **注意** 该方法对 `UIImage` 的 `imageWithContentsOfFile:` 方法进行了重写。 ### imageNamed: ```objectivec + (nullable BDImage *)imageNamed:(NSString * _Nonnull)name; ``` 加载 bundle 文件夹的图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | name | NSString* | 待加载的图片名称。 | **返回值** 解码成功后的图片对象。若解码失败或名称无效，则返回 nil。 **注意** 该方法对 `UIImage` 的 `imageNamed:` 方法进行了重写。 ### imageWithData: ```objectivec + (nullable BDImage *)imageWithData:(NSData *)data; ``` 通过 NSData 图片数据创建图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 图片数据。 | **返回值** 解码成功后的图片对象。若解码失败或数据无效，则返回 nil。 **注意** 该方法对 `UIImage` 的 `imageWithData:` 方法进行了重写。 ### imageWithData:scale: ```objectivec + (nullable BDImage *)imageWithData:(NSData *)data scale:(CGFloat)scale; ``` 通过 NSData 数据生成图片，并设置降采样。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 图片数据。 | | scale | CGFloat | 图片降采样倍数，即指定图像尺寸等比缩小的比例。取值需大于 1，取值为 2 时，表示生成图的宽高将缩小为原图尺寸的一半。 | **返回值** 解码成功后的图片。若解码失败或图片数据无效，则返回 nil。。 ### imageWithData:scale:decodeForDisplay:error: ```objectivec + (nullable BDImage *)imageWithData:(NSData * _Nonnull)data scale:(CGFloat)scale decodeForDisplay:(BOOL)decode error:(NSError *__autoreleasing * _Nullable)error; ``` 通过 NSData 数据生成图片，并设置降采样和是否预解码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 图片数据。 | | scale | CGFloat | 图片降采样倍数，即指定图像尺寸等比缩小的比例。取值需大于 1，取值为 2 时，表示生成图的宽高将缩小为原图尺寸的一半。 | | decode | BOOL | 是否预解码图片。

`YES`：是

`NO`：否

| | error | NSError*__autoreleasing* | 解码数据过程中的错误码，若解码成功则为 nil。 | **返回值** 解码成功后的图片对象。若解码失败或图片数据无效，则返回 nil。 ### imageWithData:scale:decodeForDisplay:shouldScaleDown:error: ```objectivec + (nullable BDImage *)imageWithData:(NSData * _Nonnull)data scale:(CGFloat)scale decodeForDisplay:(BOOL)decode shouldScaleDown:(BOOL)shouldScaleDown error:(NSError * __autoreleasing * _Nullable)error; ``` 通过 NSData 数据生成图片，并设置降采样、是否预解码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 图片数据。 | | scale | CGFloat | 图片降采样倍数，即指定图像尺寸等比缩小的比例。取值需大于 1，取值为 2 时，表示生成图的宽高将缩小为原图尺寸的一半。 | | decode | BOOL | 是否预解码图片。

`YES`：是

`NO`：否

| | shouldScaleDown | BOOL | 是否降采样。

`YES`：是

`NO`：否 \ |||:::tip \ |||指定为 `YES` 后，`scale` 配置才会生效。
\ |||::: \ |||

| | error | NSError*__autoreleasing* | 解码数据过程中的错误码，若解码成功则为 nil。 | **返回值** 解码成功后的图片对象。若解码失败或图片数据无效，则返回 nil。 ### imageWithData:scale:decodeForDisplay:shouldScaleDown:downsampleSize:cropRect:error: ```objectivec + (nullable BDImage *)imageWithData:(NSData * _Nonnull)data scale:(CGFloat)scale decodeForDisplay:(BOOL)decode shouldScaleDown:(BOOL)shouldScaleDown downsampleSize:(CGSize)size cropRect:(CGRect)cropRect error:(NSError * __autoreleasing * _Nullable)error; ``` 通过 NSData 数据生成图片，同时支持降采样、是否预解码、裁剪等配置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 图片数据。 | | scale | CGFloat | 图片降采样倍数，即指定图像尺寸等比缩小的比例。取值需大于 1，取值为 2 时，表示生成图的宽高将缩小为原图尺寸的一半。 | | decode | BOOL | 是否预解码图片。

`YES`：是

`NO`：否

| | shouldScaleDown | BOOL | 是否降采样。

`YES`：是

`NO`：否 \ |||:::tip \ |||指定为 `YES` 后，`scale`和 `size` 配置才会生效。
\ |||::: \ |||

| | size | CGSize | 指定降采样后图片的宽高。
\ |||:::tip \ |||当同时配置 `size` 和 `scale` 两种降采样参数时，配置生效优先级：`size` \> `scale`。 \ |||::: \ ||| | | cropRect | CGRect | 指定原图裁剪区域。
\ |||:::tip \ |||当同时配置了裁剪和降采样时，会首先根据 `cropRect` 对原图进行裁剪，然后再对裁剪后图片执行降采样处理。 \ |||::: \ ||| | | error | NSError*__autoreleasing* | 解码数据过程中的错误码，若解码成功则为 nil。 | **返回值** 解码成功后的图片。解码失败或配置失效，则返回 nil。 ### imageWithData:config:error: ```objectivec + (nullable BDImage *)imageWithData:(NSData * _Nonnull)data config:(BDImageDecoderConfig * _Nonnull)config error:(NSError * __autoreleasing * _Nullable)error; ``` 通过 NSData 数据和解码配置生成图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 图片数据。 | | config | BDImageDecoderConfig* | 图片解码配置，详见 [BDImageDecoderConfig](#BDImageDecoderConfig)。 | | error | NSError*__autoreleasing* | 解码数据过程中的错误码，若解码成功则为 nil。 | **返回值** 解码成功后的图片，可能为 nil。 ### initWithAnimatedBDImage: ```objectivec - (instancetype)initWithAnimatedBDImage:(BDImage *)image; ``` 使用 BDImage 动图对象初始化。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | BDImage* | BDImage 动图对象。 | **返回值** 初始化成功后的图片。 ### preloadAllFrames ```objectivec - (void)preloadAllFrames; ``` 缓存动图所有帧。 ### frameAtIndex: ```objectivec - (nullable BDAnimateImageFrame *)frameAtIndex:(NSInteger)index; ``` 动图截帧，通过指定截取的帧数获取该帧对应的图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | NSInteger | 指定截取的那一帧帧数，指定为 `0` 时，表示截取首帧。 | **返回值** 指定帧数对应的图片，详见 [BDAnimateImageFrame](https://www.volcengine.com/docs/508/1262416#bdanimateimageframe)。 ### initWithCoderInternal: ```objectivec - (instancetype)initWithCoderInternal:(id)decoder; ``` 通过指定解码器解码图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | decoder | id\ | 解码器。 | **返回值** 解码成功的图片。 ### changeImageWithData:finished: ```objectivec - (void)changeImageWithData:(NSData*)data finished:(BOOL)finished; ``` 更新当前图片数据，用于渐进式加载。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 新数据。 | | finished | BOOL | 新数据是否下载完成。

`YES`：是

`NO`：否

| **注意** 适用图片格式：gif（动图）、heif（动图）、awebp（动图）、heic（静图）、jpeg（静图）、png（静图） # BDAnimatedImagePlayer ```objectivec @interface BDAnimatedImagePlayer : NSObject ``` 动图播放器。建议不要手动修改 `BDAnimatedImagePlayer` 相关配置，推荐从 [BDImageView](#BDImageView) 中设置播放器。 ## 成员变量 | 类型 | 名称 | | --- | --- | | id\ | [delegate](#BDAnimatedImagePlayer-delegate) | | BDImage* | [image](#BDAnimatedImagePlayer-image) | | BOOL | [frameCacheAutomatically](#BDAnimatedImagePlayer-framecacheautomatically) | | BOOL | [cacheAllFrame](#BDAnimatedImagePlayer-cacheallframe) | | NSUInteger | [loopCount](#BDAnimatedImagePlayer-loopcount) | | NSUInteger | [customLoopCount](#BDAnimatedImagePlayer-customloopcount) | | BOOL | [isPlaying](#BDAnimatedImagePlayer-isplaying) | | NSUInteger | [currentIndex](#BDAnimatedImagePlayer-currentindex) | | BDAnimateImageFrame* | [currentFrame](#BDAnimatedImagePlayer-currentframe) | | NSRunLoopMode | [animateRunLoopMode](#BDAnimatedImagePlayer-animaterunloopmode) | | BDAnimatedImageAnimationType | [animationType](#BDAnimatedImagePlayer-animationtype) | | BOOL | [enableWaterLevel](#BDAnimatedImagePlayer-enablewaterlevel) | | NSTimeInterval | [waterLevelDuration](#BDAnimatedImagePlayer-waterlevelduration) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [startPlay](#BDAnimatedImagePlayer-startplay) | | void | [pause](#BDAnimatedImagePlayer-pause) | | void | [stopPlay](#BDAnimatedImagePlayer-stopplay) | | void | [clearImageBuffer](#BDAnimatedImagePlayer-clearimagebuffer) | ## 变量说明 ### delegate ```objectivec @property (nonatomic, weak) id delegate; ``` 播放状态改变回调，详见 [BDAnimatedImagePlayerDelegate](1262415#BDAnimatedImagePlayerDelegate)。 **注意** 在 `BDWebImage` 中，`BDImageView` 是动画播放的主要服务对象。 ### image ```objectivec @property (atomic, strong, readonly)BDImage *image; ``` 正在播放的动图。 **注意** 渐进式加载时也包含临时缓存图片，下载中的图片会标记为 `bd_isLoading`。 ### frameCacheAutomatically ```objectivec @property (nonatomic, assign) BOOL frameCacheAutomatically; ``` 是否自动缓存动图所有帧。 - `YES`：是 - `NO`：否。不缓存图片，即默认每一帧图片加载完成后就会被丢弃。适用于顺序播放且只播放一次动图的场景。 **注意** - 当图片格式是 heic 或者 webp 且播放模式是往复播放时，为保证加载体验，建议设置为 `YES`。 - 不推荐直接在 `BDAnimatedImagePlayer` 类设置该属性，您可以在 `BDImageView` 中设置 [frameCacheAutomatically](#BDImageView-framecacheautomatically) 属性。 ### cacheAllFrame ```objectivec @property (nonatomic, assign) BOOL cacheAllFrame; ``` 是否强制缓存动图所有帧。 - `YES`：是。（但如果内存告警，则会清空所有动图缓存。） - `NO`：否。 **注意** 对于 HEIF 和 WEBP 格式在往复播放（Reciprocating）效果下可能导致后续播放图片出现缺失画面，因为这两种格式的渲染方式必须是顺序渲染，除非内存告警，否则不清空内存。 ### loopCount ```objectivec @property (nonatomic, assign) NSUInteger loopCount; ``` 设置播放循环的次数。用于控制整个动画或循环的播放次数。 **注意** - 不建议通过 loopCount 来设置循环次数，内部实现会将 loopCount 的设置转换为 customLoopCount 设置，建议直接设置 [customLoopCount](#BDAnimatedImagePlayer-customloopcount)。 - 循环次数生效优先级为：用户自定义 [customLoopCount](#BDAnimatedImagePlayer-customloopcount) \> 渐进式加载的默认循环次数(默认值为 1) \> 图片数据本身自带的循环次数 ### customLoopCount ```objectivec @property (nonatomic, assign) NSUInteger customLoopCount; ``` 设置自定义动图循环次数。用于控制特定场景的自定义播放次数。 ### isPlaying ```objectivec @property (nonatomic, readonly) BOOL isPlaying; ``` 判断当前图片是否正在播放。 - `YES`：是 - `NO`：否 **注意** 禁止在非主线程访问此方法。 ### currentIndex ```objectivec @property (nonatomic, assign) NSUInteger currentIndex; ``` 当前图片的索引。 **注意** 只读属性。 ### currentFrame ```objectivec @property (nonatomic, strong, nullable, readonly) BDAnimateImageFrame *currentFrame; ``` 当前播放的图片帧，详见 [BDAnimateImageFrame](1262416#BDAnimateImageFrame)。 ### animateRunLoopMode ```objectivec @property (nonatomic, strong) NSRunLoopMode animateRunLoopMode; ``` 当前动图运行的 Run Loop 模式，默认值为 `NSRunLoopCommonModes`。 ### animationType ```objectivec @property (nonatomic, assign) BDAnimatedImageAnimationType animationType; ``` 当前动图的播放效果，详见 [BDAnimatedImageAnimationType](1262416#BDAnimatedImageAnimationType)。 ### enableWaterLevel ```objectivec @property (nonatomic, assign) BOOL enableWaterLevel; ``` 是否开启图片渐进式加载水位控制。 - `YES`：是。 - `NO`：（默认）否 **注意** 仅在渐进式加载过程中生效。 ### waterLevelDuration ```objectivec @property (nonatomic, assign) NSTimeInterval waterLevelDuration; ``` 渐进式加载水位控制时长，单位为秒。默认值为 1，取值范围为 [0.2, 10.0]。 ## 函数说明 ### startPlay ```objectivec - (void)startPlay; ``` 开启动图播放，开启成功后会触发 [imagePlayerStartPlay](https://www.volcengine.com/docs/508/1262415#imageplayerstartplay) 回调。 ### pause ```objectivec - (void)pause; ``` 暂停动图播放。 ### stopPlay ```objectivec - (void)stopPlay; ``` 完全终止动图播放。 **注意** 在渐进式加载过程中每次新的数据回调都会尝试继续播放，因此在加载完成前，调用此接口没有意义。 ### clearImageBuffer ```objectivec - (void)clearImageBuffer; ``` 清空动图缓存。 **注意** 为尽量保证后续动画播放性能，对于非必须顺序解码的图片会保留当前帧和下一帧；而对于必须顺序解码的图片（heif/webp 格式）则会完全清空缓存，从头开始播放。 # BDLivePhotoView ```objectivec @interface BDLivePhotoView : UIView ``` LivePhoto 播放控制，继承自 `UIView`。 ## 静态函数 | 返回 | 名称 | | --- | --- | | void | [clearMemoryCache](#BDLivePhotoView-clearmemorycache) | | void | [clearDiskCache](#BDLivePhotoView-cleardiskcache) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setLivePhotoWithImageUrl:videoUrl:placeholder:completion:](#BDLivePhotoView-setlivephotowithimageurl-videourl-placeholder-completion) | | void | [resetView](#BDLivePhotoView-resetview) | ## 函数说明 ### clearMemoryCache ```objectivec + (void)clearMemoryCache; ``` 清空所有 LivePhoto 内存缓存。 ### clearDiskCache ```objectivec + (void)clearDiskCache; ``` 清空所有 LivePhoto 磁盘缓存。 ### setLivePhotoWithImageUrl:videoUrl:placeholder:completion: ```objectivec - (void)setLivePhotoWithImageUrl:(nullable NSURL *)imageUrl videoUrl:(nullable NSURL *)videoUrl placeholder:(nullable UIImage *)placeholder completion:(nullable BDLivePhotoCompletedBlock)completion; ``` 创建并发起 LivePhoto 图片请求。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageUrl | nullable NSURL* | LivePhoto 图片的静图 URL。 | | videoUrl | nullable NSURL* | LivePhoto 图片的视频 URL。 | | placeholder | nullable UIImage* | 占位图，可以传入 nil。 | | completion | nullable BDLivePhotoCompletedBlock | 下载完成回调。当图片或者视频下载完成，都会通过该 block 进行数据回调。 | ### resetView ```objectivec - (void)resetView; ``` 清空 View。会清空静图，并且停止视频播放并释放相关资源。 # BDRoundCornerTransformer ```objectivec @interface BDRoundCornerTransformer : BDBaseTransformer ``` 图片圆角处理相关接口。 ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [defaultTransformer](#BDRoundCornerTransformer-defaulttransformer) | | instancetype | [transformerWithImageSize:](#BDRoundCornerTransformer-transformerwithimagesize) | | instancetype | [transformerWithImageSize:borderWidth:borderColor:](#BDRoundCornerTransformer-transformerwithimagesize-borderwidth-bordercolor) | ## 函数说明 ### defaultTransformer ```objectivec + (instancetype _Nullable)defaultTransformer; ``` 获取默认实例。 **返回值** BDRoundCornerTransformer 类的默认实例。 ### transformerWithImageSize: ```objectivec + (instancetype _Nullable)transformerWithImageSize:(BDRoundCornerImageSizes)imageSize; ``` 根据不同图片尺寸创建相应的 Transformer 实例。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageSize | BDRoundCornerImageSizes | 图片尺寸。 | **返回值** BDRoundCornerTransformer 类的实例。 **注意** 该接口返回的均为单例，可以复用。 ### transformerWithImageSize:borderWidth:borderColor: ```objectivec + (instancetype _Nullable)transformerWithImageSize:(BDRoundCornerImageSizes)imageSize borderWidth:(CGFloat)borderWidth borderColor:(UIColor * _Nullable)borderColor; ``` 根据不同图片尺寸创建相应的 Transformer 实例，支持设置边界宽度和边界颜色。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageSize | BDRoundCornerImageSizes | 图片尺寸。 | | borderWidth | CGFloat | 边框宽度。 | | borderColor | UIColor* | 边框颜色。 | **返回值** BDRoundCornerTransformer 类的实例。 **注意** 该接口返回的都是单例，可以复用。 # BDThumbImageDecoder ```objectivec @protocol BDThumbImageDecoder ``` 缩略图解码器协议，支持渐进式加载。 ## 静态函数 | 返回 | 名称 | | --- | --- | | BOOL | [supportDecodeThumbFromHeicData](#BDThumbImageDecoder-supportdecodethumbfromheicdata) | | BOOL | [isStaticHeicImage:](#BDThumbImageDecoder-isstaticheicimage) | | NSInteger | [parseThumbLocationForHeicData:minDataSize:](#BDThumbImageDecoder-parsethumblocationforheicdata-mindatasize) | | NSMutableData* | [heicRepackData:](#BDThumbImageDecoder-heicrepackdata) | ## 成员函数 | 返回 | 名称 | | --- | --- | | CGImageRef | [decodeThumbImage](#BDThumbImageDecoder-decodethumbimage) | ## 函数说明 ### supportDecodeThumbFromHeicData ```objectivec + (BOOL)supportDecodeThumbFromHeicData; ``` 判断当前解码器是否支持缩略图渐进式加载。 - `YES`：是 - `NO`：否 **返回值** 判断结果。 ### isStaticHeicImage: ```objectivec + (BOOL)isStaticHeicImage:(NSData * _Nonnull)data; ``` 判断上传图片数据是否是 heic 静图。 - `YES`：是 - `NO`：否 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解析的图片数据。 | **返回值** 判断结果。 ### parseThumbLocationForHeicData:minDataSize: ```objectivec + (NSInteger)parseThumbLocationForHeicData:(NSData * _Nonnull)data minDataSize:(NSInteger * _Nullable)minDataSize; ``` 解析上传图片数据中的缩略图并返回结果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解析的图片数据。 | | minDataSize | NSInteger* | NSInteger 类型变量地址。如果缩略图解析成功，minDataSize 表示解析出缩略图的最小数据长度。 | **返回值** 缩略图解析结果，详见 [BDImageHeicThumbLocationType](1262416#BDImageHeicThumbLocationType)。 ### heicRepackData: ```objectivec + (NSMutableData * _Nullable)heicRepackData:(NSData * _Nonnull)data; ``` 如果图片数据中包含缩略图，则删除缩略图的数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要删除缩略图的图片数据。 | **返回值** 删除缩略图之后剩下的图片数据。 ### decodeThumbImage ```objectivec - (CGImageRef _Nullable)decodeThumbImage; ``` 解码缩略图。 **返回值** 缩略图结果，格式为 CGImageRef。 **注意** 仅支持 heic 静图格式的缩略图渐进式加载。 # BDImageDecoderConfig ```objectivec @interface BDImageDecoderConfig : NSObject ``` 解码器配置相关接口。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [decodeForDisplay](#BDImageDecoderConfig-decodefordisplay) | | BOOL | [shouldScaleDown](#BDImageDecoderConfig-shouldscaledown) | | CGFloat | [scale](#BDImageDecoderConfig-scale) | | CGSize | [sizeLimit](#BDImageDecoderConfig-sizelimit) | | NSUInteger | [memoryLimit](#BDImageDecoderConfig-memorylimit) | | CGRect | [cropRect](#BDImageDecoderConfig-croprect) | | BOOL | [smartCrop](#BDImageDecoderConfig-smartcrop) | ## 成员函数 | 返回 | 名称 | | --- | --- | | CGSize | [imageCanvasSize:](#BDImageDecoderConfig-imagecanvassize) | | BDImageDecoderSizeType | [imageSizeType:](#BDImageDecoderConfig-imagesizetype) | ## 变量说明 ### decodeForDisplay ```objectivec @property (nonatomic, assign) BOOL decodeForDisplay; ``` 设置是否预解码图片。 - `YES`：是 - `NO`：否 ### shouldScaleDown ```objectivec @property (nonatomic, assign) BOOL shouldScaleDown; ``` 设置是否降采样。 - `YES`：是 - `NO`：否 ### scale ```objectivec @property (nonatomic, assign) CGFloat scale; ``` 设置图片降采样倍数，即指定图像尺寸等比缩小的比例。取值需大于 1，取值为 2 时，表示生成图的宽高将缩小为原图尺寸的一半。 ### sizeLimit ```objectivec @property (nonatomic, assign) CGSize sizeLimit; ``` 设置降采样后图片宽高限制。 ### memoryLimit ```objectivec @property (nonatomic, assign) NSUInteger memoryLimit; ``` 设置降采样图片内存大小，单位为 Byte。 ### cropRect ```objectivec @property (nonatomic, assign) CGRect cropRect; ``` 设置图片解码时的裁剪区域。 ### smartCrop ```objectivec @property (nonatomic, assign) BOOL smartCrop; ``` 是否需要进行智能裁剪。 - `YES`：是 - `NO`：否 **注意** 指定的图片访问 URL 中需要携带裁剪区域信息的模板配置信息。如何在模板配置裁剪，详见[图片处理配置](https://www.volcengine.com/docs/508/8087)。 ## 函数说明 ### imageCanvasSize: ```objectivec - (CGSize)imageCanvasSize:(CGSize)originSize; ``` 获取解码后画布的大小。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | originSize | CGSize | 原图尺寸。 | **返回值** 画布的尺寸。 **注意** 由于会按照设置的属性执行裁剪、降采样等操作，所以解码后画布可能会与原图大小不一致。 ### imageSizeType: ```objectivec - (BDImageDecoderSizeType)imageSizeType:(CGSize)originSize; ``` 判断图片尺寸的操作类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | originSize | CGSize | 原图尺寸。 | **返回值** 操作类型，详见 [BDImageDecoderSizeType](1262416#BDImageDecoderSizeType)。 # UIImageView(BDWebImage) ```objectivec @interface UIImageView (BDWebImage) ``` 适配 UIImageView 的 veImageX category，提供更方便的图片加载函数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDWebImageRequest* | [imageRequest](#UIImageView(BDWebImage)-imagerequest) | | BOOL | [bd_isOpenDownsample](#UIImageView(BDWebImage)-bd_isopendownsample) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BDWebImageRequest | [bd_setImageWithURL:](#UIImageView(BDWebImage)-bd_setimagewithurl) | | BDWebImageRequest | [bd_setImageWithURL:placeholder:](#UIImageView(BDWebImage)-bd_setimagewithurl-placeholder) | | BDWebImageRequest | [bd_setImageWithURL:options:](#UIImageView(BDWebImage)-bd_setimagewithurl-options) | | BDWebImageRequest | [bd_setImageWithURL:placeholder:options:completion:](#UIImageView(BDWebImage)-bd_setimagewithurl-placeholder-options-completion) | | BDWebImageRequest | [bd_setImageWithURL:placeholder:options:progress:completion:](#UIImageView(BDWebImage)-bd_setimagewithurl-placeholder-options-progress-completion) | | BDWebImageRequest | [bd_setImageWithURL:placeholder:options:cacheName:progress:completion:](#UIImageView(BDWebImage)-bd_setimagewithurl-placeholder-options-cachename-progress-completion) | | BDWebImageRequest | [bd_setImageWithURL:placeholder:options:transformer:progress:completion:](#UIImageView(BDWebImage)-bd_setimagewithurl-placeholder-options-transformer-progress-completion) | | BDWebImageRequest | [bd_setImageWithURLs:placeholder:options:transformer:progress:completion:](#UIImageView(BDWebImage)-bd_setimagewithurls-placeholder-options-transformer-progress-completion) | | BDWebImageRequest | [bd_setImageWithURL:alternativeURLs:placeholder:options:cacheName:transformer:progress:completion:](#UIImageView(BDWebImage)-bd_setimagewithurl-alternativeurls-placeholder-options-cachename-transformer-progress-completion) | | BDWebImageRequest | [bd_setImageWithURL:alternativeURLs:placeholder:options:timeoutInterval:cacheName:transformer:progress:completion:](#UIImageView(BDWebImage)-bd_setimagewithurl-alternativeurls-placeholder-options-timeoutinterval-cachename-transformer-progress-completion) | | BDWebImageRequest | [bd_setImageWithURL:alternativeURLs:placeholder:options:timeoutInterval:cacheName:transformer:decryptBlock:progress:completion:](#UIImageView(BDWebImage)-bd_setimagewithurl-alternativeurls-placeholder-options-timeoutinterval-cachename-transformer-decryptblock-progress-completion) | | BDWebImageRequest | [bd_setImageWithURL:alternativeURLs:placeholder:options:config:blocks:](#UIImageView(BDWebImage)-bd_setimagewithurl-alternativeurls-placeholder-options-config-blocks) | | void | [bd_cancelImageLoad](#UIImageView(BDWebImage)-bd_cancelimageload) | | nullable NSURL* | [bd_imageURL](#UIImageView(BDWebImage)-bd_imageurl) | ## 变量说明 ### imageRequest ```objectivec @property (nonatomic, strong, nullable) BDWebImageRequest *imageRequest; ``` 加载图片对应的请求实例。 ### bd_isOpenDownsample ```objectivec @property (nonatomic, assign) BOOL bd_isOpenDownsample; ``` 是否按照 View 的大小进行下采样。 - `YES`：是 - `NO`：（默认）否 **注意** 若在自定义 [BDWebImageRequestConfig](#sizelimit-2) 的降采样尺寸限制的同时，也指定 [bd_isOpenDownsample](#UIImageView(BDWebImage)-bd_isopendownsample) 为 `YES`，那么自定义的尺寸限制优先生效。 ## 函数说明 ### bd_setImageWithURL: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL; ``` 在 UIImageView 中加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | **返回值** 图片请求实例，如果失败则会返回 nil。 ### bd_setImageWithURL:placeholder: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL placeholder:(UIImage * _Nullable)placeholder; ``` 在 UIImageView 中加载图片并设置占位图。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | placeholder | UIImage* | 占位图。 | **返回值** 图片请求实例，如果失败则会返回 nil。 ### bd_setImageWithURL:options: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL options:(BDImageRequestOptions)options; ``` 在 UIImageView 中加载图片并设置加载选项。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | options | BDImageRequestOptions | 图片加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | **返回值** 图片请求实例，如果失败则会返回 nil。 ### bd_setImageWithURL:placeholder:options:completion: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options completion:(BDImageRequestCompletedBlock _Nullable)completion; ``` 在 UIImageView 中加载图片，并设置占位图、加载选项和回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | placeholder | UIImage* | 占位图片。 | | options | BDImageRequestOptions | 加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | | completion | BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:placeholder:options:progress:completion: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options progress:(BDImageRequestProgressBlock _Nullable)progress completion:(BDImageRequestCompletedBlock _Nullable)completion; ``` 在 UIImageView 中加载图片，并设置占位图、加载选项、下载进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | placeholder | UIImage* | 占位图。 | | options | BDImageRequestOptions | 加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | | progress | BDImageRequestProgressBlock | 下载进度回调，可以用于统计当前图片下载进度。 | | completion | BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:placeholder:options:cacheName:progress:completion: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options cacheName:(NSString * _Nullable)cacheName progress:(BDImageRequestProgressBlock _Nullable)progress completion:(BDImageRequestCompletedBlock _Nullable)completion; ``` 在 UIImageView 中加载图片，并设置占位图、加载选项、缓存名称、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | placeholder | UIImage* | 占位图片。 | | options | BDImageRequestOptions | 加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | | cacheName | NSString* | 当前期望的缓存名称。 | | progress | BDImageRequestProgressBlock | 下载进度回调，可以用于统计当前图片下载进度。 | | completion | BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:placeholder:options:transformer:progress:completion: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options transformer:(BDBaseTransformer * _Nullable)transformer progress:(BDImageRequestProgressBlock _Nullable)progress completion:(BDImageRequestCompletedBlock _Nullable)completion; ``` 在 UIImageView 中加载图片，并设置占位图、加载选项、图片处理工具、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | placeholder | UIImage* | 占位图片。 | | options | BDImageRequestOptions | 加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | | transformer | BDBaseTransformer* | 图片加工工具，可以在图片下载后再次对图片进行加工。详见 [transformer](https://www.volcengine.com/docs/508/1262416#BDWebImageRequestConfig-transformer)。 | | progress | BDImageRequestProgressBlock | 下载进度回调，可以用于统计当前图片下载进度。 | | completion | BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURLs:placeholder:options:transformer:progress:completion: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURLs:(NSArray * _Nonnull)imageURLs placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options transformer:(BDBaseTransformer * _Nullable)transformer progress:(BDImageRequestProgressBlock _Nullable)progress completion:(BDImageRequestCompletedBlock _Nullable)completion; ``` 在 UIImageView 中加载图片，并设置占位图、加载选项、图片处理工具、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURLs | NSArray* | 图片访问 URL 数组，支持 http、file 和 data 的 scheme 的加载方式。 | | placeholder | UIImage* | 占位图片。 | | options | BDImageRequestOptions | 加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | | transformer | BDBaseTransformer* | 图片加工工具，可以在图片下载后再次对图片进行加工。详见 [transformer](https://www.volcengine.com/docs/508/1262416#BDWebImageRequestConfig-transformer)。 | | progress | BDImageRequestProgressBlock | 下载进度回调，可以用于统计当前图片下载进度。 | | completion | BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### bd_setImageWithURL:alternativeURLs:placeholder:options:cacheName:transformer:progress:completion: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL alternativeURLs:(NSArray * _Nullable)alternativeURLs placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options cacheName:(NSString * _Nullable)cacheName transformer:(BDBaseTransformer * _Nullable)transformer progress:(BDImageRequestProgressBlock _Nullable)progress completion:(BDImageRequestCompletedBlock _Nullable)completion; ``` 在 UIImageView 中加载图片，并设置备用图片、占位图、缓存名称、加载选项、图片处理工具、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray* | 备用图片访问 URL，可以传入 nil。当原始图片加载失败时，会尝试加载备用图片。 | | placeholder | UIImage* | 占位图片。 | | options | BDImageRequestOptions | 加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | | cacheName | NSString* | 当前期望的缓存名称。 | | transformer | BDBaseTransformer* | 图片加工工具，可以在图片下载后再次对图片进行加工。详见 [transformer](https://www.volcengine.com/docs/508/1262416#BDWebImageRequestConfig-transformer)。 | | progress | BDImageRequestProgressBlock | 下载进度回调，可以用于统计当前图片下载进度。 | | completion | BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:alternativeURLs:placeholder:options:timeoutInterval:cacheName:transformer:progress:completion: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL alternativeURLs:(NSArray * _Nullable)alternativeURLs placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options timeoutInterval:(CFTimeInterval)timeoutInterval cacheName:(NSString * _Nullable)cacheName transformer:(BDBaseTransformer * _Nullable)transformer progress:(BDImageRequestProgressBlock _Nullable)progress completion:(BDImageRequestCompletedBlock _Nullable)completion; ``` 在 UIImageView 中加载图片，并设置备用图片、占位图、缓存名称、加载选项、请求超时、图片处理工具、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray* | 备用图片访问 URL，可以传入 nil。当原始图片加载失败时，会尝试加载备用图片。 | | placeholder | UIImage* | 占位图片。 | | options | BDImageRequestOptions | 加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | | timeoutInterval | CFTimeInterval | 网络请求的超时时间，传入 0 使用默认超时。 | | cacheName | NSString* | 当前期望的缓存实例。 | | transformer | BDBaseTransformer* | 图片加工工具，可以在图片下载后再次对图片进行加工。详见 [transformer](https://www.volcengine.com/docs/508/1262416#BDWebImageRequestConfig-transformer)。 | | progress | BDImageRequestProgressBlock | 下载进度回调，可以用于统计当前图片下载进度。 | | completion | BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:alternativeURLs:placeholder:options:timeoutInterval:cacheName:transformer:decryptBlock:progress:completion: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL alternativeURLs:(NSArray * _Nullable)alternativeURLs placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options timeoutInterval:(CFTimeInterval)timeoutInterval cacheName:(NSString * _Nullable)cacheName transformer:(BDBaseTransformer * _Nullable)transformer decryptBlock:(BDImageRequestDecryptBlock _Nullable)decrypt progress:(BDImageRequestProgressBlock _Nullable)progress completion:(BDImageRequestCompletedBlock _Nullable)completion; ``` 在 UIImageView 中加载图片，并设置备用图片、占位图、缓存名称、加载选项、请求超时、图片解密工具、图片处理工具、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray* | 备用图片访问 URL，可以传入 nil。当原始图片加载失败时，会尝试加载备用图片。 | | placeholder | UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | timeoutInterval | CFTimeInterval | 网络请求的超时时间，传入 0 使用默认超时。 | | cacheName | NSString* | 当前期望的缓存实例。 | | transformer | BDBaseTransformer* | 图片加工工具，可以在图片下载后再次对图片进行加工。详见 [transformer](https://www.volcengine.com/docs/508/1262416#BDWebImageRequestConfig-transformer)。 | | decrypt | BDImageRequestDecryptBlock | 图片解密工具。图片下载后如果是加密状态则会通过该回调进行解密之后再解码，设置该回调会默认添加 [BDImageRequestNotVerifyData](https://www.volcengine.com/docs/508/1262416#BDImageRequestOptions) 选项。 | | progress | BDImageRequestProgressBlock | 下载进度回调，可以用于统计当前图片下载进度。 | | completion | BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:alternativeURLs:placeholder:options:config:blocks: ```objectivec - (BDWebImageRequest * _Nullable)bd_setImageWithURL:(NSURL * _Nonnull)imageURL alternativeURLs:(NSArray * _Nullable)alternativeURLs placeholder:(UIImage * _Nullable)placeholder options:(BDImageRequestOptions)options config:(BDWebImageRequestConfig * _Nullable)config blocks:(BDWebImageRequestBlocks * _Nullable)blocks; ``` 在 UIImageView 中加载图片，并设置备用图片、占位图、加载选项、图片请求配置和图片请求回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageURL | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray* | 备用图片访问 URL，可以传入 nil。当原始图片加载失败时，会尝试加载备用图片。 | | placeholder | UIImage* | 占位图片。 | | options | BDImageRequestOptions | 加载选项，如重试错误码。详见 [BDWebImageRequest](#BDWebImageRequest)。 | | config | BDWebImageRequestConfig* | 图片请求配置，详见 [BDWebImageRequestConfig](1262416#BDWebImageRequestConfig)。 | | blocks | BDWebImageRequestBlocks* | 图片请求回调，包括下载进度、下载完成、解密回调。 | **返回值** 图片请求实例，如果失败则会返回 nil。 ### bd_cancelImageLoad ```objectivec - (void)bd_cancelImageLoad; ``` 取消图片请求。 ### bd_imageURL ```objectivec - (nullable NSURL *)bd_imageURL; ``` 获得当前图片请求的 URL。 **返回值** url 地址。 # BDImageView ```objectivec @interface BDImageView : UIImageView ``` 图片库核心模块，继承自 `UIImageView` 类。推荐任何 BDImage 都使用 `BDImageView` 展示图片，支持边下边播、不同动画帧时长等功能。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [infinityLoop](#BDImageView-infinityloop) | | NSUInteger | [customLoop](#BDImageView-customloop) | | BOOL | [animateEnable](#BDImageView-animateenable) | | BOOL | [frameCacheAutomatically](#BDImageView-framecacheautomatically) | | BOOL | [cacheAllFrame](#BDImageView-cacheallframe) | | NSUInteger | [currentAnimatedImageIndex](#BDImageView-currentanimatedimageindex) | | BOOL | [autoPlayAnimatedImage](#BDImageView-autoplayanimatedimage) | | BOOL | [hightAnimationControl](#BDImageView-hightanimationcontrol) | | BOOL | [moveToWindowAnimationControl](#BDImageView-movetowindowanimationcontrol) | | BDAnimatedImagePlayer* | [player](#BDImageView-player) | | BDImage* | [animateImage](#BDImageView-animateimage) | | NSRunLoopMode | [animateRunLoopMode](#BDImageView-animaterunloopmode) | | BDAnimatedImageAnimationType | [animationType](#BDImageView-animationtype) | | BOOL | [enableWaterLevel](#BDImageView-enablewaterlevel) | | NSTimeInterval | [waterLevelDuration](#BDImageView-waterlevelduration) | | BOOL | [bd_isOpenDownsample_delay](#BDImageView-bd_isopendownsample_delay) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [loopCompletionBlock](#BDImageView-loopcompletionblock) | | void | [customLoopCompletionBlock](#BDImageView-customloopcompletionblock) | | void | [firstFramePlayBlock](#BDImageView-firstframeplayblock) | | void | [delayFramePlayBlock](#BDImageView-delayframeplayblock) | | void | [startAnimation](#BDImageView-startanimation) | | void | [pauseAnimation](#BDImageView-pauseanimation) | | void | [stopAnimation](#BDImageView-stopanimation) | | void | [clearImageBuffer](#BDImageView-clearimagebuffer) | ## 变量说明 ### infinityLoop ```objectivec @property (nonatomic, assign) BOOL infinityLoop; ``` 强制图片无限循环播放。 **注意** 优先级：用户自定义的 `customLoop` 参数 \> 用户自定义的 `infinityLoop` 参数 \> 渐进式加载时循环次数（默认值为 1） \> 图片本身自带的循环次数的数据 ### customLoop ```objectivec @property (nonatomic, assign) NSUInteger customLoop; ``` 自定义图片循环播放次数。 **注意** 默认值为 0，当设置为 0 时，该属性不生效。 ### animateEnable ```objectivec @property (nonatomic, assign, getter=isAnimateEnable)BOOL animateEnable; ``` 是否允许 BDImageView 视图播放动画。 - `YES`：是 - `NO`：否 **注意** 不推荐手动访问 BDImageView 的 `player` 属性，进行动画播放。 ### frameCacheAutomatically ```objectivec @property (nonatomic, assign) BOOL frameCacheAutomatically; ``` 是否自动缓存动图所有帧。 - `YES`：（默认）是 - `NO`：否。不进行图片缓存，每一张图片使用之后会默认丢弃，适用于顺序播放并且只播放一次动画的场景。 **注意** 当图片格式是 heic 或者 webp 并且播放模式是往复播放时，不支持清空缓存。 ### cacheAllFrame ```objectivec @property (nonatomic, assign) BOOL cacheAllFrame; ``` 是否强制缓存所有动图帧。 - `YES`：是。若内存发生告警，则会清空所有动画缓存。 - `NO`：（默认）否 **注意** - 对于 HEIF 和 WEBP 格式在往复播放效果下可能导致后续播放图片出现缺失画面，因为这两种格式的渲染方式必须是顺序渲染，除非内存告警，否则不清空内存。 - 该属性来自 BDAnimatedImagePlayer，因此仅当存在图片的时刻才能够获取到正确值，建议在 completionBlock 调用之后获取该属性。 ### currentAnimatedImageIndex ```objectivec @property (nonatomic, assign) NSUInteger currentAnimatedImageIndex; ``` 获取当前动图播放的帧数，从 0 开始计数。 **注意** - 该属性来自 BDAnimatedImagePlayer，因此仅当存在图片的时刻才能够获取到正确值，建议在 completionBlock 调用之后获取该属性。 - 只读属性。 ### autoPlayAnimatedImage ```objectivec @property (nonatomic, assign) BOOL autoPlayAnimatedImage; ``` 在特定条件下，是否自动播放动画。 - `YES`：是 - `NO`：否 **注意** - 特定条件指`[UIView_didMoveToWindow]` 以及 `[BDImageView_setImage:]` 方法会触发动画自动播放。 - 适应前需满足 BDImageView 已被添加到 UIWindow 上，且 `animateEnable` 属性为 `YES`。 ### hightAnimationControl ```objectivec @property (nonatomic, assign) BOOL hightAnimationControl; ``` 是否对齐 UIImageView 在 iOS 13.0 以前的 UIImageView 效果。 - `YES`：（默认）是 - `NO`：否 **注意** 图像为动图且存在 `UIImageView.highlightedImage` 属性时： - 当 `highlighted` 为 YES 时，停止 BDImageView 的动画播放。 - 当 `highlighted` 为 NO 时，将尝试重新启动播放动图。 ### moveToWindowAnimationControl ```objectivec @property (nonatomic, assign) BOOL moveToWindowAnimationControl; ``` 当 BDImageView 从 window 中移除时，是否暂停动画播放。 - `YES`：是。暂停动画播放，下次播放从原有帧继续。 - `NO`：（默认）否。完全停止动画播放，下次播放从第一帧重新播放。 **注意** 例如在 ViewController 中调用 presentViewController 或 pushViewController 等方法导致原有 ViewController 暂时从视图树中移除时，该配置生效。 ### player ```objectivec @property (nonatomic, strong, readonly, nullable) BDAnimatedImagePlayer *player; ``` 底层实现动画的 BDAnimatedPlayer 类，控制动画的播放以及渲染相关工作，详见 [BDAnimatedPlayer](#BDAnimatedImagePlayer)。 **注意** 请尽量使用 BDImageView 的方法和属性进行访问和设置，否则两者数据容易相互脱离。 ### animateImage ```objectivec @property (nonatomic, strong, readonly, nullable) BDImage *animateImage; ``` 视图持有的动图图片。 **注意** - 如果当前视图持有的是静图，则该属性为 nil。 - 在动图渐进式加载中，若暂时只有一帧数据，该图像也会被临时认为是静图。 ### animateRunLoopMode ```objectivec @property (nonatomic, strong, nonnull) NSRunLoopMode animateRunLoopMode; ``` 动画播放的底层 Run Loop 模式。 ### animationType ```objectivec @property (nonatomic, assign) BDAnimatedImageAnimationType animationType; ``` 动画播放的播放模式，详见 [BDAnimatedImageAnimationType](1262416#BDAnimatedImageAnimationType)。 ### enableWaterLevel ```objectivec @property (nonatomic, assign) BOOL enableWaterLevel; ``` 是否开启图片渐进式加载水位控制。 - `YES`：是 - `NO`：（默认）否 **注意** - 当 animationType 模式为顺序播放时，时间计算总和为当前剩余未播放帧的动画时长总和。 - 当 animationType 模式为往复播放时，时间计算总和为当前所有帧的动画时长总和。 - 时间计算总和小于 waterLevelDuration 属性时，不允许播放。 ### waterLevelDuration ```objectivec @property (nonatomic, assign) NSTimeInterval waterLevelDuration; ``` 渐进式加载水位控制时长，单位为秒。默认值为 1，取值范围为 [0.2, 10.0]。 **注意** 该属性默认值设置在底层播放器中，直接访问无法获取默认值。 ### bd_isOpenDownsample_delay ```objectivec @property (nonatomic, assign) BOOL bd_isOpenDownsample_delay; ``` 是否待布局完成后再解码图片（降采样延迟）。 - `YES`：是 - `NO`：（默认）否 **注意** 仅在 BDImageView 且同时开启 [bd_isOpenDownsample](#UIImageView(BDWebImage)-bd_isopendownsample) ，该配置生效。 ## 函数说明 ### loopCompletionBlock ```objectivec @property (nonatomic, copy, nullable) void(^loopCompletionBlock)(void); ``` 循环播放完成回调。 - 顺序播放：播放到最后一帧图片时会触发该回调，表明该次播放循环已经结束。 - 循环播放：每次播放到最后一帧时，均会触发此回调。 **注意** 如需在动图渐进式加载中设置此回调，建议在 [imageView setImage:] 方法的 completionBlock 中设置，否则会影响部分尚未加载完成的动图的循环播放次数。 ### customLoopCompletionBlock ```objectivec @property (nonatomic, copy, nullable) void(^customLoopCompletionBlock)(void); ``` 循环播放结束回调。 - 顺序播放：播放到所有循环的最后一帧图片时会触发该回调，表明该次播放整体已经结束。 - 循环播放：播放到最后一次循环的最后一帧图片时，触发此回调。 **注意** 如需在动图渐进式加载中设置此回调，建议在 [imageView setImage:] 方法的 completionBlock 中设置，否则会影响部分尚未加载完成动图的播放循环次数。 ### firstFramePlayBlock ```objectivec @property (nonatomic, copy, nullable) void(^firstFramePlayBlock)(NSString *url); ``` 播放首帧动图回调。图片暂停、终止、从未播放的情况下，回到播放状态的时刻会触发此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSString* | 图片访问 URL。 | **注意** 以下场景均会触发该回调： 1. 在渐进式加载动图过程中，第一次获得数据以及后续获得更多数据的时刻。 2. 设置 BDImageView 的 image 属性，即调用 [BDWebImage_setImage:] 方法。 3. 来自于属性 autoPlayAnimatedImage 在 [UIView_didMoveToWindow] 中的情况。 4. 来自于属性 hightAnimationControl 在 [UIView_setHighlighted:] 中的情况。 5. 业务主动调用方法 [BDImageView_startAnimation]。 ### delayFramePlayBlock ```objectivec void delayFramePlayBlock (NSInteger index, BDProgressiveAnimatedImageDelayType animationDelayType, BDProgressiveAnimatedImageDelayState animationDelayState); ``` 图片加载延迟回调。如果到了预计播放下一帧的时刻，但是下一张图片还没有加载成功，会触发此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | NSInteger | 即将加载的图片帧数索引。 | | animationDelayType | BDProgressiveAnimatedImageDelayType | 延迟类型，详见 [BDProgressiveAnimatedImageDelayType](1262416#BDProgressiveAnimatedImageDelayType)。 | | animationDelayState | BDProgressiveAnimatedImageDelayState | 延迟状态，详见 [BDProgressiveAnimatedImageDelayState](1262416#BDProgressiveAnimatedImageDelayState)。 | ### startAnimation ```objectivec - (void)startAnimation; ``` 开启动画播放。 **注意** 播放失败原因如下所示： - 渐进式图片加载水位限制 - 该动图已经在播放中 - 当前 BDImageView 没有 window - 当前的图片不是一张动图： - 属性 `animateImage` 的值为 `nil`。 - 属性 `animateEnable` 的值为 `NO`。 ### pauseAnimation ```objectivec - (void)pauseAnimation; ``` 暂停动画播放。保持当前播放的帧，再次播放时会从当前帧继续动画播放。 ### stopAnimation ```objectivec - (void)stopAnimation; ``` 完全终止动画播放。 **注意** 在渐进式加载过程中，每次新的数据回调都会开启尝试继续播放，所以在渐进式加载完成之前，终止动画并没有意义；终止动画会设置当前的图片为第一帧图片。 ### clearImageBuffer ```objectivec - (void)clearImageBuffer; ``` 清空所有动画缓存。 **注意** 为尽量保证后续动画播放性能，对于非必须顺序解码的图片会保留当前帧和下一帧，对于必须顺序解码的图片（heic 或者 webp 格式）会完全清空，并从头播放。 **注意** 如果要使用 [UIImageView](#UIImageView(BDWebImage)) 进行动图播放（不推荐，性能劣化），请在设置图片前调用 - [ BDImage preloadAllFrame ] 方法或者在请求图片的时刻加上请求选项参数 `BDImageRequestPreloadAllFrames` 进行加载。 # NSString(BlurHash) ```objectivec @interface NSString (BlurHash) ``` 模糊图占位。 ## 静态函数 | 返回 | 名称 | | --- | --- | | NSString* | [blurHashCacheKey:](#NSString(BlurHash)-blurhashcachekey) | ## 函数说明 ### blurHashCacheKey: ```objectivec + (NSString *)blurHashCacheKey:(BDBlurHashConfig *)config; ``` 生成 BlurHash 解码后的图片的缓存键值。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | BDBlurHashConfig* | BlurHash 的解码配置，详见 [BDBlurHashConfig](1262416#BDBlurHashConfig)。 | **返回值** 缓存的键值。 **注意** 适配 NSString 的 veImageX category，提供 BlurHash 功能。 # BDWebImageUtil ```objectivec @interface BDWebImageUtil : NSObject ``` 图片工具函数类。 ## 静态函数 | 返回 | 名称 | | --- | --- | | UIImage* | [decodeImageData:imageClass:scale:decodeForDisplay:shouldScaleDown:](#BDWebImageUtil-decodeimagedata-imageclass-scale-decodefordisplay-shouldscaledown) | | UIImage* | [decodeImageData:imageClass:scale:decodeForDisplay:shouldScaleDown:downsampleSize:cropRect:error:](#BDWebImageUtil-decodeimagedata-imageclass-scale-decodefordisplay-shouldscaledown-downsamplesize-croprect-error) | | UIImage* | [decodeImageData:imageClass:decoderConfig:error:](#BDWebImageUtil-decodeimagedata-imageclass-decoderconfig-error) | | NSInteger | [isWhiteOrBlackImage:samplingPoint:](#BDWebImageUtil-iswhiteorblackimage-samplingpoint) | ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [gcdArray](#BDWebImageUtil-gcdarray) | | BOOL | [isAnimatedImageData](#BDWebImageUtil-isanimatedimagedata) | ## 函数说明 ### decodeImageData:imageClass:scale:decodeForDisplay:shouldScaleDown: ```objectivec + (UIImage * _Nullable)decodeImageData:(NSData * _Nullable)data imageClass:(__unsafe_unretained Class _Nonnull)imageClass scale:(CGFloat)scale decodeForDisplay:(BOOL)decode shouldScaleDown:(BOOL)scaleDown; ``` 解码图片，并设置类名、降采样和图片预解码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解码的图片源数据。 | | imageClass | __unsafe_unretained Class | 图片的 class，比如 UIImage 和 BDImage。 | | scale | CGFloat | 图片降采样倍数，即指定图像尺寸等比缩小的比例。取值需大于 1，取值为 2 时，表示生成图的宽高将缩小为原图尺寸的一半。 | | decode | BOOL | 是否预解码图片。

`YES`：是

`NO`：否

| | scaleDown | BOOL | 是否降采样。

`YES`：是

`NO`：否 \ |||:::tip \ |||指定为 `YES` 后，`scale` 配置才会生效。
\ |||::: \ |||

| **返回值** 解码后图片。 **注意** 支持处理的图片格式详见[能力说明](https://www.volcengine.com/docs/508/65964#ios-sdk-%E5%8A%9F%E8%83%BD%E5%88%97%E8%A1%A8)。 ### decodeImageData:imageClass:scale:decodeForDisplay:shouldScaleDown:downsampleSize:cropRect:error: ```objectivec + (UIImage * _Nullable)decodeImageData:(NSData * _Nullable)data imageClass:(__unsafe_unretained Class _Nonnull)imageClass scale:(CGFloat)scale decodeForDisplay:(BOOL)decode shouldScaleDown:(BOOL)scaleDown downsampleSize:(CGSize)size cropRect:(CGRect)cropRect error:(NSError * _Nullable __autoreleasing * _Nullable)error; ``` 解码图片，并设置类名、降采样、图片预解码、尺寸限制和裁剪区域。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解码的图片源数据。 | | imageClass | __unsafe_unretained Class | 图片的 class，比如 UIImage 和 BDImage。 | | scale | CGFloat | 图片降采样倍数，即指定图像尺寸等比缩小的比例。取值需大于 1，取值为 2 时，表示生成图的宽高将缩小为原图尺寸的一半。 | | decode | BOOL | 是否预解码图片。

`YES`：是

`NO`：否

| | scaleDown | BOOL | 是否降采样。

`YES`：是

`NO`：否 \ |||:::tip \ |||指定为 `YES` 后，`scale` 和 `size` 配置才会生效。
\ |||::: \ |||

| | size | CGSize | 指定降采样后图片的宽高。
\ |||:::tip \ |||当同时配置 `size` 和 `scale` 两种降采样参数时，配置生效优先级：`size` > `scale`。 \ |||::: \ ||| | | cropRect | CGRect | 指定原图裁剪区域。
\ |||:::tip \ |||当同时配置了裁剪和降采样时，会首先根据 `cropRect` 对原图进行裁剪，然后再对裁剪后图片执行降采样处理。 \ |||::: \ ||| | | error | NSError* __autoreleasing* | 解码错误码，可以为 nil。 | **返回值** 解码后图片，若失败会向 error 参数中设值。 **注意** 支持处理的图片格式详见[能力说明](https://www.volcengine.com/docs/508/65964#ios-sdk-%E5%8A%9F%E8%83%BD%E5%88%97%E8%A1%A8)。 ### decodeImageData:imageClass:decoderConfig:error: ```objectivec + (UIImage * _Nullable)decodeImageData:(NSData * _Nullable)data imageClass:(__unsafe_unretained Class _Nonnull)imageClass decoderConfig:(BDImageDecoderConfig * _Nonnull)config error:(NSError * _Nullable __autoreleasing * _Nullable)error; ``` 解码图片，并设置类名、自定义解码配置和解码错误码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解码的图片源数据。 | | imageClass | __unsafe_unretained Class | 图片的 class，比如 UIImage 和 BDImage。 | | config | BDImageDecoderConfig* | 解码配置，详见 [BDImageDecoderConfig](#BDImageDecoderConfig)。 | | error | NSError* __autoreleasing* | 解码错误码，可以为 nil。 | **返回值** 解码后图片，若失败会向 error 参数中设值。 **注意** 支持处理的图片格式详见[能力说明](https://www.volcengine.com/docs/508/65964#ios-sdk-%E5%8A%9F%E8%83%BD%E5%88%97%E8%A1%A8)。 ### isWhiteOrBlackImage:samplingPoint: ```objectivec + (NSInteger)isWhiteOrBlackImage:(UIImage *_Nonnull)image samplingPoint:(NSInteger)samplingPoint; ``` 判断图片是否出现白屏或黑屏。 - `0`：正常图片 - `1`：黑屏 - `2`：白屏 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | UIImage* | 解码后图片。 | | samplingPoint | NSInteger | 自定义采样点数，默认为 30。 | **返回值** 判断结果。 ### gcdArray ```objectivec int gcdArray( int n, int a[_Nonnull n] ); ``` 计算数组中所有数的最大公约数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | n | int | 数组长度。 | | a | int[ n] | 数组。 | **返回值** 数组中所有数的最大公约数。 ### isAnimatedImageData ```objectivec BOOL isAnimatedImageData(NSData *_Nonnull data); ``` 判断图片是否为动图。 - `YES`：是 - `NO`：否 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 图片源数据。 | **返回值** 判断结果。 # BDBlockTransformer ```objectivec @interface BDBlockTransformer : BDBaseTransformer ``` 使用自定义 block 对图片进行处理的 Transformer 类。 ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [transformWithBlock:](#BDBlockTransformer-transformwithblock) | ## 函数说明 ### transformWithBlock: ```objectivec + (nonnull instancetype)transformWithBlock:(nonnull BDTransformBlock)block; ``` 通过 block 来创建 Transformer 实例。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | block | BDTransformBlock | 对图片进行处理的 block，定义为 typedef UIImage * _Nullable (^BDTransformBlock)(UIImage *_Nullable image)。 | **返回值** 返回一个 BDBlockTransformer 类。 # BDImageDecoder ```objectivec @protocol BDImageDecoder ``` 不同图片格式解码器需实现的协议。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDImageCodeType | [codeType](#BDImageDecoder-codetype) | | NSError* | [error](#BDImageDecoder-error) | | NSData* | [data](#BDImageDecoder-data) | | NSString* | [filePath](#BDImageDecoder-filepath) | | BOOL | [progressiveDownloading](#BDImageDecoder-progressivedownloading) | | UIImageOrientation | [imageOrientation](#BDImageDecoder-imageorientation) | | NSUInteger | [imageCount](#BDImageDecoder-imagecount) | | CGSize | [originSize](#BDImageDecoder-originsize) | | BDImageDecoderSizeType | [sizeType](#BDImageDecoder-sizetype) | | BDImageDecoderConfig* | [config](#BDImageDecoder-config) | ## 静态函数 | 返回 | 名称 | | --- | --- | | BOOL | [supportProgressDecode:](#BDImageDecoder-supportprogressdecode) | | BOOL | [supportStaticProgressDecode:](#BDImageDecoder-supportstaticprogressdecode) | | BOOL | [canDecode:](#BDImageDecoder-candecode) | | BOOL | [isAnimatedImage:](#BDImageDecoder-isanimatedimage) | ## 成员函数 | 返回 | 名称 | | --- | --- | | instancetype | [initWithData:](#BDImageDecoder-initwithdata) | | instancetype | [initWithData:config:](#BDImageDecoder-initwithdata-config) | | instancetype | [initWithContentOfFile:](#BDImageDecoder-initwithcontentoffile) | | CGImageRef | [copyImageAtIndex:](#BDImageDecoder-copyimageatindex) | | CFTimeInterval | [frameDelayAtIndex:](#BDImageDecoder-framedelayatindex) | | instancetype | [initWithIncrementalData:config:](#BDImageDecoder-initwithincrementaldata-config) | | void | [changeDecoderWithData:finished:](#BDImageDecoder-changedecoderwithdata-finished) | ## 变量说明 ### codeType ```objectivec @property (nonatomic, assign, readonly) BDImageCodeType codeType; ``` 解码器对应图片格式，详见 [BDImageCodeType](1262416#BDImageCodeType)。 ### error ```objectivec @property (nonatomic, strong, readonly, nullable) NSError *error; ``` 解码错误码。 ### data ```objectivec @property (nonatomic, strong, readonly, nullable) NSData *data; ``` 图片源数据。 ### filePath ```objectivec @property (nonatomic, copy, readonly, nullable) NSString *filePath; ``` 本地路径。 **注意** 仅当从本地读取图片数据进行解码时，有返回值。 ### progressiveDownloading ```objectivec @property (nonatomic, assign, readonly) BOOL progressiveDownloading; ``` 解码图片是否为渐进式加载。 - `YES`：是 - `NO`：否 ### imageOrientation ```objectivec @property (nonatomic, assign, readonly) UIImageOrientation imageOrientation; ``` 图片旋转信息。 ### imageCount ```objectivec @property (nonatomic, assign, readonly) NSUInteger imageCount; ``` 图片帧数。 **注意** 静图为 1。 ### originSize ```objectivec @property (nonatomic, assign, readonly) CGSize originSize; ``` 原始图片尺寸大小。 ### sizeType ```objectivec @property (nonatomic, assign, readonly) BDImageDecoderSizeType sizeType; ``` 图片尺寸操作类型，详见 [BDImageDecoderSizeType](1262416#BDImageDecoderSizeType)。 ### config ```objectivec @property (nonatomic, strong, readonly, nullable) BDImageDecoderConfig *config; ``` 解码配置，详见 [BDImageDecoderConfig](#BDImageDecoderConfig)。 ## 函数说明 ### supportProgressDecode: ```objectivec + (BOOL)supportProgressDecode:(NSData * _Nonnull)data; ``` 判断当前解码器是否支持动图渐进式加载。 - `YES`：是 - `NO`：否 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解析的图片数据。 | **返回值** 判断结果。 **注意** 目前支持 gif、heif 和 awebp 动图渐进式加载。 ### supportStaticProgressDecode: ```objectivec + (BOOL)supportStaticProgressDecode:(BDImageCodeType)type; ``` 判断当前解码器是否支持动图和静图的渐进式加载。 - `YES`：是 - `NO`：否 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | BDImageCodeType | 当前需要解码的图片格式。 | **返回值** 判断结果。 **注意** 目前支持 jpeg 和 png 静图渐进式，heic 静图渐进式参考 [BDThumbImageDecoder](#BDThumbImageDecoder)。 ### canDecode: ```objectivec + (BOOL)canDecode:(NSData * _Nonnull)data; ``` 判断当前数据是否能被解码。 - `YES`：是 - `NO`：否 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解析的图片数据。 | **返回值** 判断结果。 ### isAnimatedImage: ```objectivec + (BOOL)isAnimatedImage:(NSData * _Nonnull)data; ``` 判断当前数据是否是动图。 - `YES`：是 - `NO`：否 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解析的图片数据。 | **返回值** 判断结果。 ### initWithData: ```objectivec - (instancetype _Nullable)initWithData:(NSData * _Nullable)data; ``` 解码器初始化。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解码的图片数据。 | **返回值** 初始化后的解码器。 ### initWithData:config: ```objectivec - (instancetype _Nullable)initWithData:(NSData * _Nullable)data config:(BDImageDecoderConfig * _Nullable)config; ``` 解码器初始化。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 需要解码的图片数据。 | | config | BDImageDecoderConfig* | 解码器配置，详见 [BDImageDecoderConfig](#BDImageDecoderConfig)。 | **返回值** 初始化后的解码器。 ### initWithContentOfFile: ```objectivec - (instancetype _Nullable)initWithContentOfFile:(NSString * _Nullable)file; ``` 解码器初始化，对本地图片进行解码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | file | NSString* | 本地路径。 | **返回值** 初始化后的解码器。 ### copyImageAtIndex: ```objectivec - (CGImageRef _Nullable)copyImageAtIndex:(NSUInteger)index; ``` 解码图片某一帧。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | NSUInteger | 帧的下标。 | **返回值** 解码成功后返回 CGImageRef 类型的图片。 **注意** 解码静图时，固定取值 `0`。 ### frameDelayAtIndex: ```objectivec - (CFTimeInterval)frameDelayAtIndex:(NSUInteger)index; ``` 帧与帧的间隔时间。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | NSUInteger | 帧的下标。 | **返回值** 帧与帧的间隔时间。 ### initWithIncrementalData:config: ```objectivec - (instancetype _Nullable)initWithIncrementalData:(NSData * _Nonnull)data config:(BDImageDecoderConfig * _Nullable)config; ``` 用于渐进式加载的解码器初始化方法。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 当前接收的图片数据。 | | config | BDImageDecoderConfig* | 解码器配置。 | **返回值** 初始化后的解码器。 ### changeDecoderWithData:finished: ```objectivec - (void)changeDecoderWithData:(NSData * _Nonnull)data finished:(BOOL)finished; ``` 渐进式加载解码时，更新解码器的图片数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | NSData* | 新的图片数据。 | | finished | BOOL | 渐进式加载是否结束。

`YES`：是

`NO`：否

| # BDWebImageManager ```objectivec @interface BDWebImageManager : NSObject ``` 图片库主控模块，图片库缓存、解码、下载、降采样和日志等配置处，还包括预加载、直接图片请求 API 等功能的设置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDWebImageManager* | [sharedManager](#BDWebImageManager-sharedmanager) | | BOOL | [enableLog](#BDWebImageManager-enablelog) | | BDImageCache* | [imageCache](#BDWebImageManager-imagecache) | | BOOL | [insulatedCache](#BDWebImageManager-insulatedcache) | | BOOL | [enableCacheToMemory](#BDWebImageManager-enablecachetomemory) | | BOOL | [enableCacheToDisk](#BDWebImageManager-enablecachetodisk) | | BOOL | [isCDNdowngrade](#BDWebImageManager-iscdndowngrade) | | BOOL | [isSmartCropIgnoreDowngrade](#BDWebImageManager-issmartcropignoredowngrade) | | BOOL | [isDecoderForDisplay](#BDWebImageManager-isdecoderfordisplay) | | BOOL | [isSystemHeicDecoderFirst](#BDWebImageManager-issystemheicdecoderfirst) | | BOOL | [isCustomSequenceHeicsDecoderFirst](#BDWebImageManager-iscustomsequenceheicsdecoderfirst) | | BOOL | [enableRepackHeicData](#BDWebImageManager-enablerepackheicdata) | | BOOL | [enableRemoveRedundantThumbDecode](#BDWebImageManager-enableremoveredundantthumbdecode) | | BDShouldDecodeImageCallback | [shouldDecodeImageBlock](#BDWebImageManager-shoulddecodeimageblock) | | BDWebImageShouldDecodeImageFromType | [shouldDecodeImageFromType](#BDWebImageManager-shoulddecodeimagefromtype) | | BDShouldRequestNetImageCallback | [shouldRequestNetImageBlock](#BDWebImageManager-shouldrequestnetimageblock) | | BDWebImageURLFilter* | [urlFilter](#BDWebImageManager-urlfilter) | | NSDictionary\* | [downloadManagerDefaultHeaders](#BDWebImageManager-downloadmanagerdefaultheaders) | | CFTimeInterval | [timeoutInterval](#BDWebImageManager-timeoutinterval) | | CFTimeInterval | [timeoutIntervalForResource](#BDWebImageManager-timeoutintervalforresource) | | BOOL | [checkMimeType](#BDWebImageManager-checkmimetype) | | BOOL | [checkDataLength](#BDWebImageManager-checkdatalength) | | NSInteger | [maxConcurrentTaskCount](#BDWebImageManager-maxconcurrenttaskcount) | | NSInteger | [maxRetryCount](#BDWebImageManager-maxretrycount) | | BOOL | [enableAdaptiveDecode](#BDWebImageManager-enableadaptivedecode) | | NSString* | [adaptiveDecodePolicy](#BDWebImageManager-adaptivedecodepolicy) | | BOOL | [isCocurrentCallback](#BDWebImageManager-iscocurrentcallback) | | BOOL | [isPrefetchLowPriority](#BDWebImageManager-isprefetchlowpriority) | | BOOL | [isPrefetchIgnoreImage](#BDWebImageManager-isprefetchignoreimage) | | BOOL | [isNoticeLoadImage](#BDWebImageManager-isnoticeloadimage) | | BOOL | [enableAllImageDownsample](#BDWebImageManager-enableallimagedownsample) | | CGSize | [allImageDownsampleSize](#BDWebImageManager-allimagedownsamplesize) | | NSUInteger | [allImageDownsampleMemory](#BDWebImageManager-allimagedownsamplememory) | | BOOL | [isCacheMonitorEnable](#BDWebImageManager-iscachemonitorenable) | | NSInteger | [cacheMonitorInterval](#BDWebImageManager-cachemonitorinterval) | | BOOL | [enableSensibleMonitorWithLogType](#BDWebImageManager-enablesensiblemonitorwithlogtype) | | NSInteger | [sensibleMonitorSamplingIndex](#BDWebImageManager-sensiblemonitorsamplingindex) | | BOOL | [isMonitorLargeImage](#BDWebImageManager-ismonitorlargeimage) | | BDLargeImageMonitorCallBack | [largeImageMonitorCallBack](#BDWebImageManager-largeimagemonitorcallback) | | BDWebImageBizTagURLFilterBlock | [bizTagURLFilterBlock](#BDWebImageManager-biztagurlfilterblock) | | BDWebImageSceneTagURLFilterBlock | [sceneTagURLFilterBlock](#BDWebImageManager-scenetagurlfilterblock) | | NSArray\* | [allPrefetchs](#BDWebImageManager-allprefetchs) | ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [sharedManager](#BDWebImageManager-sharedmanager-2) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [startUpWithConfig:](#BDWebImageManager-startupwithconfig) | | instancetype | [initWithCategory:](#BDWebImageManager-initwithcategory) | | void | [registCache:forKey:](#BDWebImageManager-registcache-forkey) | | BDImageCache | [cacheForKey:](#BDWebImageManager-cacheforkey) | | void | [cancelAllPrefetchs](#BDWebImageManager-cancelallprefetchs) | | BDWebImageRequest | [requestsWithCategory:](#BDWebImageManager-requestswithcategory) | | void | [cancelAll](#BDWebImageManager-cancelall) | | void | [requestImage:](#BDWebImageManager-requestimage) | | BDWebImageRequest | [requestImage:alternativeURLs:options:size:timeoutInterval:cacheName:transformer:decryptBlock:progress:complete:](#BDWebImageManager-requestimage-alternativeurls-options-size-timeoutinterval-cachename-transformer-decryptblock-progress-complete) | | BDWebImageRequest | [requestImage:options:complete:](#BDWebImageManager-requestimage-options-complete) | | BDWebImageRequest | [requestImage:progress:complete:](#BDWebImageManager-requestimage-progress-complete) | | BDWebImageRequest | [requestImage:alternativeURLs:options:cacheName:progress:complete:](#BDWebImageManager-requestimage-alternativeurls-options-cachename-progress-complete) | | BDWebImageRequest | [requestImage:alternativeURLs:options:cacheName:transformer:progress:complete:](#BDWebImageManager-requestimage-alternativeurls-options-cachename-transformer-progress-complete) | | BDWebImageRequest | [requestImage:alternativeURLs:options:timeoutInterval:cacheName:transformer:progress:complete:](#BDWebImageManager-requestimage-alternativeurls-options-timeoutinterval-cachename-transformer-progress-complete) | | BDWebImageRequest | [requestImage:alternativeURLs:options:timeoutInterval:cacheName:transformer:decryptBlock:progress:complete:](#BDWebImageManager-requestimage-alternativeurls-options-timeoutinterval-cachename-transformer-decryptblock-progress-complete) | | BDWebImageRequest | [requestImage:options:size:complete:](#BDWebImageManager-requestimage-options-size-complete) | | BDWebImageRequest | [requestImage:alternativeURLs:options:config:blocks:](#BDWebImageManager-requestimage-alternativeurls-options-config-blocks) | | BDWebImageRequest | [prefetchImageWithURL:category:options:config:blocks:](#BDWebImageManager-prefetchimagewithurl-category-options-config-blocks) | | BDWebImageRequest | [prefetchImagesWithURLs:category:options:](#BDWebImageManager-prefetchimageswithurls-category-options) | | BDWebImageRequest | [prefetchImagesWithURLs:cacheName:category:options:](#BDWebImageManager-prefetchimageswithurls-cachename-category-options) | | BDWebImageRequest | [prefetchImageWithURL:category:options:](#BDWebImageManager-prefetchimagewithurl-category-options) | | BDWebImageRequest | [prefetchImageWithURL:cacheName:category:options:](#BDWebImageManager-prefetchimagewithurl-cachename-category-options) | | BDWebImageRequest | [prefetchImageWithURL:category:options:config:](#BDWebImageManager-prefetchimagewithurl-category-options-config) | ## 变量说明 ### sharedManager ```objectivec @property(class, readonly, nonnull) BDWebImageManager *sharedManager; ``` 公用 BDWebImageManger 实例，非特殊必要请勿创建新的管理类。 ### enableLog ```objectivec @property (nonatomic, assign) BOOL enableLog; ``` 是否在控制台记录日志。 - `YES`：是 - `NO`：（默认）否 ### imageCache ```objectivec @property (nonatomic, retain, readonly, nonnull) BDImageCache *imageCache; ``` 默认缓存位置，如果当前请求没有指定缓存，那么会使用该默认缓存管理。 **注意** - 查询缓存逻辑：若当前开启 insulatedCache 属性，且当前图片请求的 cacheName 属性不为 nil，那么只会向注册为 cacheName 名字的缓存中查找，如果没有找到图片缓存则默认无法找到图片缓存，不继续查找；否则会查找所有缓存，不受 cacheName 属性限制。 - 存放缩略图逻辑（heic 渐进式）：若当前图片请求的 cacheName 属性不为 nil，会向相同名字的缓存存放缩略图缓存，如果不存在，那么不存缓存；否则向该默认缓存中存放缩略图缓存。 - 存放正常图片缓存：若当前图片请求的 cacheName 属性不为 nil，会向相同名字的缓存存放图片缓存；若 cacheName 属性为 nil 或者找不到同名缓存，那么向该默认缓存中存放图片缓存。 ### insulatedCache ```objectivec @property (nonatomic, assign) BOOL insulatedCache; ``` 是否只查询指定缓存。 - `YES`：是 - `NO`：否 **注意** 若当前开启 insulatedCache 属性，且当前图片请求的 cacheName 属性不为 nil，那么只会向注册为 cacheName 名字的缓存中查找，如果没有找到图片缓存则默认无法找到图片缓存，不继续查找；否则会查找所有缓存，不受 cacheName 属性限制。 ### enableCacheToMemory ```objectivec @property (nonatomic, assign) BOOL enableCacheToMemory; ``` 是否开启内存缓存。 - `YES`：（默认）是 - `NO`：否。将不储存内存缓存方案。 ### enableCacheToDisk ```objectivec @property (nonatomic, assign) BOOL enableCacheToDisk; ``` 是否开启磁盘缓存。 - `YES`：（默认）是 - `NO`：否。将不储存磁盘缓存方案 ### isCDNdowngrade ```objectivec @property (nonatomic, assign) BOOL isCDNdowngrade; ``` 是否开启 CDN 降级策略。 - `YES`：（默认）是。开启后图片缓存最多只能存放在内存缓存，不可以加入磁盘缓存。 - `NO`：否 **注意** CDN 降级策略需要满足以下条件： 1. 指定本属性为 `YES`； 2. 图片请求的 HTTP 中夹带 cache-control 时间小于 1 小时； 3. 图片请求选项中没有携带 `BDImageRequestIgnoreCDNDowngrade` 忽略 CDN 降级属性； 4. 图片携带智能裁剪数据，并且 `BDWebImageManager.BDImageRequestIgnoreCDNDowngrade = NO` 全局不忽略智能裁剪降级。 ### isSmartCropIgnoreDowngrade ```objectivec @property (nonatomic, assign) BOOL isSmartCropIgnoreDowngrade; ``` 智能裁剪是否忽略 CDN 降级选项，可以直接存储磁盘缓存。 - `YES`：是 - `NO`：（默认）否 ### isDecoderForDisplay ```objectivec @property (nonatomic, assign) BOOL isDecoderForDisplay; ``` 是否预解码，面向全局控制。 - `YES`：（默认）是 - `NO`：否 **注意** 开启后会提前加载图片，会导致 FPS 提高，但对于大图短时间内会出现内存峰值增高。 ### isSystemHeicDecoderFirst ```objectivec @property (nonatomic, assign) BOOL isSystemHeicDecoderFirst; ``` 是否优先使用系统硬件解码。 - `YES`：（默认）是 - `NO`：否 **注意** 适用静图。由于系统黑盒硬解不稳定，建议此处设置为 `NO`。 ### isCustomSequenceHeicsDecoderFirst ```objectivec @property (nonatomic, assign) BOOL isCustomSequenceHeicsDecoderFirst; ``` 是否优先使用自研软件解码方案，解码 heif 动图。 - `YES`：（默认）是 - `NO`：否 **注意** 适用动图。当大量 heif 动图并发渲染时，使用系统 heif 动图解码会存在渲染黑屏问题。推荐使用自研软解。 ### enableRepackHeicData ```objectivec @property (nonatomic, assign) BOOL enableRepackHeicData; ``` 对于包含缩略图的返回 heic 图片原始数据，是否删除其中的 heic 缩略图数据。 - `YES`：是 - `NO`：（默认）否 **注意** 非必要请勿开启 (影响性能)。 ### enableRemoveRedundantThumbDecode ```objectivec @property (nonatomic, assign) BOOL enableRemoveRedundantThumbDecode; ``` 在解码 heic 缩略图过程中，如果发现 HTTP 请求中当前收到的数据大于 Content-Length 的值，选择是否取消当前 heic 缩略图解码。 - `YES`：是 - `NO`：（默认）否 ### shouldDecodeImageBlock ```objectivec @property (nonatomic, copy) BDShouldDecodeImageCallback shouldDecodeImageBlock; ``` 判断是否加载当前图片，仅限于非渐进式加载使用。 **注意** 若判断不进行加载，则会返回对应图片的 NSData 数据。如果通过 UIImageView (BDWebImage) category 加载，则会导致图片显示失败 (返回数据没有图片)。 ### shouldDecodeImageFromType ```objectivec @property (nonatomic, assign, class) BDWebImageShouldDecodeImageFromType shouldDecodeImageFromType; ``` 判断是否对网络下载或磁盘缓存的图片进行解码前拦截，详见 [BDWebImageShouldDecodeImageFromType](1262416#BDWebImageShouldDecodeImageFromType)。 ### shouldRequestNetImageBlock ```objectivec @property (nonatomic, copy, nullable) BDShouldRequestNetImageCallback shouldRequestNetImageBlock; ``` 判断是否通过网络请求获取当前图片，仅限于非渐进式加载使用。默认值为 nil，表示所有 url 均会请求网络图片。 **注意** 即使在回调中判断当前图片不需要网络请求，但内部仍然会尝试查找本地缓存来获取图片。 ### urlFilter ```objectivec @property (nonatomic, strong, nullable) BDWebImageURLFilter *urlFilter; ``` 使指向同一张图片的不同的 URL 具有相同的 requestKey。 ### downloadManagerDefaultHeaders ```objectivec @property (nonatomic, copy) NSDictionary *downloadManagerDefaultHeaders; ``` 设置当前请求的默认 headers。 **注意** - 设置完成后，下一次的请求的 http request default headers 会被更新。 - 该设置并非线程安全，建议只在主线程设置。 ### timeoutInterval ```objectivec @property (nonatomic, assign) CFTimeInterval timeoutInterval; ``` 设置服务器响应的默认超时时间。 **注意** 需要在 BDWebImageManager 进行第一个图片访问前设置，否则无效。 ### timeoutIntervalForResource ```objectivec @property (nonatomic, assign) CFTimeInterval timeoutIntervalForResource; ``` 设置资源下载的默认超时时间。 ### checkMimeType ```objectivec @property (nonatomic, assign) BOOL checkMimeType; ``` 是否进行下载内容类型校验。 - `YES`：（默认）是 - `NO`：否 **注意** 若 http 下载为通过校验，会自动切换使用 https 重试下载。 ### checkDataLength ```objectivec @property (nonatomic, assign) BOOL checkDataLength; ``` 是否进行下载内容长度校验。 - `YES`：（默认）是 - `NO`：否 **注意** - 若 http 下载为通过校验，会自动切换使用 https 重试下载。 - 如果 HTTP header Content-Length 大小和数据大小相同，即可通过校验。 ### maxConcurrentTaskCount ```objectivec @property (nonatomic, assign) NSInteger maxConcurrentTaskCount; ``` 设置最大同时网络下载任务，默认值为 10。 ### maxRetryCount ```objectivec @property (nonatomic, assign) NSInteger maxRetryCount; ``` 设置全局最大重试次数，默认值为 3。 **注意** 该属性优先级低于 BDWebImageRequest 的 [maxRetryCount](#BDWebImageRequest-maxretrycount) 属性。 ### enableAdaptiveDecode ```objectivec @property (nonatomic, assign) BOOL enableAdaptiveDecode; ``` 是否开启格式自适应，控制在 HTTP 请求数据格式的时刻，Accept 参数的数据是否通过配置下发控制。 - `YES`：是 - `NO`：（默认）否，表示统一使用 image / * 作为 Accept 请求参数。 ### adaptiveDecodePolicy ```objectivec @property (readonly, nonnull) NSString *adaptiveDecodePolicy; ``` - 读取：可获得当前 Accept 的参数。 - 设置：可改变在 enableAdaptiveDecode 属性未开启时的 Accept 参数，默认为 `image / *`。 ### isCocurrentCallback ```objectivec @property (nonatomic, assign) BOOL isCocurrentCallback; ``` 设置 TTNet 数据回调是否并发处理。 - `YES`：是 - `NO`：（默认）否。表示串行处理。 **注意** 需要在 BDWebImageManager 启动前设置。 ### isPrefetchLowPriority ```objectivec @property (nonatomic, assign) BOOL isPrefetchLowPriority; ``` 是否给预加载的网络请求强制加上 [BDImageRequestIgnoreQueue](1262416#枚举值-4) 属性。 - `YES`：（默认）是 - `NO`：否 ### isPrefetchIgnoreImage ```objectivec @property (nonatomic, assign) BOOL isPrefetchIgnoreImage; ``` 是否给预加载的网络请求强制加上 [BDImageRequestIgnoreImage](1262416#枚举值-4) 属性。 - `YES`：是 - `NO`：（默认）否 **注意** 指定为 `YES` 后，预加载的时刻不会再进行图片解码操作，也不会向内存存放图片缓存。 ### isNoticeLoadImage ```objectivec @property (nonatomic, assign) BOOL isNoticeLoadImage; ``` 是否开启加载图片通知。 - `YES`：是 - `NO`：（默认）否 **注意** - kBDWebImageStartRequestImage：表示图片开始请求通知 - kBDWebImageDownLoadImageFinish：表示图片下载结束通知。 ### enableAllImageDownsample ```objectivec @property (nonatomic, assign) BOOL enableAllImageDownsample; ``` 是否开启全局降采样。 - `YES`：是 - `NO`：（默认）否 **注意** 对于需要旋转缩放动画的 View 不推荐开启降采样。对于需要支持旋转缩放动画的图片建议添加 [BDImageNotDownsample](1262416#枚举值-4) 选项禁用该次降采样请求。 ### allImageDownsampleSize ```objectivec @property (nonatomic, assign) CGSize allImageDownsampleSize; ``` 设置全局降采样图片尺寸大小。单位为 point。适用于已开启全局降采样，但没有初始化 view 的 size 属性。 **注意** 单位是 point，对应在屏幕上的点，而不是像素，内部会自动与 UIScreen.mainScreen.scale 计算像素。 ### allImageDownsampleMemory ```objectivec @property (nonatomic, assign) NSUInteger allImageDownsampleMemory; ``` 设置全局降采样图片内存大小。单位为 byte。适用于已开启全局降采样，但没有初始化 view 的 size 属性和 allImageDownsampleSize 属性。 ### isCacheMonitorEnable ```objectivec @property (nonatomic, assign) BOOL isCacheMonitorEnable; ``` 是否开启 image_cache_hit_monitor 缓存日志上报开关，用于统计缓存命中次数。 - `YES`：是 - `NO`：（默认）否 ### cacheMonitorInterval ```objectivec @property (nonatomic, assign) NSInteger cacheMonitorInterval; ``` 设置 image_cache_hit_monitor 缓存日志上报时间间隔，单位为秒。 **注意** 最低值为 60 秒，设置低于 60 秒会被强制设置为 60 秒。 ### enableSensibleMonitorWithLogType ```objectivec @property (nonatomic, assign) BOOL enableSensibleMonitorWithLogType; ``` 是否开启 image_sensible_monitor 感知日志开关。 - `YES`：是 - `NO`：（默认）否 ### sensibleMonitorSamplingIndex ```objectivec @property (nonatomic, assign) NSInteger sensibleMonitorSamplingIndex; ``` 感知日志采样设置，取值需大于 0。默认值为 10，表示满足 10 条数据后会丢弃前 9 条数据上传第 10 条数据。 ### isMonitorLargeImage ```objectivec @property (nonatomic, assign) BOOL isMonitorLargeImage; ``` 是否开启 image_monitor_exceed_limit_v2 大图日志开关。 - `YES`：是 - `NO`：（默认）否 ### largeImageMonitorCallBack ```objectivec @property (nonatomic, copy, nullable) BDLargeImageMonitorCallBack largeImageMonitorCallBack; ``` 大图监控信息回调，业务方可自定义上报处理，不影响自有上报逻辑。 ### bizTagURLFilterBlock ```objectivec @property (nonatomic, copy, nullable) BDWebImageBizTagURLFilterBlock bizTagURLFilterBlock; ``` 获取 app 业务标识 biz_tag。 **注意** 推荐使用该方法设置 biz_tag，若不设置，则会查询 url 中是否带有参数 biz_tag 或 from 作为最终的 biz_tag。 ### sceneTagURLFilterBlock ```objectivec @property (nonatomic, copy, nullable) BDWebImageSceneTagURLFilterBlock sceneTagURLFilterBlock; ``` 获取 app 场景标识 scene_tag。 **注意** 该设置优先级低于 BDWebImageRequestConfig 设置的 sceneTag 优先级。 ### allPrefetchs ```objectivec @property(atomic, readonly) NSArray *allPrefetchs; ``` 当前正在执行的所有预加载图片加载请求。 ## 函数说明 ### sharedManager ```objectivec + (instancetype)sharedManager; ``` 公用 BDWebImageManger 实例，非特殊必要请勿创建新的管理类。 **返回值** BDWebImageManger 实例 ### startUpWithConfig: ```objectivec - (void)startUpWithConfig:(BDWebImageStartUpConfig *)config; ``` BDWebImageManager 模块的初始化。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | BDWebImageStartUpConfig* | 用于初始化的配置类。 | **注意** 不推荐业务自己直接调用此处初始化，推荐通过 TTSDKManager 来进行初始化。 ### initWithCategory: ```objectivec - (instancetype)initWithCategory:(NSString * _Nullable)category NS_DESIGNATED_INITIALIZER; ``` 根据指定的业务类型初始化一个 Manager 实例，与默认实例隔离。非特殊必要请勿创建新的管理类。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | category | NSString* | 业务类型。 | **返回值** BDWebImageManger 实例。 **注意** category 传空的话会返回公用实例 sharedManager。 ### registCache:forKey: ```objectivec - (void)registCache:(BDImageCache *)cache forKey:(NSString *)key; ``` 注册不同的缓存实例，可以有独立不同的缓存策略。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | cache | BDImageCache* | 缓存实例。 | | key | NSString* | 注册的缓存实例的名称。 | ### cacheForKey: ```objectivec - (BDImageCache *)cacheForKey:(NSString *)key; ``` 查询缓存实例。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 查询的缓存实例的名称。 | ### cancelAllPrefetchs ```objectivec - (void)cancelAllPrefetchs; ``` 取消所有的预加载图片请求。 ### requestsWithCategory: ```objectivec - (NSArray *)requestsWithCategory:(NSString * _Nonnull)category; ``` 返回指定请求。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | category | NSString* | 需要返回的请求类型。 | **注意** 该函数只支持预加载时返回。 ### cancelAll ```objectivec - (void)cancelAll; ``` 取消所有的加载图片请求。 ### requestImage: ```objectivec - (void)requestImage:(BDWebImageRequest * _Nonnull)request; ``` 实际图片请求方法。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | request | BDWebImageRequest* | 图片请求的实例，详见 [BDWebImageRequest](#BDWebImageRequest)。 | **注意** 业务上可以自行创建图片请求的实例，并通过该接口进行图片请求，可以最大化定制请求。 ### requestImage:alternativeURLs:options:size:timeoutInterval:cacheName:transformer:decryptBlock:progress:complete: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url alternativeURLs:(NSArray * _Nullable)alternativeURLs options:(BDImageRequestOptions)options size:(CGSize)size timeoutInterval:(CFTimeInterval)timeoutInterval cacheName:(NSString * _Nullable)cacheName transformer:(BDBaseTransformer * _Nullable)transformer decryptBlock:(BDImageRequestDecryptBlock _Nullable)decryptBlock progress:(BDImageRequestProgressBlock _Nullable)progress complete:(BDImageRequestCompletedBlock _Nullable)complete; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 请求图片的 URL，可以支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray\* | 当前备选图片请求链接，可以传入 nil。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | size | CGSize | 当前图片期望请求的大小，传入 CGSizeZero 表示不进行操作。 | | timeoutInterval | CFTimeInterval | 网络请求的超时时间，传入 0 使用默认超时。 | | cacheName | NSString* | 当前期望的缓存实例。 | | transformer | BDBaseTransformer* | 图片加工工具。 | | decryptBlock | BDImageRequestDecryptBlock | 图片解密工具，图片下载后如果是加密状态则会通过该回调进行解密之后再解码，设置后会默认添加 [BDImageRequestNotVerifyData](1262416#枚举值-4) 属性。 | | progress | BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | complete | BDImageRequestCompletedBlock | 图片下载完成，或者部分解码成功，或者缩略图解码成功，都会通过该 block 进行数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### requestImage:options:complete: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url options:(BDImageRequestOptions)options complete:(BDImageRequestCompletedBlock _Nullable)complete; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前请求图片的 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | complete | BDImageRequestCompletedBlock | 图片下载完成，或者部分解码成功，或者缩略图解码成功，都会通过该 block 进行数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### requestImage:progress:complete: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url progress:(BDImageRequestProgressBlock _Nullable)progress complete:(BDImageRequestCompletedBlock _Nullable)complete; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前请求图片的 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | progress | BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | complete | BDImageRequestCompletedBlock | 图片下载完成，或者部分解码成功，或者缩略图解码成功，都会通过该 block 进行数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### requestImage:alternativeURLs:options:cacheName:progress:complete: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url alternativeURLs:(NSArray * _Nullable)alternativeURLs options:(BDImageRequestOptions)options cacheName:(NSString * _Nullable)cacheName progress:(BDImageRequestProgressBlock _Nullable)progress complete:(BDImageRequestCompletedBlock _Nullable)complete; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前请求图片的 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray\* | 当前备选图片请求链接，可以传入 nil。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | cacheName | NSString* | 当前期望的缓存实例。 | | progress | BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | complete | BDImageRequestCompletedBlock | 图片下载完成，或者部分解码成功，或者缩略图解码成功，都会通过该 block 进行数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### requestImage:alternativeURLs:options:cacheName:transformer:progress:complete: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url alternativeURLs:(NSArray * _Nullable)alternativeURLs options:(BDImageRequestOptions)options cacheName:(NSString * _Nullable)cacheName transformer:(BDBaseTransformer * _Nullable)transformer progress:(BDImageRequestProgressBlock _Nullable)progress complete:(BDImageRequestCompletedBlock _Nullable)complete; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前请求图片的 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray\* | 当前备选图片请求链接，可以传入 nil。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | cacheName | NSString* | 当前期望的缓存实例。 | | transformer | BDBaseTransformer* | 图片加工工具。 | | progress | BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | complete | BDImageRequestCompletedBlock | 图片下载完成，或者部分解码成功，或者缩略图解码成功，都会通过该 block 进行数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### requestImage:alternativeURLs:options:timeoutInterval:cacheName:transformer:progress:complete: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url alternativeURLs:(NSArray * _Nullable)alternativeURLs options:(BDImageRequestOptions)options timeoutInterval:(CFTimeInterval)timeoutInterval cacheName:(NSString * _Nullable)cacheName transformer:(BDBaseTransformer * _Nullable)transformer progress:(BDImageRequestProgressBlock _Nullable)progress complete:(BDImageRequestCompletedBlock _Nullable)complete; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前请求图片的 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray\* | 当前备选图片请求链接，可以传入 nil。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | timeoutInterval | CFTimeInterval | 网络请求的超时时间，传入 0 使用默认超时。 | | cacheName | NSString* | 当前期望的缓存实例。 | | transformer | BDBaseTransformer* | 图片加工工具。 | | progress | BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | complete | BDImageRequestCompletedBlock | 图片下载完成，或者部分解码成功，或者缩略图解码成功，都会通过该 block 进行数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### requestImage:alternativeURLs:options:timeoutInterval:cacheName:transformer:decryptBlock:progress:complete: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url alternativeURLs:(NSArray * _Nullable)alternativeURLs options:(BDImageRequestOptions)options timeoutInterval:(CFTimeInterval)timeoutInterval cacheName:(NSString * _Nullable)cacheName transformer:(BDBaseTransformer * _Nullable)transformer decryptBlock:(BDImageRequestDecryptBlock _Nullable)decryptBlock progress:(BDImageRequestProgressBlock _Nullable)progress complete:(BDImageRequestCompletedBlock _Nullable)complete; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前请求图片的 URL 链接，可以支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray\* | 当前备选图片请求链接，可以传入 nil。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | timeoutInterval | CFTimeInterval | 网络请求的超时时间，传入 0 使用默认超时。 | | cacheName | NSString* | 当前期望的缓存实例。 | | transformer | BDBaseTransformer* | 图片加工工具。 | | decryptBlock | BDImageRequestDecryptBlock | 图片解密工具，图片下载后如果是加密状态则会通过该回调进行解密之后再解码，设置后会默认添加 [BDImageRequestNotVerifyData](1262416#枚举值-4) 属性。 | | progress | BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | complete | BDImageRequestCompletedBlock | 图片下载完成，或者部分解码成功，或者缩略图解码成功，都会通过该 block 进行数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### requestImage:options:size:complete: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url options:(BDImageRequestOptions)options size:(CGSize)size complete:(BDImageRequestCompletedBlock _Nullable)complete; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前请求图片的 URL 链接，可以支持 http、file 和 data 的 scheme 的加载方式。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | size | CGSize | 当前图片期望请求的大小，传入 CGSizeZero 不进行操作。 | | complete | BDImageRequestCompletedBlock | 图片下载完成，或者部分解码成功，或者缩略图解码成功，都会通过该 block 进行数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### requestImage:alternativeURLs:options:config:blocks: ```objectivec - (BDWebImageRequest * _Nullable)requestImage:(NSURL * _Nonnull)url alternativeURLs:(NSArray * _Nullable)alternativeURLs options:(BDImageRequestOptions)options config:(BDWebImageRequestConfig * _Nullable)config blocks:(BDWebImageRequestBlocks * _Nullable)blocks; ``` 请求加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前请求图片的 URL 链接，可以支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | NSArray\* | 当前备选图片请求链接，可以传入 nil。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | config | BDWebImageRequestConfig* | 图片请求的详细配置，详见 [BDWebImageRequestConfig](1262416#BDWebImageRequestConfig)。 | | blocks | BDWebImageRequestBlocks* | 图片请求可能用到的 block，包括下载进度、下载完成、解密 block。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### prefetchImageWithURL:category:options:config:blocks: ```objectivec - (BDWebImageRequest *)prefetchImageWithURL:(NSURL * _Nonnull)url category:(NSString * _Nullable)category options:(BDImageRequestOptions)options config:(BDWebImageRequestConfig * _Nullable)config blocks:(BDWebImageRequestBlocks * _Nullable)blocks; ``` 请求预加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前需要预加载图片的 URL 链接。 | | category | NSString* | 业务上用于标记预下载的标识，可以通过 requestsWithCategory: 获取所有标记过该标识的下载请求。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | config | BDWebImageRequestConfig* | 图片请求的详细配置，详见 [BDWebImageRequestConfig](1262416#BDWebImageRequestConfig)。 | | blocks | BDWebImageRequestBlocks* | 图片请求可能用到的 block，包括下载进度、下载完成、解密 block。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### prefetchImagesWithURLs:category:options: ```objectivec - (NSArray *)prefetchImagesWithURLs:(NSArray * _Nonnull)urls category:(NSString * _Nullable)category options:(BDImageRequestOptions)options; ``` 请求预加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urls | NSArray\* | 当前需要预加载图片的 URL 链接数组。 | | category | NSString* | 业务上用于标记预下载的标识，可以通过 requestsWithCategory: 获取所有标记过该标识的下载请求。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | **返回值** 图片请求实例数组，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### prefetchImagesWithURLs:cacheName:category:options: ```objectivec - (NSArray *)prefetchImagesWithURLs:(NSArray * _Nonnull)urls cacheName:(NSString * _Nullable)cacheName category:(NSString * _Nullable)category options:(BDImageRequestOptions)options; ``` 请求预加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urls | NSArray\* | 当前需要预加载图片的 URL 链接数组。 | | cacheName | NSString* | 当前期望的缓存实例。 | | category | NSString* | 业务上用于标记预下载的标识，可以通过 requestsWithCategory: 获取所有标记过该标识的下载请求。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | **返回值** 图片请求实例数组，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### prefetchImageWithURL:category:options: ```objectivec - (BDWebImageRequest *)prefetchImageWithURL:(NSURL * _Nonnull)url category:(NSString * _Nullable)category options:(BDImageRequestOptions)options; ``` 请求预加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前需要预加载图片的 URL 链接。 | | category | NSString* | 业务上用于标记预下载的标识，可以通过 requestsWithCategory: 获取所有标记过该标识的下载请求。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### prefetchImageWithURL:cacheName:category:options: ```objectivec - (BDWebImageRequest *)prefetchImageWithURL:(NSURL * _Nonnull)url cacheName:(NSString * _Nullable)cacheName category:(NSString * _Nullable)category options:(BDImageRequestOptions)options; ``` 请求预加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前需要预加载图片的 URL 链接。 | | cacheName | NSString* | 当前期望的缓存实例。 | | category | NSString* | 业务上用于标记预下载的标识，可以通过 requestsWithCategory: 获取所有标记过该标识的下载请求。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### prefetchImageWithURL:category:options:config: ```objectivec - (BDWebImageRequest *)prefetchImageWithURL:(NSURL * _Nonnull)url category:(NSString * _Nullable)category options:(BDImageRequestOptions)options config:(BDWebImageRequestConfig *)config; ``` 请求预加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 当前需要预加载图片的 URL 链接。 | | category | NSString* | 业务上用于标记预下载的标识，可以通过 requestsWithCategory: 获取所有标记过该标识的下载请求。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | config | BDWebImageRequestConfig* | 图片请求的详细配置，详见 [BDWebImageRequestConfig](1262416#BDWebImageRequestConfig)。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 # Public API ## 函数 | 返回 | 名称 | | --- | --- | | void | [BDImageCacheCallback](#bdimagecachecallback) | | FOUNDATION_EXPORT CGColorSpaceRef | [BDCGColorSpaceGetDeviceRGB](#bdcgcolorspacegetdevicergb) | | FOUNDATION_EXPORT UIImageOrientation | [BDUIImageOrientationFromEXIFOrientation](#bduiimageorientationfromexiforientation) | | FOUNDATION_EXPORT CGImagePropertyOrientation | [BDExifOrientationFromImageOrientation](#bdexiforientationfromimageorientation) | | FOUNDATION_EXPORT CGImageRef | [BDCGImageCreateDecodedCopy](#bdcgimagecreatedecodedcopy) | | FOUNDATION_EXPORT CGImageRef | [BDCGImageDecompressedAndScaledDownImageCreate](#bdcgimagedecompressedandscaleddownimagecreate) | | FOUNDATION_EXPORT BOOL | [BDCGImageRefContainsAlpha](#bdcgimagerefcontainsalpha) | ## 函数说明 ### BDImageCacheCallback ```objectivec void BDImageCacheCallback(UIImage * _Nullable image, NSString * _Nullable cachePath); ``` 缓存回调的 block 定义。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | UIImage* | 缓存图片。 | | cachePath | NSString* | 缓存路径。仅当为磁盘缓存时，有对应路径。 | ### BDCGColorSpaceGetDeviceRGB ```objectivec FOUNDATION_EXPORT CGColorSpaceRef _Nullable BDCGColorSpaceGetDeviceRGB(void); ``` 获取共享的当前设备的色彩空间。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | | void | \- | **返回值** 色彩空间结果。 ### BDUIImageOrientationFromEXIFOrientation ```objectivec FOUNDATION_EXPORT UIImageOrientation BDUIImageOrientationFromEXIFOrientation(NSUInteger exifOrientation); ``` 将 exif 中的方向信息转换到 UIImage 的方向枚举值。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | exifOrientation | NSUInteger | 解析出的 exif 信息中的方向信息。 | **返回值** UIImageOrientation 类型的方向信息。 ### BDExifOrientationFromImageOrientation ```objectivec FOUNDATION_EXPORT CGImagePropertyOrientation BDExifOrientationFromImageOrientation(UIImageOrientation imageOrientation); ``` 将 UIImage 方向枚举值转换到 exif 所需的方向信息。、 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageOrientation | UIImageOrientation | UIImageOrientation 类型的方向信息。 | **返回值** exif 所需的 NSUInteger 类型的方向信息。 ### BDCGImageCreateDecodedCopy ```objectivec FOUNDATION_EXPORT CGImageRef _Nullable BDCGImageCreateDecodedCopy(CGImageRef _Nonnull imageRef, BOOL decodeForDisplay); ``` 对 CGImageRef 重新解码得到新的 CGImageRef 类型图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageRef | CGImageRef | 需要进行解码的 CGImageRef 类型参数。 | | decodeForDisplay | BOOL | 是否预渲染。 | **返回值** 解码后的 CGImageRef 类型图片。 **注意** decodeForDisplay 为 YES 时会通过创建一个 bitmap 上下文并绘制原始图像来生成一个新的解码图像，为 NO 时直接从原始图像的 data provider 中创建一个新的 CGImageRef 对象。 ### BDCGImageDecompressedAndScaledDownImageCreate ```objectivec FOUNDATION_EXPORT CGImageRef _Nullable BDCGImageDecompressedAndScaledDownImageCreate(CGImageRef _Nonnull imageRef, BOOL * _Nonnull isDidScaleDown); ``` 生成解码和缩小尺寸后的新 CGImageRef 对象。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageRef | CGImageRef | 需要进行解码的图片。 | | isDidScaleDown | BOOL* | 标志位，代表结果是否进行了降采样。 | **注意** 该函数内部会进行判断，如果不需要缩小尺寸则直接返回 BDCGImageCreateDecodedCopy 的结果，否则返回新的缩小尺寸之后的图片。 ### BDCGImageRefContainsAlpha ```objectivec - (FOUNDATION_EXPORT BOOL)BDCGImageRefContainsAlpha:(CGImageRef _Nonnull)imageRef ``` 判断图片是否包含 alpha 通道。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageRef | CGImageRef | 需要进行判断的图片。 | **返回值** 判断结果。 # UIButton(BDWebImage) ```objectivec @interface UIButton (BDWebImage) ``` 适配 UIButton 控件的 veImageX category，提供更方便的加载图片函数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [bd_isOpenDownsample](#UIButton(BDWebImage)-bd_isopendownsample) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BDWebImageRequest | [bd_setImageWithURL:forState:](#UIButton(BDWebImage)-bd_setimagewithurl-forstate) | | BDWebImageRequest | [bd_setImageWithURL:forState:placeholderImage:](#UIButton(BDWebImage)-bd_setimagewithurl-forstate-placeholderimage) | | BDWebImageRequest | [bd_setImageWithURL:forState:placeholderImage:decryption:](#UIButton(BDWebImage)-bd_setimagewithurl-forstate-placeholderimage-decryption) | | BDWebImageRequest | [bd_setImageWithURL:forState:placeholderImage:progress:completed:](#UIButton(BDWebImage)-bd_setimagewithurl-forstate-placeholderimage-progress-completed) | | BDWebImageRequest | [bd_setImageWithURL:forState:placeholderImage:options:progress:completed:](#UIButton(BDWebImage)-bd_setimagewithurl-forstate-placeholderimage-options-progress-completed) | | BDWebImageRequest | [bd_setImageWithURL:forState:placeholderImage:completed:](#UIButton(BDWebImage)-bd_setimagewithurl-forstate-placeholderimage-completed) | | BDWebImageRequest | [bd_setImageWithURL:forState:placeholderImage:options:cacheName:progress:completed:](#UIButton(BDWebImage)-bd_setimagewithurl-forstate-placeholderimage-options-cachename-progress-completed) | | BDWebImageRequest | [bd_setImageWithURLs:forState:placeholderImage:options:transformer:progress:completed:](#UIButton(BDWebImage)-bd_setimagewithurls-forstate-placeholderimage-options-transformer-progress-completed) | | BDWebImageRequest | [bd_setImageWithURL:alternativeURLs:forState:placeholderImage:options:cacheName:transformer:progress:completed:](#UIButton(BDWebImage)-bd_setimagewithurl-alternativeurls-forstate-placeholderimage-options-cachename-transformer-progress-completed) | | BDWebImageRequest | [bd_setImageWithURL:alternativeURLs:forState:placeholderImage:options:timeoutInterval:cacheName:transformer:progress:completed:](#UIButton(BDWebImage)-bd_setimagewithurl-alternativeurls-forstate-placeholderimage-options-timeoutinterval-cachename-transformer-progress-completed) | | BDWebImageRequest | [bd_setImageWithURL:alternativeURLs:forState:placeholderImage:options:timeoutInterval:cacheName:transformer:progress:completed:decryption:](#UIButton(BDWebImage)-bd_setimagewithurl-alternativeurls-forstate-placeholderimage-options-timeoutinterval-cachename-transformer-progress-completed-decryption) | | BDWebImageRequest | [bd_setBackgroundImageWithURL:forState:](#UIButton(BDWebImage)-bd_setbackgroundimagewithurl-forstate) | | BDWebImageRequest | [bd_setBackgroundImageWithURL:forState:placeholderImage:](#UIButton(BDWebImage)-bd_setbackgroundimagewithurl-forstate-placeholderimage) | | BDWebImageRequest | [bd_setBackgroundImageWithURL:forState:placeholderImage:completed:](#UIButton(BDWebImage)-bd_setbackgroundimagewithurl-forstate-placeholderimage-completed) | | BDWebImageRequest | [bd_setBackgroundImageWithURL:forState:placeholderImage:options:progress:completed:](#UIButton(BDWebImage)-bd_setbackgroundimagewithurl-forstate-placeholderimage-options-progress-completed) | | BDWebImageRequest | [bd_setBackgroundImageWithURL:forState:placeholderImage:options:cacheName:progress:completed:](#UIButton(BDWebImage)-bd_setbackgroundimagewithurl-forstate-placeholderimage-options-cachename-progress-completed) | | BDWebImageRequest | [bd_setBackgroundImageWithURLs:forState:placeholderImage:options:transformer:progress:completed:](#UIButton(BDWebImage)-bd_setbackgroundimagewithurls-forstate-placeholderimage-options-transformer-progress-completed) | | void | [bd_cancelImageLoadForState:](#UIButton(BDWebImage)-bd_cancelimageloadforstate) | | void | [bd_cancelBackgroundImageLoadForState:](#UIButton(BDWebImage)-bd_cancelbackgroundimageloadforstate) | | nullable NSURL* | [bd_imageURLForState:](#UIButton(BDWebImage)-bd_imageurlforstate) | ## 变量说明 ### bd_isOpenDownsample ```objectivec @property (nonatomic, assign) BOOL bd_isOpenDownsample; ``` 是否按照 view 的大小进行降采样。 - `YES`：是 - `NO`：（默认）否 ## 函数说明 ### bd_setImageWithURL:forState: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state; ``` 在 UIButton 加载图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | **返回值** 图片请求实例，如果失败则会返回 nil。 ### bd_setImageWithURL:forState:placeholderImage: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder; ``` 在 UIButton 加载图片，并设置占位图。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图。 | **返回值** 图片请求实例，如果失败则会返回 nil。 ### bd_setImageWithURL:forState:placeholderImage:decryption: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder decryption:(nullable BDImageRequestDecryptBlock)decrption; ``` 在 UIButton 加载图片，并设置占位图、图片解密工具。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 状态。 | | placeholder | nullable UIImage* | 占位图。 | | decrption | nullable BDImageRequestDecryptBlock | 图片解密工具，图片下载后如果是加密状态则会通过该回调进行解密之后再解码，设置后会默认添加 [BDImageRequestNotVerifyData](1262416#枚举值-4) 属性。 | **返回值** 图片请求实例，如果失败则会返回 nil。 ### bd_setImageWithURL:forState:placeholderImage:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock; ``` 在 UIButton 加载图片，并设置占位图、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调，用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:forState:placeholderImage:options:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock; ``` 在 UIButton 加载图片，并设置占位图、加载选项、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调，用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:forState:placeholderImage:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder completed:(nullable BDImageRequestCompletedBlock)completedBlock; ``` 在 UIButton 加载图片，并设置占位图和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:forState:placeholderImage:options:cacheName:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options cacheName:(nullable NSString *)cacheName progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock; ``` 在 UIButton 加载图片，并设置占位图、加载选项、缓存名称、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | cacheName | nullable NSString* | 当前期望的缓存实例。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调，用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURLs:forState:placeholderImage:options:transformer:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURLs:(nonnull NSArray *)URLs forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options transformer:(nullable BDBaseTransformer *)transformer progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock; ``` 在 UIButton 加载图片，并设置占位图、加载选项、图片加工工具、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | URLs | NSArray* | \- | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | transformer | nullable BDBaseTransformer* | 图片加工工具。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调，用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 的 block 中通知失败消息。 ### bd_setImageWithURL:alternativeURLs:forState:placeholderImage:options:cacheName:transformer:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url alternativeURLs:(nullable NSArray *)alternativeURLs forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options cacheName:(nullable NSString *)cacheName transformer:(nullable BDBaseTransformer *)transformer progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock; ``` 在 UIButton 加载图片，并设置占位图、加载选项、缓存名称、图片加工工具、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | nullable NSArray\* | 当前备选图片请求链接，可以传入 nil。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | cacheName | nullable NSString* | 当前期望的缓存实例。 | | transformer | nullable BDBaseTransformer* | 图片加工工具。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调，用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:alternativeURLs:forState:placeholderImage:options:timeoutInterval:cacheName:transformer:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url alternativeURLs:(nullable NSArray *)alternativeURLs forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options timeoutInterval:(CFTimeInterval)timeoutInterval cacheName:(nullable NSString *)cacheName transformer:(nullable BDBaseTransformer *)transformer progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock; ``` 在 UIButton 加载图片，并设置占位图、备选图、加载选项、缓存名称、超时时间、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | nullable NSArray\* | 备选图片访问 URL，可以传入 nil。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | timeoutInterval | CFTimeInterval | 网络请求的超时时间，传入 0 使用默认超时。 | | cacheName | nullable NSString* | 当前期望的缓存实例。 | | transformer | nullable BDBaseTransformer* | 图片加工工具。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调，用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setImageWithURL:alternativeURLs:forState:placeholderImage:options:timeoutInterval:cacheName:transformer:progress:completed:decryption: ```objectivec - (nullable BDWebImageRequest *)bd_setImageWithURL:(nonnull NSURL *)url alternativeURLs:(nullable NSArray *)alternativeURLs forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options timeoutInterval:(CFTimeInterval)timeoutInterval cacheName:(nullable NSString *)cacheName transformer:(nullable BDBaseTransformer *)transformer progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock decryption:(nullable BDImageRequestDecryptBlock)decrption; ``` 在 UIButton 加载图片，并设置占位图、备选图、加载选项、缓存名称、超时时间、图片加工工具、进度回调和完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | alternativeURLs | nullable NSArray\* | 备选图片访问 URL，可以传入 nil。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | timeoutInterval | CFTimeInterval | 网络请求的超时时间，传入 0 使用默认超时。 | | cacheName | nullable NSString* | 当前期望的缓存实例。 | | transformer | nullable BDBaseTransformer* | 图片加工工具。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调，用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | | decrption | nullable BDImageRequestDecryptBlock | 图片解密工具，图片下载后如果是加密状态则会通过该回调进行解密之后再解码，设置后会默认添加 [BDImageRequestNotVerifyData](1262416#枚举值-4) 属性。 | **返回值** 图片请求实例，如果失败则会返回 nil，并在 complete 回调中通知失败消息。 ### bd_setBackgroundImageWithURL:forState: ```objectivec - (nullable BDWebImageRequest *)bd_setBackgroundImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state; ``` 在 UIButton 加载背景图。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | ### bd_setBackgroundImageWithURL:forState:placeholderImage: ```objectivec - (nullable BDWebImageRequest *)bd_setBackgroundImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder; ``` UIButton 加载图片作为 backgroudImage。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | ### bd_setBackgroundImageWithURL:forState:placeholderImage:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setBackgroundImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder completed:(nullable BDImageRequestCompletedBlock)completedBlock;; ``` UIButton 加载图片作为 backgroudImage。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | ### bd_setBackgroundImageWithURL:forState:placeholderImage:options:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setBackgroundImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock;; ``` UIButton 加载图片作为 backgroudImage。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | ### bd_setBackgroundImageWithURL:forState:placeholderImage:options:cacheName:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setBackgroundImageWithURL:(nonnull NSURL *)url forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options cacheName:(nullable NSString *)cacheName progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock;; ``` UIButton 加载图片作为 backgroudImage。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | cacheName | nullable NSString* | 当前期望的缓存实例。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | ### bd_setBackgroundImageWithURLs:forState:placeholderImage:options:transformer:progress:completed: ```objectivec - (nullable BDWebImageRequest *)bd_setBackgroundImageWithURLs:(nonnull NSArray *)URLs forState:(UIControlState)state placeholderImage:(nullable UIImage *)placeholder options:(BDImageRequestOptions)options transformer:(nullable BDBaseTransformer *)transformer progress:(nullable BDImageRequestProgressBlock)progressBlock completed:(nullable BDImageRequestCompletedBlock)completedBlock;; ``` UIButton 加载图片作为 backgroudImage。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | URLs | NSArray* | 图片访问 URL 数组，支持 http、file 和 data 的 scheme 的加载方式。 | | state | UIControlState | UIButton 的状态。 | | placeholder | nullable UIImage* | 占位图片。 | | options | BDImageRequestOptions | 当前图片请求的选项，详见 [BDWebImageRequest](#BDWebImageRequest)。 | | transformer | nullable BDBaseTransformer* | 图片加工工具。 | | progressBlock | nullable BDImageRequestProgressBlock | 下载进度回调 block，可以用于统计当前图片下载进度。 | | completedBlock | nullable BDImageRequestCompletedBlock | 图片下载完成/部分解码成功/缩略图解码成功的数据回调。 | ### bd_cancelImageLoadForState: ```objectivec - (void)bd_cancelImageLoadForState:(UIControlState)state; ``` 取消 UIButton 某状态下的图片请求。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | UIControlState | UIButton 的状态。 | ### bd_cancelBackgroundImageLoadForState: ```objectivec - (void)bd_cancelBackgroundImageLoadForState:(UIControlState)state; ``` 取消 UIButton 某状态下的背景图片请求。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | UIControlState | UIButton 的状态。 | ### bd_imageURLForState: ```objectivec - (nullable NSURL *)bd_imageURLForState:(UIControlState)state; ``` 获取 UIButton 某状态下的图片请求的 URL。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | UIControlState | UIButton 的状态。 | **返回值** url 结果。 # BDImageCache ```objectivec @interface BDImageCache : NSObject ``` BDWebImage 的缓存模块。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [name](#BDImageCache-name) | | BDImageCacheConfig* | [config](#BDImageCache-config) | | id\ | [memoryCache](#BDImageCache-memorycache) | | id\ | [diskCache](#BDImageCache-diskcache) | | BOOL | [enableMemoryLruOptimization](#BDImageCache-enablememorylruoptimization) | ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [sharedImageCache](#BDImageCache-sharedimagecache) | ## 成员函数 | 返回 | 名称 | | --- | --- | | instancetype | [initWithName:](#BDImageCache-initwithname) | | instancetype | [initWithMemoryCache:diskStorePath:config:](#BDImageCache-initwithmemorycache-diskstorepath-config) | | void | [setImage:forKey:](#BDImageCache-setimage-forkey) | | void | [setImage:imageData:forKey:withType:](#BDImageCache-setimage-imagedata-forkey-withtype) | | void | [setImage:imageData:forKey:withType:callBack:](#BDImageCache-setimage-imagedata-forkey-withtype-callback) | | void | [saveImageToDisk:data:forKey:](#BDImageCache-saveimagetodisk-data-forkey) | | void | [saveImageToDisk:data:forKey:callBack:](#BDImageCache-saveimagetodisk-data-forkey-callback) | | void | [removeImageForKey:](#BDImageCache-removeimageforkey) | | void | [removeImageForKey:withType:](#BDImageCache-removeimageforkey-withtype) | | void | [removeImageFromDiskForKey:callBack:](#BDImageCache-removeimagefromdiskforkey-callback) | | BDImageCacheType | [containsImageForKey:](#BDImageCache-containsimageforkey) | | BDImageCacheType | [containsImageForKey:type:](#BDImageCache-containsimageforkey-type) | | UIImage* | [imageForKey:](#BDImageCache-imageforkey) | | UIImage* | [imageFromMemoryCacheForKey:](#BDImageCache-imagefrommemorycacheforkey) | | UIImage* | [imageFromDiskCacheForKey:](#BDImageCache-imagefromdiskcacheforkey) | | UIImage* | [imageFromDiskCacheForKey:options:](#BDImageCache-imagefromdiskcacheforkey-options) | | UIImage* | [imageForKey:withType:](#BDImageCache-imageforkey-withtype) | | UIImage* | [imageForKey:withType:options:size:](#BDImageCache-imageforkey-withtype-options-size) | | UIImage* | [imageForKey:withType:options:size:decryptBlock:](#BDImageCache-imageforkey-withtype-options-size-decryptblock) | | UIImage* | [imageForRequestKey:withType:decoderConfig:decryptBlock:](#BDImageCache-imageforrequestkey-withtype-decoderconfig-decryptblock) | | UIImage* | [imageForRequestKey:withType:decoderConfig:decryptBlock:error:](#BDImageCache-imageforrequestkey-withtype-decoderconfig-decryptblock-error) | | void | [imageForKey:withType:withBlock:](#BDImageCache-imageforkey-withtype-withblock) | | void | [imageForKey:withType:options:size:withBlock:](#BDImageCache-imageforkey-withtype-options-size-withblock) | | void | [imageForKey:withType:options:size:withBlock:decryptBlock:](#BDImageCache-imageforkey-withtype-options-size-withblock-decryptblock) | | NSData* | [imageDataForKey:](#BDImageCache-imagedataforkey) | | void | [imageDataForKey:withBlock:](#BDImageCache-imagedataforkey-withblock) | | id | [imageInfoForkey:withInfoType:](#BDImageCache-imageinfoforkey-withinfotype) | | void | [setImageInfo:forKey:withInfoType:](#BDImageCache-setimageinfo-forkey-withinfotype) | | CGRect | [smartCropRateRectForkey:](#BDImageCache-smartcropraterectforkey) | | NSString* | [cachePathForKey:](#BDImageCache-cachepathforkey) | | void | [clearMemory](#BDImageCache-clearmemory) | | void | [clearDiskWithBlock:](#BDImageCache-cleardiskwithblock) | | void | [trimDiskCache](#BDImageCache-trimdiskcache) | | NSUInteger | [totalDiskSize](#BDImageCache-totaldisksize) | ## 变量说明 ### name ```objectivec @property (nonatomic, copy, nullable) NSString *name; ``` 缓存的名称，即本地缓存的文件夹名称。 **注意** 内部实现会强制全部转换为小写。 ### config ```objectivec @property (nonatomic, copy, nullable) BDImageCacheConfig *config; ``` 缓存的配置项，详见 [BDImageCacheConfig](1262416#BDImageCacheConfig)。 **注意** 云控只影响默认主缓存的 config 属性。 ### memoryCache ```objectivec @property (nonatomic, strong, readonly, nullable) id memoryCache; ``` 图片库内存缓存管理模块。 ### diskCache ```objectivec @property (nonatomic, strong, readonly, nullable) id diskCache; ``` 图片库磁盘缓存管理模块。 ### enableMemoryLruOptimization ```objectivec @property (nonatomic, assign, class) BOOL enableMemoryLruOptimization; ``` 是否启用 LRU 缓存管理优化。 ## 函数说明 ### sharedImageCache ```objectivec + (instancetype _Nonnull)sharedImageCache; ``` 获取图片库默认缓存。 **返回值** 图片库默认缓存实例。 **注意** 若非指明使用的缓存管理则会使用该缓存实例。 ### initWithName: ```objectivec - (instancetype _Nullable)initWithName:(NSString * _Nonnull)name; ``` 创建缓存实例，可自定义磁盘缓存路径。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | name | NSString* | 自定义缓存中本地磁盘缓存的文件夹名称。 | **返回值** 自定义缓存实例。 **注意** - name 参数会被转换为小写，拼接成最后缓存路径`~/Library/Caches/${name}`。 - BDWebImage 中的请求图片接口的 cacheName 参数传递的并不是该属性，应该传入 registCache:forKey: 函数中传递的 KEY 值。 ### initWithMemoryCache:diskStorePath:config: ```objectivec - (instancetype _Nullable)initWithMemoryCache:(id _Nullable)memoryCache diskStorePath:(NSString * _Nonnull)path config:(BDImageCacheConfig * _Nullable)config NS_DESIGNATED_INITIALIZER; ``` 创建缓存实例，可自定义内存缓存和磁盘缓存。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | memoryCache | id\ | 自定义的内存缓存实例。 | | path | NSString* | 磁盘缓存路径，需全部小写。 | | config | BDImageCacheConfig* | 缓存配置信息。 | **返回值** 自定义缓存实例。 ### setImage:forKey: ```objectivec - (void)setImage:(UIImage * _Nonnull)image forKey:(NSString * _Nonnull)key; ``` 将图片缓存至内存和磁盘。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | UIImage* | 需要缓存的图片。 | | key | NSString* | 图片对应的键值。 | ### setImage:imageData:forKey:withType: ```objectivec - (void)setImage:(UIImage * _Nullable)image imageData:(NSData * _Nullable)imageData forKey:(NSString * _Nonnull)key withType:(BDImageCacheType)type; ``` 同步设置缓存。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | UIImage* | 需要存放到缓存的图片。 | | imageData | NSData* | 需要缓存的图片数据。 | | key | NSString* | 图片对应的键值。 | | type | BDImageCacheType | 缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | **注意** - 按照传入的 type 决定存放的缓存。 - 如果需要缓存到内存且 image 参数为空，则会尝试用传入的 imageData 参数生成。 - 如果需要缓存到磁盘且 imageData 参数为空，则会尝试用传入的 image 参数生成。 ### setImage:imageData:forKey:withType:callBack: ```objectivec - (void)setImage:(UIImage * _Nullable)image imageData:(NSData * _Nullable)imageData forKey:(NSString * _Nonnull)key withType:(BDImageCacheType)type callBack:(BDImageCacheCallback _Nullable)callback; ``` 异步设置缓存。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | UIImage* | 需要存放到缓存的图片。 | | imageData | NSData* | 需要缓存的图片数据。 | | key | NSString* | 图片对应的键值。 | | type | BDImageCacheType | 缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | | callback | BDImageCacheCallback | 缓存成功后执行的回调。 | **注意** - 按照传入的 type 决定存放的缓存。 - 如果需要缓存到内存且 image 参数为空，则会尝试用传入的 imageData 参数生成。 - 如果需要缓存到磁盘且 imageData 参数为空，则会尝试用传入的 image 参数生成。 ### saveImageToDisk:data:forKey: ```objectivec - (void)saveImageToDisk:(UIImage * _Nullable)image data:(NSData * _Nullable)imageData forKey:(NSString * _Nonnull)key; ``` 同步存放图片数据至磁盘缓存。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | UIImage* | 存放的图片。 | | imageData | NSData* | 存放的图片数据。 | | key | NSString* | 存放到磁盘缓存中图片对应的键值。 | **注意** 如果传入的 imageData 参数为空，则尝试用传入的 image 参数生成。 ### saveImageToDisk:data:forKey:callBack: ```objectivec - (void)saveImageToDisk:(UIImage * _Nullable)image data:(NSData * _Nullable)data forKey:(NSString * _Nonnull)key callBack:(BDImageCacheCallback _Nullable)callback; ``` 异步存放图片数据至磁盘缓存。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | UIImage* | 存放的图片。 | | data | NSData* | 存放的图片数据。 | | key | NSString* | 存放到磁盘缓存中图片对应的键值。 | | callback | BDImageCacheCallback | 缓存成功后执行的回调。 | **注意** - 如果传入的 imageData 参数为空，则尝试用传入的 image 参数生成。 - 回调调用不保证线程。 ### removeImageForKey: ```objectivec - (void)removeImageForKey:(NSString * _Nonnull)key; ``` 同步移除缓存。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要移除的图片对应的键值。 | **注意** 该接口会同时移除内存缓存和磁盘缓存。 ### removeImageForKey:withType: ```objectivec - (void)removeImageForKey:(NSString * _Nonnull)key withType:(BDImageCacheType)type; ``` 同步移除缓存。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要移除的图片对应的键值。 | | type | BDImageCacheType | 缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | ### removeImageFromDiskForKey:callBack: ```objectivec - (void)removeImageFromDiskForKey:(NSString * _Nonnull)key callBack:(void(^ _Nullable)(NSString * _Nonnull key))callback; ``` 异步移除磁盘缓存。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要移除的图片对应的键值。 | | callback | void(^)(NSString* key) | 缓存成功后执行的回调。 | ### containsImageForKey: ```objectivec - (BDImageCacheType)containsImageForKey:(NSString * _Nonnull)key; ``` 判断缓存中是否存在某张图片以及该图片的缓存类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要判断的图片对应的键值。 | **返回值** 缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 **注意** 如果返回 BDImageCacheTypeNone 则表示缓存中不存在对应图片。 ### containsImageForKey:type: ```objectivec - (BDImageCacheType)containsImageForKey:(NSString * _Nonnull)key type:(BDImageCacheType)type; ``` 判断指定缓存中是否存在某张图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要判断的图片对应的键值。 | | type | BDImageCacheType | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | **返回值** 缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 ### imageForKey: ```objectivec - (UIImage * _Nullable)imageForKey:(NSString * _Nonnull)key; ``` 同步从缓存中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | **返回值** 从缓存中取出的图片。 **注意** - 优先查找内存缓存。 - 若缓存中没有键值对应的图片，则返回 nil。 ### imageFromMemoryCacheForKey: ```objectivec - (UIImage * _Nullable)imageFromMemoryCacheForKey:(NSString * _Nonnull)key; ``` 同步从内存缓存中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | **返回值** 从内存缓存中取出的图片。 ### imageFromDiskCacheForKey: ```objectivec - (UIImage * _Nullable)imageFromDiskCacheForKey:(NSString * _Nonnull)key; ``` 同步从磁盘缓存中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | **返回值** 从磁盘缓存中取出的图片。 ### imageFromDiskCacheForKey:options: ```objectivec - (UIImage * _Nullable)imageFromDiskCacheForKey:(NSString * _Nonnull)key options:(BDImageRequestOptions)options; ``` 同步从磁盘缓存中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | | options | BDImageRequestOptions | 解码时可能用到的配置。 | **返回值** 从磁盘缓存中取出的图片。 **注意** BDImageRequestOptions 类型详见 [BDImageRequestOptions](1262416#BDImageRequestOptions)，且该接口内部只会使用 BDImageNotDecoderForDisplay、BDImageScaleDownLargeImages 和 BDImageRequestSmartCorp。 ### imageForKey:withType: ```objectivec - (UIImage * _Nullable)imageForKey:(NSString * _Nonnull)key withType:(BDImageCacheType * _Nonnull)type; ``` 同步从传入的缓存类型中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | | type | BDImageCacheType* | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | **返回值** 从缓存中取出的图片。 **注意** 接口执行后可通过 *type 获取具体取到图片的缓存类型。 ### imageForKey:withType:options:size: ```objectivec - (UIImage * _Nullable)imageForKey:(NSString * _Nonnull)key withType:(BDImageCacheType * _Nonnull)type options:(BDImageRequestOptions)options size:(CGSize)size; ``` 同步从传入的缓存类型中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | | type | BDImageCacheType* | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | | options | BDImageRequestOptions | 解码时可能用到的配置。 | | size | CGSize | 图片尺寸。若开启了降采样，表示为图片降采样后的尺寸。 | **返回值** 从缓存中取出的图片。 **注意** - 接口执行后可通过 *type 获取具体取到图片的缓存类型。 - BDImageRequestOptions 类型详见 [BDImageRequestOptions](1262416#BDImageRequestOptions)，且该接口内部只会使用 BDImageNotDecoderForDisplay、BDImageScaleDownLargeImages 和 BDImageRequestSmartCorp。 ### imageForKey:withType:options:size:decryptBlock: ```objectivec - (UIImage * _Nullable)imageForKey:(NSString * _Nonnull)key withType:(BDImageCacheType * _Nonnull)type options:(BDImageRequestOptions)options size:(CGSize)size decryptBlock:(BDImageRequestDecryptBlock _Nullable)decryptBlock; ``` 同步从传入的缓存类型中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | | type | BDImageCacheType* | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | | options | BDImageRequestOptions | 解码时可能用到的配置。 | | size | CGSize | 图片尺寸。若开启了降采样，表示为图片降采样后的尺寸。 | | decryptBlock | BDImageRequestDecryptBlock | 图片解密工具，图片下载后如果是加密状态则会通过该回调进行解密之后再解码。若无需解密，则为 nil。 | **返回值** 从缓存中取出的图片。 **注意** - 接口执行后可通过 *type 获取具体取到图片的缓存类型。 - BDImageRequestOptions 类型详见 [BDImageRequestOptions](1262416#BDImageRequestOptions)，且该接口内部只会使用 BDImageNotDecoderForDisplay、BDImageScaleDownLargeImages 和 BDImageRequestSmartCorp。 ### imageForRequestKey:withType:decoderConfig:decryptBlock: ```objectivec - (UIImage * _Nullable)imageForRequestKey:(BDImageRequestKey * _Nonnull)requestKey withType:(BDImageCacheType * _Nonnull)type decoderConfig:(BDImageDecoderConfig * _Nonnull)config decryptBlock:(BDImageRequestDecryptBlock _Nullable)decryptBlock; ``` 同步从传入的缓存类型中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | requestKey | BDImageRequestKey* | 需要取出的图片请求唯一对应的键值类。 | | type | BDImageCacheType* | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | | config | BDImageDecoderConfig* | 解码相关配置，详见 [BDImageDecoderConfig](#BDImageDecoderConfig)。 | | decryptBlock | BDImageRequestDecryptBlock | 图片解密工具，图片下载后如果是加密状态则会通过该回调进行解密之后再解码。若无需解密，则为 nil。 | **返回值** 从缓存中取出的图片。 **注意** 接口执行后可通过 *type 获取具体取到图片的缓存类型。 ### imageForRequestKey:withType:decoderConfig:decryptBlock:error: ```objectivec - (UIImage * _Nullable)imageForRequestKey:(BDImageRequestKey * _Nonnull)requestKey withType:(BDImageCacheType * _Nonnull)type decoderConfig:(BDImageDecoderConfig * _Nonnull)config decryptBlock:(BDImageRequestDecryptBlock _Nullable)decryptBlock error:(NSError * _Nullable __autoreleasing * _Nullable)error; ``` 同步从传入的缓存类型中获取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | requestKey | BDImageRequestKey* | 需要取出的图片请求唯一对应的键值类。 | | type | BDImageCacheType* | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | | config | BDImageDecoderConfig* | 解码相关配置，详见 [BDImageDecoderConfig](#BDImageDecoderConfig)。 | | decryptBlock | BDImageRequestDecryptBlock | 图片解密工具，图片下载后如果是加密状态则会通过该回调进行解密之后再解码。若无需解密，则为 nil。 | | error | NSError* __autoreleasing* | NSError * 类型变量的地址。 | **返回值** 从缓存中取出的图片。 **注意** 接口执行后可通过 *type 获取具体取到图片的缓存类型，若失败，外部的 NSError 变量会包含此次失败的错误码。 ### imageForKey:withType:withBlock: ```objectivec - (void)imageForKey:(NSString * _Nonnull)key withType:(BDImageCacheType)type withBlock:(void(^ _Nullable)(UIImage * _Nullable image, BDImageCacheType type))block; ``` 异步从传入的缓存类型中取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | | type | BDImageCacheType | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | | block | void(^)(UIImage* image, BDImageCacheType type) | 尝试获取图片后在主线程执行的回调。 | ### imageForKey:withType:options:size:withBlock: ```objectivec - (void)imageForKey:(NSString * _Nonnull)key withType:(BDImageCacheType)type options:(BDImageRequestOptions)options size:(CGSize)size withBlock:(void(^ _Nullable)(UIImage * _Nullable image, BDImageCacheType type))block; ``` 异步从传入的缓存类型中取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | | type | BDImageCacheType | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | | options | BDImageRequestOptions | 解码时可能用到的配置。 | | size | CGSize | 图片尺寸。若开启了降采样，表示为图片降采样后的尺寸。 | | block | void(^)(UIImage* image, BDImageCacheType type) | 尝试获取图片后在主线程执行的回调。 | ### imageForKey:withType:options:size:withBlock:decryptBlock: ```objectivec - (void)imageForKey:(NSString * _Nonnull)key withType:(BDImageCacheType)type options:(BDImageRequestOptions)options size:(CGSize)size withBlock:(void(^ _Nullable)(UIImage * _Nullable image, BDImageCacheType type))block decryptBlock:(BDImageRequestDecryptBlock _Nullable)decryptBlock; ``` 异步从传入的缓存类型中取图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 需要取出的图片对应的键值。 | | type | BDImageCacheType | 指定需要查看的缓存类型，详见 [BDImageCacheType](1262416#BDImageCacheType)。 | | options | BDImageRequestOptions | 解码时可能用到的配置。 | | size | CGSize | 图片尺寸。若开启了降采样，表示为图片降采样后的尺寸。 | | block | void(^)(UIImage* image, BDImageCacheType type) | 尝试获取图片后在主线程执行的回调。 | | decryptBlock | BDImageRequestDecryptBlock | 图片解密工具，图片下载后如果是加密状态则会通过该回调进行解密之后再解码。若无需解密，则为 nil。 | ### imageDataForKey: ```objectivec - (NSData * _Nullable)imageDataForKey:(NSString * _Nonnull)key; ``` 同步获取磁盘缓存的图片原始数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 图片对应的键值。 | **返回值** 图片原始数据。 ### imageDataForKey:withBlock: ```objectivec - (void)imageDataForKey:(NSString * _Nonnull)key withBlock:(void(^ _Nonnull)(NSData * _Nullable imageData))block; ``` 异步获取磁盘缓存的图片原始数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 图片对应的键值。 | | block | void(^)(NSData* imageData) | 获取图片原始数据结束后在主线程执行的回调。 | ### imageInfoForkey:withInfoType: ```objectivec - (id _Nullable)imageInfoForkey:(NSString * _Nonnull)key withInfoType:(NSString * _Nonnull)type; ``` 获取图片的相关附加信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 图片对应的键值。 | | type | NSString* | 需要获取的附加信息中的种类，需与设置时的一致。 | **返回值** 附加信息中对应 type 的信息。 ### setImageInfo:forKey:withInfoType: ```objectivec - (void)setImageInfo:(id _Nonnull)info forKey:(NSString * _Nonnull)key withInfoType:(NSString * _Nonnull)type; ``` 存储图片相关附加信息，比如裁剪区域、降采样信息等。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | info | id | 需要存储的信息，类型可为NSString、NSNumber、NSArray、NSDictionary、NSData、NSDate。 | | key | NSString* | 图片对应的键值。 | | type | NSString* | 附加信息的种类。 | ### smartCropRateRectForkey: ```objectivec - (CGRect)smartCropRateRectForkey:(NSString * _Nonnull)key; ``` 获取智能裁剪的信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 图片对应的键值。 | **返回值** CGRect 类型的裁剪信息，相对于原图片的比例。 ### cachePathForKey: ```objectivec - (NSString * _Nullable)cachePathForKey:(NSString * _Nonnull)key; ``` 同步取磁盘缓存文件地址。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 图片对应的键值。 | **返回值** 磁盘缓存文件地址。 **注意** 若缓存存在，则返回具体地址，但无法保证文件存在。请您自行保证 inlineThreshold 和判断结果。 ### clearMemory ```objectivec - (void)clearMemory; ``` 清除内存缓存中的所有数据。 ### clearDiskWithBlock: ```objectivec - (void)clearDiskWithBlock:(void(^_Nullable)(void))block; ``` 清除磁盘缓存中的所有数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | block | void(^)(void) | 清除数据之后的回调。 | **注意** 回调在内部磁盘缓存类的子线程上，不会回调到主线程。 ### trimDiskCache ```objectivec - (void)trimDiskCache; ``` 根据设置的最大磁盘大小，对象数量和过期时间，同步清除过期的缓存。 ### totalDiskSize ```objectivec - (NSUInteger)totalDiskSize; ``` 同步获取磁盘缓存的所有数据的字节数。 **注意** - 业务上非必需请勿直接使用该处 API。 - 内存缓存中是加工之后的图片，可能经过降采样等处理之后的 UIImage 对象；磁盘缓存中是存放的网络下载的原始数据，保存的是 NSData 对象。 - 磁盘缓存中的键值为 sourceKey，可由 [BDWebImageManager](#BDWebImageManager) 中的 requestKeyWithURL: 方法获取。 - 内存缓存中的键值为 targetKey，可由 BDImageRequestKey 中的 initWithSourceKey: 方法获取。 - 磁盘缓存查询会造成磁盘 IO，推荐异步查询；内存缓存查询比较安全，可在主线程进行。 # BDWebImageRequest ```objectivec @interface BDWebImageRequest : NSObject ``` 图片请求的实例。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [uuid](#BDWebImageRequest-uuid) | | id | [userInfo](#BDWebImageRequest-userinfo) | | NSString* | [requestKey](#BDWebImageRequest-requestkey) | | NSString* | [category](#BDWebImageRequest-category) | | NSString* | [cacheName](#BDWebImageRequest-cachename) | | NSDictionary\* | [customParam](#BDWebImageRequest-customparam) | | NSURL* | [currentRequestURL](#BDWebImageRequest-currentrequesturl) | | NSArray\* | [alternativeURLs](#BDWebImageRequest-alternativeurls) | | NSUInteger | [currentIndex](#BDWebImageRequest-currentindex) | | BOOL | [isPrefetchRequest](#BDWebImageRequest-isprefetchrequest) | | BOOL | [isNeedDecrptyData](#BDWebImageRequest-isneeddecrptydata) | | NSDictionary\* | [requestHeaders](#BDWebImageRequest-requestheaders) | | CFTimeInterval | [timeoutInterval](#BDWebImageRequest-timeoutinterval) | | BDImageRequestOptions | [option](#BDWebImageRequest-option) | | CGSize | [sizeLimit](#BDWebImageRequest-sizelimit) | | NSUInteger | [memoryLimit](#BDWebImageRequest-memorylimit) | | CGRect | [smartCropRect](#BDWebImageRequest-smartcroprect) | | BDBlurHashConfig* | [blurHashConfig](#BDWebImageRequest-blurhashconfig) | | BDWebImageCryptoKey* | [cryptoKey](#BDWebImageRequest-cryptokey) | | BDImageRequestProgressBlock | [progressBlock](#BDWebImageRequest-progressblock) | | BDImageRequestCompletedBlock | [completedBlock](#BDWebImageRequest-completedblock) | | BDImageRequestPerformanceBlock | [performanceBlock](#BDWebImageRequest-performanceblock) | | BDImageRequestDecryptBlock | [decryptBlock](#BDWebImageRequest-decryptblock) | | UIImage* | [image](#BDWebImageRequest-image) | | NSData* | [data](#BDWebImageRequest-data) | | NSError* | [error](#BDWebImageRequest-error) | | NSString* | [cachePath](#BDWebImageRequest-cachepath) | | double | [progress](#BDWebImageRequest-progress) | | int64_t | [receivedSize](#BDWebImageRequest-receivedsize) | | int64_t | [expectedSize](#BDWebImageRequest-expectedsize) | | double | [minNotifiProgressInterval](#BDWebImageRequest-minnotifiprogressinterval) | | NSInteger | [maxRetryCount](#BDWebImageRequest-maxretrycount) | | BDBaseTransformer* | [transformer](#BDWebImageRequest-transformer) | | BOOL | [cancelled](#BDWebImageRequest-cancelled) | | BOOL | [failed](#BDWebImageRequest-failed) | | BOOL | [finished](#BDWebImageRequest-finished) | | BDImagePerformanceRecoder* | [recorder](#BDWebImageRequest-recorder) | | BDImageLargeSizeMonitor* | [largeImageMonitor](#BDWebImageRequest-largeimagemonitor) | | NSUInteger | [largeImageFileSizeLimit](#BDWebImageRequest-largeimagefilesizelimit) | | NSUInteger | [largeImageMemoryLimit](#BDWebImageRequest-largeimagememorylimit) | | CGFloat | [largeImageViewResolutionScaleLimit](#BDWebImageRequest-largeimageviewresolutionscalelimit) | | BOOL | [isMonitorDecodedImageQuality](#BDWebImageRequest-ismonitordecodedimagequality) | | NSUInteger | [randomSamplingPointCount](#BDWebImageRequest-randomsamplingpointcount) | ## 静态函数 | 返回 | 名称 | | --- | --- | | void | [addRetryErrorCode:](#BDWebImageRequest-addretryerrorcode) | | void | [removeRetryErrorCode:](#BDWebImageRequest-removeretryerrorcode) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setSizeLimitByScreenPoint:](#BDWebImageRequest-setsizelimitbyscreenpoint) | | instancetype | [initWithURL:alternativeURLs:](#BDWebImageRequest-initwithurl-alternativeurls) | | void | [cancel](#BDWebImageRequest-cancel) | ## 变量说明 ### uuid ```objectivec @property (nonatomic, copy, readonly, nonnull) NSString *uuid; ``` 图片请求的唯一标识。 ### userInfo ```objectivec @property (nonatomic, strong, nullable) id userInfo; ``` 图片请求中业务透传的业务信息。 ### requestKey ```objectivec @property (nonatomic, retain, nullable) NSString *requestKey; ``` 图片请求的键值。若图片经过处理，则在保留缓存和获取缓存时会拼接上 transformKey。 ### category ```objectivec @property (nonatomic, copy, nullable) NSString *category; ``` 分类标识，您可以自定义分类标识对图片请求进行分组。 ### cacheName ```objectivec @property (nonatomic, copy, nullable) NSString *cacheName; ``` 对应的缓存实例名称。 ### customParam ```objectivec @property (nonatomic, copy, nullable) NSDictionary *customParam; ``` 业务自定义夹带上报数据。 ### currentRequestURL ```objectivec @property (nonatomic, retain, readonly, nonnull) NSURL *currentRequestURL; ``` 当前图片请求的 URL。 ### alternativeURLs ```objectivec @property (nonatomic, copy, nullable) NSArray *alternativeURLs; ``` 备选图片 URL 数组，下载失败后会自动重试其中的图片。 ### currentIndex ```objectivec @property (nonatomic, assign, readonly) NSUInteger currentIndex; ``` 当前重试图片 URL 在数组中的索引。 ### isPrefetchRequest ```objectivec @property (nonatomic, assign)BOOL isPrefetchRequest; ``` 标识是否是预加载请求。 - `YES`：是 - `NO`：否 **注意** - 预加载请求如果查询到缓存则不会继续处理。 - 如果取消某个正常请求，标识相同的预加载也将被取消。 ### isNeedDecrptyData ```objectivec @property (nonatomic, assign) BOOL isNeedDecrptyData; ``` 是否需要对数据进行解密。 - `YES`：是 - `NO`：否 ### requestHeaders ```objectivec @property (nonatomic, copy, nullable) NSDictionary *requestHeaders; ``` 设置单独请求的 HTTP Request Headers。 ### timeoutInterval ```objectivec @property (nonatomic, assign) CFTimeInterval timeoutInterval; ``` 设置请求超时时间。 ### option ```objectivec @property (nonatomic, assign) BDImageRequestOptions option; ``` 请求选项设置，详见 [BDImageRequestOptions](1262416#BDImageRequestOptions)。 ### sizeLimit ```objectivec @property (nonatomic, assign) CGSize sizeLimit; ``` 尺寸限制的大小，单位为 px。 ### memoryLimit ```objectivec @property (nonatomic, assign) NSUInteger memoryLimit; ``` 内存限制的大小。 ### smartCropRect ```objectivec @property (nonatomic, assign) CGRect smartCropRect; ``` 解析后的智能裁剪区域。 ### blurHashConfig ```objectivec @property (nonatomic, copy, nullable) BDBlurHashConfig *blurHashConfig; ``` BlurHash 功能配置，详见 [BDBlurHashConfig](1262416#BDBlurHashConfig)。 ### cryptoKey ```objectivec @property (nonatomic, strong, nullable) BDWebImageCryptoKey *cryptoKey; ``` 加密图片密钥。 ### progressBlock ```objectivec @property (atomic, copy, nullable) BDImageRequestProgressBlock progressBlock; ``` 图片请求来自网络下载时进度回调。 ### completedBlock ```objectivec @property (atomic, copy, nullable) BDImageRequestCompletedBlock completedBlock; ``` 请求结果回调。无论是否请求成功均会触发回调，若取消请求则不会回调。 **注意** 可通过 NSError 是否为空，来判断下载是否失败。 ### performanceBlock ```objectivec @property (atomic, copy, nullable) BDImageRequestPerformanceBlock performanceBlock; ``` 请求完成时回调，返回对象记录请求相关性能日志和信息。 ### decryptBlock ```objectivec @property (atomic, copy, nullable) BDImageRequestDecryptBlock decryptBlock; ``` 加密数据解码回调。 ### image ```objectivec @property (atomic, retain, nullable) UIImage *image; ``` 返回的图片，如果支持 BDImage 类则默认为 BDImage。 ### data ```objectivec @property (nonatomic, retain, nullable) NSData *data; ``` 图片原始 NSData 数据。 ### error ```objectivec @property (nonatomic, retain, nullable) NSError *error; ``` 请求中错误码，若请求失败，则该属性不为空。 ### cachePath ```objectivec @property (nonatomic, copy, nullable) NSString *cachePath; ``` 最终缓存路径，未设置 [BDImageRequestNeedCachePath](https://www.volcengine.com/docs/508/1262416#%E6%9E%9A%E4%B8%BE%E5%80%BC-3) 选项则默认为空。 ### progress ```objectivec @property (nonatomic, assign) double progress; ``` 当前网络下载进度，范围为 [0.0, 1.0]。 ### receivedSize ```objectivec @property (nonatomic, assign)int64_t receivedSize; ``` 当前已经接收到的字节数。 ### expectedSize ```objectivec @property (nonatomic, assign)int64_t expectedSize; ``` 预期接收到的总字节数。 ### minNotifiProgressInterval ```objectivec @property (nonatomic, assign)double minNotifiProgressInterval; ``` 最小进度变化通知，范围为 [0.0, 1.0]，默认为 0.05。 **注意** 设置过高会导致频繁回调，从而影响性能。 ### maxRetryCount ```objectivec @property (nonatomic, assign)NSInteger maxRetryCount; ``` 最大重试次数。 ### transformer ```objectivec @property (nonatomic, strong, nullable) BDBaseTransformer *transformer; ``` 图片加工实例，详见 [BDBlockTransformer](#BDBlockTransformer) 和 [BDRoundCornerTransformer](#BDRoundCornerTransformer)。 ### cancelled ```objectivec @property (nonatomic, readonly, getter=isCancelled)BOOL cancelled; ``` 当前请求是否被取消。 - `YES`：是 - `NO`：否 ### failed ```objectivec @property (nonatomic, readonly, getter=isFailed)BOOL failed; ``` 当前请求是否失败。 - `YES`：是 - `NO`：否 ### finished ```objectivec @property (nonatomic, readonly, getter=isFinished)BOOL finished; ``` 当前请求是否已结束。 - `YES`：是 - `NO`：否 ### recorder ```objectivec @property (nonatomic, strong, readonly, nonnull) BDImagePerformanceRecoder *recorder; ``` 性能记录模块。 ### largeImageMonitor ```objectivec @property (nonatomic, strong, readonly, nonnull) BDImageLargeSizeMonitor *largeImageMonitor; ``` 大图监控模块。 ### largeImageFileSizeLimit ```objectivec @property (nonatomic, assign, class) NSUInteger largeImageFileSizeLimit; ``` 判断是否为大图的文件大小阈值，默认值为 20MB。 ### largeImageMemoryLimit ```objectivec @property (nonatomic, assign, class) NSUInteger largeImageMemoryLimit; ``` 判断是否为大图的内存占用阈值，默认值为 4 倍屏幕分辨率。 ### largeImageViewResolutionScaleLimit ```objectivec @property (nonatomic, assign, class) CGFloat largeImageViewResolutionScaleLimit; ``` 判断是否为大图的 view 分辨率阈值（即 view 分辨率 * largeImageViewResolutionScaleLimit），默认值为 2。 ### isMonitorDecodedImageQuality ```objectivec @property (nonatomic, assign, class) BOOL isMonitorDecodedImageQuality; ``` 是否开启黑白屏监控。 - `YES`：是 - `NO`：（默认值）否 ### randomSamplingPointCount ```objectivec @property (nonatomic, assign) NSUInteger randomSamplingPointCount; ``` 随机采样解码后图片的像素个数，默认值为 30。 ## 函数说明 ### addRetryErrorCode: ```objectivec + (void)addRetryErrorCode:(NSInteger)code; ``` 增加需要重试请求的错误码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | code | NSInteger | 添加的错误码。 | ### removeRetryErrorCode: ```objectivec + (void)removeRetryErrorCode:(NSInteger)code; ``` 删除需要重试请求的错误码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | code | NSInteger | 删除的错误码。 | ### setSizeLimitByScreenPoint: ```objectivec - (void)setSizeLimitByScreenPoint:(CGSize)screenPointSize; ``` 设置 sizeLimit 的值，单位是 point，对应在屏幕上的点。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | screenPointSize | CGSize | 降采样后图片尺寸。 | **注意** 内部会自动对齐至像素后设置。 ### initWithURL:alternativeURLs: ```objectivec - (instancetype _Nonnull)initWithURL:(NSURL * _Nonnull)url alternativeURLs:(NSArray * _Nullable)alternativeURLs NS_DESIGNATED_INITIALIZER; ``` 构建图片请求。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 图片访问 URL。 | | alternativeURLs | NSArray\* | 备用图片 URL 数组。 | **返回值** 图片请求实例。 ### cancel ```objectivec - (void)cancel; ``` 取消当前请求。如果有其他相同标识的请求存在，并不会取消其他请求。 # BDImageRequestKey ```objectivec @interface BDImageRequestKey : NSObject ``` 设置生成网络请求和图片的唯一标识。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [targetKey](#BDImageRequestKey-targetkey) | | NSString* | [sourceKey](#BDImageRequestKey-sourcekey) | | NSString* | [sourceThumbKey](#BDImageRequestKey-sourcethumbkey) | | CGSize | [sizeLimit](#BDImageRequestKey-sizelimit) | | NSUInteger | [memoryLimit](#BDImageRequestKey-memorylimit) | | CGRect | [cropRect](#BDImageRequestKey-croprect) | | NSString* | [transformName](#BDImageRequestKey-transformname) | | BOOL | [smartCrop](#BDImageRequestKey-smartcrop) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [regenerateTargetKey](#BDImageRequestKey-regeneratetargetkey) | | instancetype | [initWithSourceKey:](#BDImageRequestKey-initwithsourcekey) | | BOOL | [containsUrl:](#BDImageRequestKey-containsurl) | | NSString* | [extendKeyWithType:value:](#BDImageRequestKey-extendkeywithtype-value) | ## 变量说明 ### targetKey ```objectivec @property (nonatomic, copy, readonly) NSString *targetKey; ``` 用于标识相同的结果，如果 targetKey 相同便可以复用相同的图片返回给业务。 ### sourceKey ```objectivec @property (nonatomic, copy) NSString *sourceKey; ``` 用于标识相同的网络请求数据，如果 sourceKey 相同便可以复用网络下载内容。 ### sourceThumbKey ```objectivec @property (nonatomic, copy) NSString *sourceThumbKey; ``` 用于标识使用的 heic 静图缩略图。 ### sizeLimit ```objectivec @property (nonatomic, assign) CGSize sizeLimit; ``` 降采样图片尺寸大小。 ### memoryLimit ```objectivec @property (nonatomic, assign) NSUInteger memoryLimit; ``` 降采样图片内存大小，单位为 Byte。 **注意** 若同时设置 `sizeLimit` 和 `memoryLimit`，则 `sizeLimit` 配置生效。 ### cropRect ```objectivec @property (nonatomic, assign) CGRect cropRect; ``` 图片智能裁剪区域。 ### transformName ```objectivec @property (atomic, copy) NSString *transformName; ``` 图片后处理的标识符。 ### smartCrop ```objectivec @property (nonatomic, assign) BOOL smartCrop; ``` 是否开启图片智能裁剪。 - `YES`：是 - `NO`：否 ## 函数说明 ### regenerateTargetKey ```objectivec - (void)regenerateTargetKey; ``` 生成 targetKey 属性。 ### initWithSourceKey: ```objectivec - (instancetype)initWithSourceKey:(NSString * _Nonnull)sourceKey; ``` 通过 sourceKey 生成图像请求的唯一标识。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | sourceKey | NSString* | 网络请求数据的唯一标识，可由 [BDWebImageManager.sharedManager requestKeyWithURL:] 方法生成。 | **返回值** 图像请求的唯一标识实例。 ### containsUrl: ```objectivec - (BOOL)containsUrl:(NSString *)url; ``` 判断 sourceKey 是否包含 url。 - `YES`：是 - `NO`：否 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSString* | 需要判断的 URL。 | **返回值** 判断结果。 ### extendKeyWithType:value: ```objectivec - (NSString *)extendKeyWithType:(NSString *)type value:(NSString *)value; ``` 在原本 targetKey 的基础上拼接出一个新的 targetKey。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | NSString* | 需要拼接的类型。 | | value | NSString* | 需要拼接的值 | **返回值** 拼接之后的 targetKey。 # UIImage(BlurHash) ```objectivec @interface UIImage (BlurHash) ``` 适配 UIImage 的 veImageX category，提供模糊图占位（BulrHash）能力。 ## 成员函数 | 返回 | 名称 | | --- | --- | | nullable instancetype | [initWithBlurHashConfig:](#UIImage(BlurHash)-initwithblurhashconfig) | ## 函数说明 ### initWithBlurHashConfig: ```objectivec - (nullable instancetype)initWithBlurHashConfig:(BDBlurHashConfig *)config; ``` 解码 BlurHash。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | BDBlurHashConfig* | BlurHash 的解码配置，详见 [BDBlurHashConfig](1262416#BDBlurHashConfig)。 | **返回值** 解码后的图片，失败则为 nil。 # UIImage(BDWebImageToData) ```objectivec @interface UIImage (BDWebImageToData) ``` 适配 UIImage 的 veImageX category，提供图片数据。 ## 静态函数 | 返回 | 名称 | | --- | --- | | nullable UIImage* | [bd_imageWithData:](#UIImage(BDWebImageToData)-bd_imagewithdata) | | nullable UIImage* | [bd_imageWithData:url:isCache:downsampleSize:](#UIImage(BDWebImageToData)-bd_imagewithdata-url-iscache-downsamplesize) | | nullable UIImage* | [bd_imageWithData:downsampleSize:](#UIImage(BDWebImageToData)-bd_imagewithdata-downsamplesize) | ## 成员函数 | 返回 | 名称 | | --- | --- | | nullable NSData* | [bd_imageDataRepresentation](#UIImage(BDWebImageToData)-bd_imagedatarepresentation) | | void | [bd_awebpToGifDataWithCompletion:](#UIImage(BDWebImageToData)-bd_awebptogifdatawithcompletion) | | void | [bd_heifToGifDataWithCompletion:](#UIImage(BDWebImageToData)-bd_heiftogifdatawithcompletion) | | NSUInteger | [bd_imageCost](#UIImage(BDWebImageToData)-bd_imagecost) | | NSUInteger | [bd_firstFrameCost](#UIImage(BDWebImageToData)-bd_firstframecost) | | nullable NSData* | [bd_encodeWithImageType:](#UIImage(BDWebImageToData)-bd_encodewithimagetype) | | nullable NSData* | [bd_encodeWithImageTypeAndQuality:qualityFactor:](#UIImage(BDWebImageToData)-bd_encodewithimagetypeandquality-qualityfactor) | ## 函数说明 ### bd_imageWithData: ```objectivec + (nullable UIImage *)bd_imageWithData:(nullable NSData *)data; ``` 使用系统解码，解码图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | nullable NSData* | 需要解码的源数据。 | **返回值** 解码后的图片。 ### bd_imageWithData:url:isCache:downsampleSize: ```objectivec + (nullable UIImage *)bd_imageWithData:(nullable NSData *)data url:(NSString *_Nonnull)url isCache:(BOOL)isCache downsampleSize:(CGSize)downsampleSize; ``` 使用系统解码，解码图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | nullable NSData* | 需要解码的源数据。 | | url | NSString* | 图片的 URL，作为缓存的键值。 | | isCache | BOOL | 是否需要进行缓存的存取。

`YES`：是

`NO`：否

| | downsampleSize | CGSize | 指定降采样后图片的宽高。默认值为 CGSizeZero。 | **返回值** 解码后的图片。 ### bd_imageWithData:downsampleSize: ```objectivec + (nullable UIImage *)bd_imageWithData:(nullable NSData *)data downsampleSize:(CGSize)downsampleSize; ``` 使用系统解码，解码图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | nullable NSData* | 需要解码的源数据。 | | downsampleSize | CGSize | 降采样参数，默认值为 CGSizeZero。 | **返回值** 解码后的图片。 ### bd_imageDataRepresentation ```objectivec - (nullable NSData *)bd_imageDataRepresentation; ``` 获得当前 UIImage 的 NSData 数据形式。 **返回值** 图片源数据。 **注意** 对于动图（gif、apng 和 awebp），会返回源数据；对于包含 alpha 通道的图片，会返回 png 格式的源数据；对于不需要 alpha 通道的图片，会返回质量参数为 0.9 的 jpeg 格式源数据。 ### bd_awebpToGifDataWithCompletion: ```objectivec - (void)bd_awebpToGifDataWithCompletion:(void(^ __nullable)(NSData * _Nullable gifData, NSError * _Nullable error))completion; ``` 设置图片格式转换，将 awebp 格式转为 gif 格式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | completion | void(^)(NSData* gifData, NSError* error) | 转换完成后的回调，包含转换结果。 | ### bd_heifToGifDataWithCompletion: ```objectivec - (void)bd_heifToGifDataWithCompletion:(void(^ __nullable)(NSData * _Nullable gifData, NSError * _Nullable error))completion; ``` 设置图片格式转换，将 heif 格式转为 gif 格式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | completion | void(^)(NSData* gifData, NSError* error) | 转换完成后的回调，包含转换结果。 | ### bd_imageCost ```objectivec - (NSUInteger)bd_imageCost; ``` 获取图片内存占用大小，单位为 byte。 **返回值** 计算结果。 ### bd_firstFrameCost ```objectivec - (NSUInteger)bd_firstFrameCost; ``` 获取图片内存占用大小，如果是动图则只计算第一帧，单位是 byte。 **返回值** 计算结果。 ### bd_encodeWithImageType: ```objectivec - (nullable NSData *)bd_encodeWithImageType:(BDImageCodeType)codeType; ``` 对当前图片进行系统编码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | codeType | BDImageCodeType | 指定编码的图片格式。 | **返回值** 编码后的图片数据。 **注意** 不支持动图格式编码。 ### bd_encodeWithImageTypeAndQuality:qualityFactor: ```objectivec - (nullable NSData *)bd_encodeWithImageTypeAndQuality:(BDImageCodeType)codeType qualityFactor:(float)qualityFactor; ``` 对当前图片进行系统编码。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | codeType | BDImageCodeType | 指定编码的图片格式。 | | qualityFactor | float | 质量参数，仅 webp 格式支持。默认值为 80，取值范围为 [1, 100]。取值越小，压缩率越大，画质越模糊。 | **返回值** 编码后的图片数据。 **注意** 不支持动图格式编码。 # UIImage(BDImageTransform) ```objectivec @interface UIImage (BDImageTransform) ``` 图像转换处理相关接口，包含图片裁剪、染色、圆角处理、边框设置、图片旋转、图片翻转、模糊处理等能力。 ## 静态函数 | 返回 | 名称 | | --- | --- | | nullable UIImage* | [bd_imageWithSmallGIFData:scale:](#UIImage(BDImageTransform)-bd_imagewithsmallgifdata-scale) | | nullable UIImage* | [bd_imageWithColor:](#UIImage(BDImageTransform)-bd_imagewithcolor) | | nullable UIImage* | [bd_imageWithColor:size:](#UIImage(BDImageTransform)-bd_imagewithcolor-size) | | nullable UIImage* | [bd_imageWithSize:drawBlock:](#UIImage(BDImageTransform)-bd_imagewithsize-drawblock) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [bd_hasAlphaChannel](#UIImage(BDImageTransform)-bd_hasalphachannel) | | void | [bd_drawInRect:withContentMode:clipsToBounds:](#UIImage(BDImageTransform)-bd_drawinrect-withcontentmode-clipstobounds) | | nullable UIImage* | [bd_imageByResizeToSize:](#UIImage(BDImageTransform)-bd_imagebyresizetosize) | | nullable UIImage* | [bd_imageByResizeToSize:contentMode:](#UIImage(BDImageTransform)-bd_imagebyresizetosize-contentmode) | | nullable UIImage* | [bd_imageByCropToRect:](#UIImage(BDImageTransform)-bd_imagebycroptorect) | | nullable UIImage* | [bd_imageByInsetEdge:withColor:](#UIImage(BDImageTransform)-bd_imagebyinsetedge-withcolor) | | nullable UIImage* | [bd_imageByRoundCornerRadius:](#UIImage(BDImageTransform)-bd_imagebyroundcornerradius) | | nullable UIImage* | [bd_imageByRoundCornerRadius:borderWidth:borderColor:](#UIImage(BDImageTransform)-bd_imagebyroundcornerradius-borderwidth-bordercolor) | | nullable UIImage* | [bd_imageByRoundCornerRadius:corners:borderWidth:borderColor:borderLineJoin:](#UIImage(BDImageTransform)-bd_imagebyroundcornerradius-corners-borderwidth-bordercolor-borderlinejoin) | | nullable UIImage* | [bd_imageByRotate:fitSize:](#UIImage(BDImageTransform)-bd_imagebyrotate-fitsize) | | nullable UIImage* | [bd_imageByRotateLeft90](#UIImage(BDImageTransform)-bd_imagebyrotateleft90) | | nullable UIImage* | [bd_imageByRotateRight90](#UIImage(BDImageTransform)-bd_imagebyrotateright90) | | nullable UIImage* | [bd_imageByRotate180](#UIImage(BDImageTransform)-bd_imagebyrotate180) | | nullable UIImage* | [bd_imageByFlipVertical](#UIImage(BDImageTransform)-bd_imagebyflipvertical) | | nullable UIImage* | [bd_imageByFlipHorizontal](#UIImage(BDImageTransform)-bd_imagebyfliphorizontal) | | nullable UIImage* | [bd_imageByTintColor:](#UIImage(BDImageTransform)-bd_imagebytintcolor) | | nullable UIImage* | [bd_imageByGrayscale](#UIImage(BDImageTransform)-bd_imagebygrayscale) | | nullable UIImage* | [bd_imageByBlurSoft](#UIImage(BDImageTransform)-bd_imagebyblursoft) | | nullable UIImage* | [bd_imageByBlurLight](#UIImage(BDImageTransform)-bd_imagebyblurlight) | | nullable UIImage* | [bd_imageByBlurExtraLight](#UIImage(BDImageTransform)-bd_imagebyblurextralight) | | nullable UIImage* | [bd_imageByBlurDark](#UIImage(BDImageTransform)-bd_imagebyblurdark) | | nullable UIImage* | [bd_imageByBlurWithTint:](#UIImage(BDImageTransform)-bd_imagebyblurwithtint) | | nullable UIImage* | [bd_imageByBlurRadius:tintColor:tintMode:saturation:maskImage:](#UIImage(BDImageTransform)-bd_imagebyblurradius-tintcolor-tintmode-saturation-maskimage) | ## 函数说明 ### bd_imageWithSmallGIFData:scale: ```objectivec + (nullable UIImage *)bd_imageWithSmallGIFData:(nullable NSData *)data scale:(CGFloat)scale; ``` 解码为 gif 动图。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | nullable NSData* | gif 源数据。 | | scale | CGFloat | 图片降采样倍数，即指定图像尺寸等比缩小的比例。取值需大于 1，取值为 2 时，表示生成图的宽高将缩小为原图尺寸的一半。 | **返回值** 解码后的 gif 图片。 ### bd_imageWithColor: ```objectivec + (nullable UIImage *)bd_imageWithColor:(nullable UIColor *)color; ``` 生成宽高为 1 x 1 大小的纯色图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | color | nullable UIColor* | 指定纯色图片的底色。 | **返回值** 纯色图片。 ### bd_imageWithColor:size: ```objectivec + (nullable UIImage *)bd_imageWithColor:(nullable UIColor *)color size:(CGSize)size; ``` 生成指定大小的纯色图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | color | nullable UIColor* | 指定纯色图片的底色。 | | size | CGSize | 指定图片尺寸大小。 | **返回值** 纯色图片。 ### bd_imageWithSize:drawBlock: ```objectivec + (nullable UIImage *)bd_imageWithSize:(CGSize)size drawBlock:(void (^)(_Nonnull CGContextRef context))drawBlock; ``` 生成指定大小的自行绘制的图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | size | CGSize | 指定图片尺寸大小。 | | drawBlock | void(^)( CGContextRef context) | 业务传入的 block，对 CGContextRef 进行绘制。 | **返回值** 业务需要的图片。 ### bd_hasAlphaChannel ```objectivec - (BOOL)bd_hasAlphaChannel; ``` 判断当前图片是否包含 alpha 通道。 - `YES`：是 - `NO`：否 **返回值** 判断结果。 ### bd_drawInRect:withContentMode:clipsToBounds: ```objectivec - (void)bd_drawInRect:(CGRect)rect withContentMode:(UIViewContentMode)contentMode clipsToBounds:(BOOL)clips; ``` 在指定区域内进行绘制，并满足指定 UIViewContentMode。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | rect | CGRect | 指定的绘画区域。 | | contentMode | UIViewContentMode | 指定的 UIViewContentMode。 | | clips | BOOL | 内容是否被限制在指定矩形区域内。

`YES`：是

`NO`：否

| ### bd_imageByResizeToSize: ```objectivec - (nullable UIImage *)bd_imageByResizeToSize:(CGSize)size; ``` 图片缩放处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | size | CGSize | 指定缩放后图片的尺寸。 | **返回值** 新图片。 ### bd_imageByResizeToSize:contentMode: ```objectivec - (nullable UIImage *)bd_imageByResizeToSize:(CGSize)size contentMode:(UIViewContentMode)contentMode; ``` 图片缩放处理，并指定 UIViewContentMode。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | size | CGSize | 指定的缩放后图片的尺寸。 | | contentMode | UIViewContentMode | 业务指定 UIViewContentMode。 | **返回值** 新图片。 ### bd_imageByCropToRect: ```objectivec - (nullable UIImage *)bd_imageByCropToRect:(CGRect)rect; ``` 从当前图片裁剪出新图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | rect | CGRect | 指定的新图片在原图上的裁剪区域。 | **返回值** 新图片。 ### bd_imageByInsetEdge:withColor: ```objectivec - (nullable UIImage *)bd_imageByInsetEdge:(UIEdgeInsets)insets withColor:(nullable UIColor *)color; ``` 填充当前图片边界的颜色以获得新图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | insets | UIEdgeInsets | 指定进行填充的边界。 | | color | nullable UIColor* | 指定的颜色。 | **返回值** 新图片。 ### bd_imageByRoundCornerRadius: ```objectivec - (nullable UIImage *)bd_imageByRoundCornerRadius:(CGFloat)radius; ``` 获取圆角处理后的图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | radius | CGFloat | 圆角的椭圆半径，最大为宽度或高度的一半。 | **返回值** 新图片。 ### bd_imageByRoundCornerRadius:borderWidth:borderColor: ```objectivec - (nullable UIImage *)bd_imageByRoundCornerRadius:(CGFloat)radius borderWidth:(CGFloat)borderWidth borderColor:(nullable UIColor *)borderColor; ``` 获取圆角处理和边框设定后的图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | radius | CGFloat | 圆角的椭圆半径，最大为宽度或高度的一半。 | | borderWidth | CGFloat | 边框线宽，最大为宽度或高度的一半。 | | borderColor | nullable UIColor* | 边框指定颜色。 | **返回值** 新图片。 ### bd_imageByRoundCornerRadius:corners:borderWidth:borderColor:borderLineJoin: ```objectivec - (nullable UIImage *)bd_imageByRoundCornerRadius:(CGFloat)radius corners:(UIRectCorner)corners borderWidth:(CGFloat)borderWidth borderColor:(nullable UIColor *)borderColor borderLineJoin:(CGLineJoin)borderLineJoin; ``` 获取圆角处理和边框设定后的图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | radius | CGFloat | 圆角的椭圆半径，最大为宽度或高度的一半。 | | corners | UIRectCorner | 指定需要圆角处理的角。 | | borderWidth | CGFloat | 边框线宽，最大为宽度或高度的一半。 | | borderColor | nullable UIColor* | 边框指定颜色。 | | borderLineJoin | CGLineJoin | 指定边框连接的样式。 | **返回值** 新图片。 ### bd_imageByRotate:fitSize: ```objectivec - (nullable UIImage *)bd_imageByRotate:(CGFloat)radians fitSize:(BOOL)fitSize; ``` 获取旋转后的图片，旋转方向为逆时针。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | radians | CGFloat | 旋转角度。取值范围为 [0,360]。 | | fitSize | BOOL | 旋转后是否要适应尺寸。

`YES`：是

`NO`：否

| **返回值** 新图片。 **注意** 若 fitSize 为 NO，旋转后的图片可能会有裁剪。 ### bd_imageByRotateLeft90 ```objectivec - (nullable UIImage *)bd_imageByRotateLeft90; ``` 获取逆时针旋转 90 度后的新图片。 **返回值** 新图片。 ### bd_imageByRotateRight90 ```objectivec - (nullable UIImage *)bd_imageByRotateRight90; ``` 获取顺时针旋转 90 度后的新图片。 **返回值** 新图片。 ### bd_imageByRotate180 ```objectivec - (nullable UIImage *)bd_imageByRotate180; ``` 获取旋转 180 度后的新图片。 **返回值** 新图片。 ### bd_imageByFlipVertical ```objectivec - (nullable UIImage *)bd_imageByFlipVertical; ``` 获取垂直翻转后的新图片。 **返回值** 新图片。 ### bd_imageByFlipHorizontal ```objectivec - (nullable UIImage *)bd_imageByFlipHorizontal; ``` 获取水平翻转后的新图片。 **返回值** 新图片。 ### bd_imageByTintColor: ```objectivec - (nullable UIImage *)bd_imageByTintColor:(nullable UIColor *)color; ``` 获取染色后的新图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | color | nullable UIColor* | 指定的颜色。 | **返回值** 新图片。 ### bd_imageByGrayscale ```objectivec - (nullable UIImage *)bd_imageByGrayscale; ``` 获取灰度化的新图片。 **返回值** 新图片。 ### bd_imageByBlurSoft ```objectivec - (nullable UIImage *)bd_imageByBlurSoft; ``` 获取模糊化的新图片。 **返回值** 新图片。 ### bd_imageByBlurLight ```objectivec - (nullable UIImage *)bd_imageByBlurLight; ``` 获取模糊化的新图片，保留纯白色区域不被模糊。 **返回值** 新图片。 ### bd_imageByBlurExtraLight ```objectivec - (nullable UIImage *)bd_imageByBlurExtraLight; ``` 获取模糊化的新图片，适合显示黑色文本。 **返回值** 新图片。 ### bd_imageByBlurDark ```objectivec - (nullable UIImage *)bd_imageByBlurDark; ``` 获取模糊化的新图片，适合显示白色文本。 **返回值** 新图片。 ### bd_imageByBlurWithTint: ```objectivec - (nullable UIImage *)bd_imageByBlurWithTint:(nullable UIColor *)tintColor; ``` 获取模糊和染色处理后的新图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | tintColor | nullable UIColor* | 指定的颜色。 | **返回值** 新图片。 ### bd_imageByBlurRadius:tintColor:tintMode:saturation:maskImage: ```objectivec - (nullable UIImage *)bd_imageByBlurRadius:(CGFloat)blurRadius tintColor:(nullable UIColor *)tintColor tintMode:(CGBlendMode)tintBlendMode saturation:(CGFloat)saturation maskImage:(nullable UIImage *)maskImage; ``` 对原图进行处理后获得新图片，支持模糊、着色、饱和度调整。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | blurRadius | CGFloat | 设置模糊半径大小，单位为点。取值为 `0`，表示不执行模糊处理。 | | tintColor | nullable UIColor* | 指定颜色，对模糊和饱和度调整的结果进行均匀混合，该颜色的 alpha 通道决定了着色的强度，nil 表示不进行着色。 | | tintBlendMode | CGBlendMode | tintColor 的混合模式。 | | saturation | CGFloat | 饱和度。

取值为 0：表示灰度图像。

取值为 1.0：表示不改变结果图像。

取值小于 1.0：降低饱和度，取值越小，饱和度越低。

取值大于 1.0：提高饱和度，取值越大，饱和度越高。

| | maskImage | nullable UIImage* | 配置生效的图片区域，需满足 CGContextClipToMask 的遮罩要求。 | **返回值** 新图片。 # BDWebImageURLFilter ```objectivec @interface BDWebImageURLFilter : NSObject ``` URL 过滤器。用于过滤给定的 URL 并生成对应的标识符，以便于标识和管理 URL。 ## 成员函数 | 返回 | 名称 | | --- | --- | | NSString* | [identifierWithURL:](#BDWebImageURLFilter-identifierwithurl) | ## 函数说明 ### identifierWithURL: ```objectivec - (NSString * _Nonnull)identifierWithURL:(NSURL * _Nonnull)url; ``` 根据 URL 生成标识符。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSURL* | 需要生成标识符的 URL。 | **返回值** 生成的标识符。 **注意** 可将生成的标识设置到 BDWebImageManager.urlFilter 属性。