Class VideoMessageBody

Hierarchy (view full)

FileMessageBody
- VideoMessageBody

Constructors

constructor

new VideoMessageBody(localPath, duration, thumbnailLocalPath?): VideoMessageBody
视频类型消息体构造方法。
Parameters
- localPath: string
  视频文件路径。
- duration: number
  视频时长，单位是秒。
- OptionalthumbnailLocalPath: string
  缩略图路径。
Returns VideoMessageBody
Overrides FileMessageBody.constructor

Properties

`Protected`hObject

hObject: EMMessageBody

Methods

getBody

getBody(): EMMessageBody
内部使用。

Returns EMMessageBody
Inherited from FileMessageBody.getBody

getDownloadStatus

getDownloadStatus(): DownloadStatus
获取文件的下载状态。

Returns DownloadStatus
- 返回文件的下载状态。
Inherited from FileMessageBody.getDownloadStatus

getDuration

getDuration(): number
获取视频时长，单位为秒。

Returns number
- 返回视频时长，单位为秒。

getFileLength

getFileLength(): number
获取文件大小。

Returns number
- 获取文件大小。
Inherited from FileMessageBody.getFileLength

getFileName

getFileName(): string
获得文件名。

Returns string
- 返回文件名。
Inherited from FileMessageBody.getFileName

getLocalPath

getLocalPath(): string
获取文件本地绝对路径。

Returns string
- 返回文件的本地绝对路径。
Inherited from FileMessageBody.getLocalPath

getRemoteUrl

getRemoteUrl(): string
获取文件的服务器路径。

Returns string
- 返回文件的服务器路径。
Inherited from FileMessageBody.getRemoteUrl

getSecretKey

getSecretKey(): string
获取服务器生成的文件访问密钥。

Returns string
- 返回服务器生成的文件访问密钥。
Inherited from FileMessageBody.getSecretKey

getThumbnailDownloadStatus

getThumbnailDownloadStatus(): DownloadStatus
获取视频缩略图的下载状态。

Returns DownloadStatus
- 返回视频缩略图的下载状态。

getThumbnailHeight

getThumbnailHeight(): number
获取视频缩略图的高度。

Returns number
- 视频缩略图的高度。

getThumbnailLocalPath

getThumbnailLocalPath(): string
获取视频缩略图的本地路径。

Returns string
- 返回视频缩略图的本地路径。

getThumbnailRemoteUrl

getThumbnailRemoteUrl(): string
获取视频缩略图的服务器地址。

Returns string
- 返回视频缩略图的服务器地址。

getThumbnailSecret

getThumbnailSecret(): string
获取视频缩略图的密钥。

Returns string
- 返回视频缩略图的密钥。

getThumbnailWidth

getThumbnailWidth(): number
获取视频缩略图的宽度。

Returns number
- 视频缩略图的宽度。

operationCount

operationCount(): number
获取消息修改次数。

Returns number
- 返回消息修改次数。
Inherited from FileMessageBody.operationCount

operationTime

operationTime(): number
获取最后一次消息修改的时间戳，单位为毫秒。

Returns number
- 返回消息最后一次修改的 UNIX 时间戳。
Inherited from FileMessageBody.operationTime

operatorId

operatorId(): string
获取最后一次消息修改的操作者的用户 ID。

Returns string
- 返回最后一次消息修改的操作者的用户 ID。
Inherited from FileMessageBody.operatorId

setDownloadStatus

setDownloadStatus(downloadStatus): void
设置文件的下载状态。
Parameters
- downloadStatus: DownloadStatus
  文件的下载状态。
Returns void
Inherited from FileMessageBody.setDownloadStatus

setDuration

setDuration(duration): void
设置视频时长，单位为秒。
Parameters
- duration: number
  视频时长，单位为秒。
Returns void

setFileLength

setFileLength(fileLength): void
设置文件大小，以字节为单位。
Parameters
- fileLength: number
  文件大小，以字节为单位。
Returns void
Inherited from FileMessageBody.setFileLength

setFileName

setFileName(fileName): void
设置文件名。
Parameters
- fileName: string
  文件名。
Returns void
Inherited from FileMessageBody.setFileName

setLocalPath

setLocalPath(localPath): void
设置文件本地绝对路径。
Parameters
- localPath: string
  文件本地绝对路径。
Returns void
Inherited from FileMessageBody.setLocalPath

setRemoteUrl

setRemoteUrl(remotePath): void
设置文件的服务器路径。
Parameters
- remotePath: string
  文件的服务器路径。
Returns void
Inherited from FileMessageBody.setRemoteUrl

setSecretKey

setSecretKey(secretKey): void
设置文件的访问密钥。
Parameters
- secretKey: string
  文件的访问密钥。
Returns void
Inherited from FileMessageBody.setSecretKey

setThumbnailDownloadStatus

setThumbnailDownloadStatus(downloadStatus): void
设置视频缩略图的下载状态。

本操作只会影响本地数据，且需要调用 ChatManager#updateMessage 或者 Conversation#updateMessage 才能更新到本地数据库。
Parameters
- downloadStatus: DownloadStatus
  { DownloadStatus } - 视频缩略图的下载状态。
Returns void

setThumbnailLocalPath

setThumbnailLocalPath(thumbnailLocalPath): void
设置视频缩略图的本地路径。
Parameters
- thumbnailLocalPath: string
  视频缩略图的本地路径。
Returns void

setThumbnailRemoteUrl

setThumbnailRemoteUrl(thumbnailRemotePath): void
设置视频缩略图的服务器路径。
Parameters
- thumbnailRemotePath: string
  视频缩略图的服务器路径。
Returns void

setThumbnailSecret

setThumbnailSecret(secretKey): void
设置视频缩略图的密钥。

本操作只会影响本地数据，且需要调用 ChatManager#updateMessage 或者 Conversation#updateMessage 才能更新到本地数据库。
Parameters
- secretKey: string
Returns void

setThumbnailSize

setThumbnailSize(width, height): void
设置视频缩略图的尺寸。
Parameters
- width: number
  视频缩略图的宽度。
- height: number
  视频缩略图的高度。
Returns void

toString

toString(isFull?): string
Returns a string representation of an object.
Parameters
- OptionalisFull: boolean
Returns string
Overrides FileMessageBody.toString

type

type(): number
获取消息体类型。

Returns number
- 返回消息体类型。
Inherited from FileMessageBody.type