Files
Hippy/modules/ios/image/HippyImageProviderProtocol.h

96 lines
2.3 KiB
Objective-C

/*!
* iOS SDK
*
* Tencent is pleased to support the open source community by making
* Hippy available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company.
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
@class UIImage;
NS_ASSUME_NONNULL_BEGIN
@protocol HippyImageProviderProtocol <NSObject>
@required
/** ask delegate that can data be handled
*/
+ (BOOL)canHandleData:(NSData *)data;
/** ask delegate that data represent an animated image(gif,apng,etc)
*/
+ (BOOL)isAnimatedImage:(NSData *)data;
/**
* Image scale
*/
@property (nonatomic, assign) CGFloat scale;
@property(nonatomic, copy)NSString *imageDataPath;
/**
* Set image data for provider
*
* @param data Image data
*/
- (void)setImageData:(NSData *)data;
/**
* Set the decoded image
* image is returned by the `- (UIImage *)image` method
*
* When using third-party component to download the image, such as `SDWebImage`,
* the third-party component usually returns the final image, not just the raw data.
*
* In this scenario, hippyImageView calls this method to set the image directly
* and skip all other processing logic.
*/
- (void)setDecodedImage:(UIImage *)image;
/** return image.If it is an animated image,return first frame
*/
- (UIImage *)image;
/** prepare the image for display */
- (void)prepareForDisplay:(void (^_Nullable)(UIImage *_Nullable))completionHandler;
// for animated Image
@optional
/** return frame count for animated image
*/
- (NSUInteger)imageCount;
/** return frame at index
*/
- (UIImage *)imageAtFrame:(NSUInteger)frame;
/**return animated image loop count
* return 0 means loop forever
*/
- (NSUInteger)loopCount;
/** delay time for frame at index
*/
- (NSTimeInterval)delayTimeAtFrame:(NSUInteger)frame;
@end
NS_ASSUME_NONNULL_END