NIMImageObject.h
2.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
//
// NIMImageObject.h
// NIMLib
//
// Created by Netease.
// Copyright (c) 2015年 Netease. All rights reserved.
//
#import "NIMMessageObjectProtocol.h"
#import "NIMPlatform.h"
NS_ASSUME_NONNULL_BEGIN
/**
* 图片格式
*/
typedef NS_ENUM(NSInteger, NIMImageFormat)
{
/**
* Jpeg格式
*/
NIMImageFormatJPEG,
/**
* Png格式
*/
NIMImageFormatPNG,
};
/**
* 图片选项
*/
@interface NIMImageOption : NSObject
/**
* 压缩参数默认为0,可传入0.0-1.0的值,如果值为0或者不合法参数时按照0.5进行压缩
*/
@property (nonatomic,assign) float compressQuality;
/**
* 图片压缩格式,默认为JPEG
*/
@property (nonatomic,assign) NIMImageFormat format;
@end
/**
* 图片实例对象
*/
@interface NIMImageObject : NSObject<NIMMessageObject>
/**
* 图片实例对象初始化方法
*
* @param image 要发送的图片
*
* @return 图片实例对象
*/
- (instancetype)initWithImage:(UIImage*)image;
/**
* 图片实例对象初始化方法
*
* @param filepath 要发送的图片路径
*
* @discussion 使用此方法上传是不做压缩转换的原图上传。iOS 11 苹果采用了新的图片格式 HEIC ，如果采用原图会导致其他设备的兼容问题，请开发者在上层做好格式的兼容转换。
*
* @return 图片实例对象
*/
- (instancetype)initWithFilepath:(NSString *)filepath;
/**
* 图片实例对象初始化方法
*
* @param data 图片数据
* @param extension 推荐使用的图片数据后缀名
*
* @return 图片实例对象
*/
- (instancetype)initWithData:(NSData *)data
extension:(NSString *)extension;
/**
* 文件展示名
*/
@property (nullable, nonatomic, copy) NSString *displayName;
/**
* 图片本地路径
* @discussion 目前 SDK 没有提供下载大图的方法,但推荐使用这个地址作为图片下载地址,APP 可以使用自己的下载类或者 SDWebImage 做图片的下载和管理
*/
@property (nullable, nonatomic, copy, readonly) NSString *path;
/**
* 缩略图本地路径
*/
@property (nullable, nonatomic, copy, readonly) NSString *thumbPath;
/**
* 图片远程路径
*/
@property (nullable, nonatomic, copy, readonly) NSString *url;
/**
* 缩略图远程路径
* @discussion 仅适用于使用云信上传服务进行上传的资源，否则无效。
*/
@property (nullable, nonatomic, copy, readonly) NSString *thumbUrl;
/**
* 图片尺寸
*/
@property (nonatomic, assign, readonly) CGSize size;
/**
* 图片选项
* @discussion 仅在发送时且通过 initWithImage: 方式初始化才有效
*/
@property (nullable, nonatomic ,strong) NIMImageOption *option;
/**
* 文件大小
*/
@property (nonatomic, assign, readonly) long long fileLength;
@end
NS_ASSUME_NONNULL_END