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

OfflineAudio

@NotStableForInheritance

interface OfflineAudio : Audio

离线语音消息.

OfflineAudio 仅拥有协议上必要的五个属性:

文件名 filename
文件 MD5 fileMd5
文件大小 fileSize
编码方式 codec
额外数据 extraData

OfflineAudio 可由本地 ExternalResource 经过 AudioSupported.uploadAudio 上传到服务器得到, 故无下载链接.

OfflineAudio 同时还可以用做自定义构造 Audio 实例, 使用 OfflineAudio.Factory.create 可通过上述五个必要参数获得 OfflineAudio 实例.

序列化支持

OfflineAudio 支持序列化. 可使用 MessageChain.serializeToJsonString 以及 MessageChain.deserializeFromJsonString. 也可以在 MessageSerializers.serializersModule 获取到 OfflineAudio 的 KSerializer.

要获取更多有关序列化的信息, 参阅 MessageSerializers.

不建议自行实现该接口

OfflineAudio 不稳定, 将来可能会增加新的抽象属性或方法而导致不兼容. 仅可以使用该接口而不能继承或实现它.

Since

2.7

Types

Factory

interface Factory

Key

object Key : AbstractPolymorphicMessageKey<Audio, OfflineAudio>

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

open override fun contentToString(): String

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

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

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

toString

abstract override fun toString(): String

Properties

codec

abstract val codec: AudioCodec

编码方式.

extraData

abstract val extraData: ByteArray?

文件的额外数据. 该数据由服务器提供, 可能会影响语音音质等属性. extraData 为 null 时也可以发送语音, 但不确定发送和客户端收听是否会正常.

fileMd5

abstract val fileMd5: ByteArray

文件 MD5. 16 bytes.

filename

abstract val filename: String

文件名称. 通常为 XXX.amr. 服务器要求文件名后缀必须为 ".amr", 但其编码方式也有可能是非 AudioCodec.AMR.

fileSize

abstract val fileSize: Long

文件大小 bytes. 官方客户端支持最大文件大小约为 1MB, 过大的文件可能可以正常上传, 但在官方客户端无法收听 (显示文件损坏).

key

open override val key: MessageKey<*>

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