AgoraRtmImageMessage Class Reference

Inherits from AgoraRtmMessage : NSObject
Declared in AgoraRtmKit.h

Overview

用于设置或获取图片消息属性的接口类，可用于点对点或频道消息。 继承自 AgoraRtmMessage 接口类。

  size

上传图片的大小，单位为字节。

@property (nonatomic, assign, readonly) long long size

Declared In

AgoraRtmKit.h

  mediaId

上传图片的 media ID。

@property (nonatomic, nonnull, readonly) NSString *mediaId

Discussion

  • 图片成功上传到服务器后，SDK 会自动分配一个 media ID。
  • media ID 的有效期为 7 天，因为每份上传文件只能在文件服务器保留 7 天。

Declared In

AgoraRtmKit.h

  thumbnail

上传图片的缩略图（二进制文件）。

@property (nonatomic, copy, nonnull) NSData *thumbnail

Discussion

NOTE thumbnail 和 fileName 加起来的大小不得超过 32 KB。

Declared In

AgoraRtmKit.h

  fileName

上传图片的文件名。

@property (nonatomic, copy, nonnull) NSString *fileName

Discussion

NOTE thumbnail 和 fileName 加起来的大小不得超过 32 KB。

Declared In

AgoraRtmKit.h

  height

上传图片的高度。

@property (nonatomic, assign) int height

Discussion

NOTE

  • 如果上传图片的格式为 JPG、JPEG、BMP，或 PNG，SDK 会自动计算图片的宽和高。
  • 用户自行设置的图片高度会覆盖由 SDK 计算得出的图片高度。
  • 如果上传图片格式 SDK 不支持，则为 0。

Declared In

AgoraRtmKit.h

  width

上传图片的宽度。

@property (nonatomic, assign) int width

Discussion

NOTE

  • 如果上传图片的格式为 JPG、JPEG、BMP，或 PNG，SDK 会自动计算图片的宽和高。
  • 用户自行设置的图片宽度会覆盖由 SDK 计算得出的图片宽度。
  • 如果上传图片格式 SDK 不支持，则为 0。

Declared In

AgoraRtmKit.h

  thumbnailHeight

缩略图的高度。

@property (nonatomic, assign) int thumbnailHeight

Discussion

NOTE 须自行计算，SDK 不会计算缩略图的高度。

Declared In

AgoraRtmKit.h

  thumbnailWidth

缩略图的宽度。

@property (nonatomic, assign) int thumbnailWidth

Discussion

NOTE 须自行计算，SDK 不会计算缩略图的高度。

Declared In

AgoraRtmKit.h