API接口说明

1. IVManager类

提供接入授权处理,模型管理、下载、缓存和更新

1.1. 初始化方法

-(instancetype)initWithDevKey:(NSString *)devKey

参数说明

 appID:应用程序的Bundle Identifier

 devKey:开发密钥

 callback:回调函数

1.2. 更新模型方法

-(void)updateModelsWithCallback:(void(^)(BOOL success, NSError *error))callback

参数说明

 callback:回调函数

1.3. 模型列表

-(NSArray *)models

1.4. 清除缓存的模型

-(void)clearModels

1.5. 创建默认模型超分辨网络类方法

-(void)loadDefautIVImage

1.6. 创建特定模型超分辨网络类方法

-(void)loadIVImageWithModelName:(NSString *)modelName

 参数说明

 modelName:模型名称

2. IVImage类

2.1. 初始化方法

-(void)initWithModelName:(NSString *)modelName modelKey:(NSString *)modelKey

参数说明

 modelName:模型的名称

 modelKey:模型密钥

2.2. 设置显示模式

@property (nonamotic) IVImageDisplayMode displayMode

参数说明

 IVImageDisplayMode_LR:显示输入图像

 IVImageDisplayMode_SR:显示输超分图像

 IVImageDisplayMode_LRSR:分屏显示输入和超分图像

2.3. 设置分屏比例

@property (nonamotic) float splitPercent

2.4. 限制超分时间

@property (nonamotic) float elapsedTimeNeededInSeconds

SDK 将在限制时间内完成超分,默认值为 1 秒, 设置0将不做限制

2.5. 获取在限制时间内可支持的最大图像像素大小

@property (nonamotic,readonly) NSUInteger maxPixelsInSeconds;

2.6. 判断是否支持输入的像素

-(BOOL)isSupportPixels:(NSInterge)inputPixels;

2.7. RGB图像超分辨率方法,返回UIIMage

- (UIImage *)scaleImageWithImage:(UIImage *)image

参数说明

 image:输入UIImage对象

 返回放大后UIImage对象

2.8. RGB图像超分辨率方法,返回IVTexture

-(IVTexture *)srcaleTextureWithImage:(UIImage *)image

参数说明

 image:输入UIImage对象

返回放大后MTLTexure对象

2.9. YUV图像超分辨率方法,返回IVTexture

- (IVTecture *)scaleTextureWithY:(NSData *)y
                 u:(NSData *)u
                 v:(NSData *)v
               width:(NSUInteger)width
              height:(NSUInteger)height

参数说明

 y: 图像y通道数据

 u: 图像u通道数据

 v: 图像v通道数据

 width: 图像宽度

 height:图像高度

返回 IVTexture对象

2.10. 清除缓存

- (void)cleanCache

        2.11. 获取输出图像大小

- (CGSize)newSizeForOldSize:(CGSize)oldsize

3. IVImageView类

3.1. 设置图形显示偏移 

@property (nonatomic) CGPoint offset;

3.2. 设置图形显示缩放比例

@property (nonatomic) float scale;

3.3. 设置图形显示自由模式

@property (nonatomic) bool contentModeFree;

3.4. 绘制纹理

- (void)render:(IVTexture *)texture;

3.5. 重新绘制当前纹理

- (void)redraw;

4. IVTexture类

4.1. 获取图像宽/高

@property (nonatomic, readonly) int width;
@property (nonatomic, readonly) int height;

4.2. 获取UI Image图像 

- (UIImage *)image

4.3. 获取图像像素buffer 

- (void)getRawData:(unsigned char *)data;

5. IVStatus

状态命名

状态值

描述

IVStatus_Success

0

成功

IVStatus_UnknowError

-1

未定义错误




IVStatus_InvalidData

-10001

HTTP请求,无效数据

IVStatus_InvalidParmeter

-10002

HTTP请求,无效参数

IVStatus_InvalidSignature

-10003

HTTP请求,无效签名

IVStatus_InvalidAppIDorDevKey

-10004

HTTP请求,无效AppIDDevKey

IVStatus_DatabaseConnectError

-10005

数据库连接错误

IVStatus_DatabaseOpenError

-10006

数据库打开错误




IVStatus_AppNotAuthorized

-20000

App未验证

IVStatus_LoadModelError

-20001

加载模型错误

IVStatus_ModelNotFound

-20002

模型文件未找到

IVStatus_InvalidModelDefine

-20003

无效模型定义

IVStatus_InvalidReturnData

-20004

返回数据

IVStatus_CertificationNotFound

-20005

证书文件找到




IVStatus_iOSNotSupport

-30001

iOS系统版本不支持

IVStatus_GPUNotSupport

-30002

设备GPU不支持

IVStatus_ServerConnectError

-30003

服务器连接错误