mirai-core-api/net.mamoe.mirai.message.data/ShortVideo

ShortVideo

@NotStableForInheritance

interface ShortVideo : MessageContent, ConstrainSingle

短视频消息, 指的是可在聊天界面在线播放的视频消息, 而非在群文件上传的视频文件.

短视频消息分为 OnlineShortVideo 与 OfflineShortVideo. 在本地上传的短视频为 OfflineShortVideo. 从服务器接收的短视频为 OnlineShortVideo.

最推荐存储的方式是下载视频文件, 每次都通过上传该文件获取视频消息. 在上传视频时服务器会根据缓存情况选择回复已有视频 ID 或要求客户端上传.

获取短视频消息示例

上传短视频

使用 Contact.uploadShortVideo, 将视频缩略图和视频资源上传以得到 OfflineShortVideo.

使用 OfflineShortVideo.Builder 构建短视频

OfflineShortVideo 提供 Builder 构建方式, 必须指定 videoId, filename, fileMd5, fileSize 和 fileFormat 参数. 可选指定 thumbnailMd5 和 thumbnailSize. 若不提供, 可能会影响服务器判断缓存.

从服务器接收

通过监听消息接收的短视频消息可直接转换为 OnlineShortVideo.

kotlin 示例:

val video: OnlineShortVideo = event.message[OnlineShortVideo]

下载视频

通过 OnlineShortVideo.urlForDownload 获取下载链接. 该下载链接不包含短视频的文件信息, 可以使用 videoId 或 filename 作为文件名, fileFormat 作为文件拓展名.

Since

2.16

Inheritors

OnlineShortVideo

OfflineShortVideo

Types

Key

object Key : AbstractPolymorphicMessageKey<MessageContent, ShortVideo>

Functions

contentEquals

open fun contentEquals(another: String, ignoreCase: Boolean = false): Boolean

判断内容是否与 another 相等.

open fun contentEquals(another: Message, ignoreCase: Boolean = false): Boolean

判断内容是否与 another 相等即 this 与 another 的 contentToString 相等.

open fun contentEquals(another: Message, ignoreCase: Boolean = false, strict: Boolean = false): Boolean

判断内容是否与 another 相等即 this 与 another 的 contentToString 相等.

contentToString

abstract fun contentToString(): String

转为接近官方格式的字符串, 即 "内容". 如 At(member) + "test" 将转为 "@QQ test".

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

isContentBlank

fun Message.isContentBlank(): Boolean

当消息内容为空白时返回 true.

isContentEmpty

fun Message.isContentEmpty(): Boolean

当消息内容为空时返回 true.

plus

open operator fun plus(another: Array<out Message>): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: CharSequence): MessageChain

open operator fun plus(another: String): MessageChain

@JvmName(name = "plusIterableString")

open operator fun plus(another: Iterable<String>): MessageChain

open operator fun plus(another: Iterable<Message>): MessageChain

open operator fun plus(another: Sequence<Message>): MessageChain

open operator fun plus(another: Message): MessageChain

open operator fun plus(another: MessageChain): MessageChain

open operator fun plus(another: SingleMessage): MessageChain

plus

suspend operator fun Message.plus(another: Flow<Message>): MessageChain

将 another 按顺序连接到这个消息的尾部.

repeat

fun Message.repeat(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

sendTo

inline suspend fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C>

将 this 发送给指定联系人

times

operator fun Message.times(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

toForwardMessage

@JvmOverloads

fun Message.toForwardMessage(sender: User, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

@JvmOverloads

fun Message.toForwardMessage(senderId: Long, senderName: String, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

转换为 ForwardMessage

toMessageChain

fun Message.toMessageChain(): MessageChain

toString

abstract override fun toString(): String

得到包含 mirai 消息元素代码的, 易读的字符串. 如 At(member) + "test" 将转为 "[mirai:at:qqId]test".

Properties

content

val Message.content: String

Message.contentToString 的捷径

fileFormat

abstract val fileFormat: String

视频文件类型（拓展名）

fileMd5

abstract val fileMd5: ByteArray

视频文件 MD5. 16 bytes.

filename

abstract val filename: String

视频文件名, 不包括拓展名

fileSize

abstract val fileSize: Long

视频大小

key

open override val key: MessageKey<*>

用于判断是否为同一种元素的 MessageKey. 使用多态类型 MessageKey 最上层的 MessageKey.

videoId

abstract val videoId: String

视频 ID.