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

Audio

interface Audio : MessageContent, ConstrainSingle

语音消息.

Audio 分为 OnlineAudio 与 OfflineAudio. 在本地上传的, 或手动构造的语音为 OfflineAudio. 从服务器接收的语音为 OnlineAudio.

上传和发送语音

使用 AudioSupported.uploadAudio 上传语音到服务器并取得 Audio 消息实例, 然后通过 Contact.sendMessage 发送.

Java 示例:

Audio audio;
try {
    audio = group.uploadAudio(resource); // 上传文件得到语音实例
} finally {
    resource.close(); // 保证资源正常关闭
}
group.sendMessage(audio); // 发送语音消息

下载语音

使用 OnlineAudio.urlForDownload 获取文件下载链接.

Audio 与 Voice 的转换

原 Voice 已弃用故不推荐进行兼容转换. Audio 将有稳定性保证, 请尽量使用新的 Audio.

将 Audio 转为 Voice: Voice.fromAudio 将 Voice 转为 Audio: Voice.toAudio

Since

2.7

Inheritors

OnlineAudio

OfflineAudio

Types

Key

object Key : AbstractPolymorphicMessageKey<MessageContent, Audio>

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" 将转为 "@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

toVoice

fun Audio.~~toVoice~~(): Voice

将 2.7 新增的 Audio 转为旧版本的 Voice, 以兼容某些情况.

Properties

codec

abstract val codec: AudioCodec

编码方式.

content

val Message.content: String

Message.contentToString 的捷径

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.