发送媒体消息
媒体消息
媒体消息指图片、文件等需要处理媒体文件上传的消息。媒体消息的消息内容类型为 MeidaMessageContent 的子类,例如高清语音消息内容(HQVoiceMessage)。
SDK 不支持自定义媒体消息
获取媒体消息本地路径
鸿蒙系统内部获取媒体路径可以分为两类
- 从沙箱中获取:类似于 iOS 的沙盒机制,鸿蒙的应用程序只能访问自己的沙箱目录,无法访问其他应用程序的沙箱目录。
- 沙箱路径 SDK 可以直接访问
- 从系统路径获取:例如系统相册,系统文件管理等
- 系统路径 SDK 无法直接访问,需要将系统路径媒体文件拷贝到沙箱路径
- 可以使用下面的代码将系统路径文件拷贝到沙箱路径
import fs from '@ohos.file.fs';
import { ArrayChecker } from '@rongcloud/imlib';
// 将系统路径文件复制到沙盒工具类
class SandboxUtil {
/**
* 将相册图片或者文件管理中文件复制到沙盒
* @param context 上下文
* @param uris 系统路径数组
* @returns 沙盒路径数组
*/
public static async copyToSandbox(context: Context, uris: Array<string>) : Promise<Array<string>> {
let targetList = new Array<string>();
if (!ArrayChecker.isValid(uris)) {
return targetList;
}
for (let u of uris) {
let file = await fs.open(u, fs.OpenMode.READ_ONLY);
let targetPath = context.cacheDir + "/" + file.name;
fs.closeSync(file);
targetPath = "file://" + targetPath;
await fs.copy(u, targetPath);
targetList.push(targetPath);
}
return targetList;
}
}
export { SandboxUtil }
选择相册和文件管理中的文件资源参考鸿蒙文档。
发送图片消息
在发送前,图片会被压缩质量,以及生成缩略图,在聊天界面中展示。GIF 无缩略图,也不会被压缩。
- 图片消息的缩略图:SDK 会以原图 30% 质量生成符合标准大小要求的大图后再上传和发送。压缩后最长边不超过 240 px。缩略图用于在聊天界面中展示。
- 图片:发送消息时如未选择发送原图,SDK 会以原图 85% 质量生成符合标准大小要求的大图后再上传和发送。压缩后最长边不超过 1080 px。
从系统相册获取图片地址
const photoSelectOptions = new picker.PhotoSelectOptions();
photoSelectOptions.MIMEType = picker.PhotoViewMIMETypes.IMAGE_TYPE;
photoSelectOptions.maxSelectNumber = 5;
const photoViewPicker = new picker.PhotoViewPicker();
photoViewPicker.select(photoSelectOptions).then( async (photoSelectResult: picker.PhotoSelectResult) => {
// 将系统相册中的图片移动到沙盒
// 然后将图片路径传给消息发送接口
let imageUris: Array<string> = await SandboxUtil.copyToSandbox(getContext(this), photoSelectResult.photoUris);
}).catch((err: BusinessError) => {
console.error(**Invoke photoViewPicker.select failed, code is ${err.code}, message is ${err.message}**);
})
发送图片消息
let conId = new ConversationIdentifier();
conId.conversationType = ConversationType.Private;
conId.targetId = "会话 id";
let imgMsg = new ImageMessage();
// 使用上一步的路径创建图片消息
imgMsg.localPath = localPath;
let msg = new Message(conId, imgMsg);
let option: ISendMsgOption = {};
IMEngine.getInstance().sendMediaMessage(msg, option, (msg: Message) => {
// 消息保存到数据库
}, (msg: Message, progress: number) => {
// 媒体上传进度 [1 ~ 100]
}).
then(result => {
if (EngineError.Success !== result.code) {
//发送消息失败
return;
}
if (!result.data) {
// 消息为空
return;
}
let msg = result.data as Message;
})
发送文件消息
从文件管理获取文件路径
const documentSelectOptions = new picker.DocumentSelectOptions();
documentSelectOptions.maxSelectNumber = 5; // 选择文档的最大数目(可选)
documentSelectOptions.defaultFilePathUri = "file://docs/storage/Users/currentUser"; // 指定选择的文件或者目录路径(可选)
documentSelectOptions.fileSuffixFilters =
['.png', '.txt', '.mp3', '.mp4', '.apk', '.zip', '.docx', '.log', '.xlsx', '.jpg', '.pdf', '.jpeg', '.csv',
'.png', '.chls', '.ipa', '.doc', '.yaml', '.json',
'.html']; // 选择文件的后缀类型,若选择项存在多个后缀名,则每一个后缀名之间用英文逗号进行分隔,而且后缀类型名不能超过100个(可选)。
let uris: Array<string> = [];
const documentViewPicker = new picker.DocumentViewPicker(); // 创建文件选择器实例
documentViewPicker.select(documentSelectOptions).then(async (documentSelectResult: Array<string>) => {
// 将系统文件路径改为沙盒路径
// 使用沙盒路径发送消息
let fileUris: Array<string> = await SandboxUtil.copyToSandbox(getContext(this), documentSelectResult);
console.info('documentViewPicker.select to file succeed and uris are:' + uris);
}).catch((err: BusinessError) => {
console.error(**Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}**);
})
发送文件消息
let conId = new ConversationIdentifier();
conId.conversationType = ConversationType.Private;
conId.targetId = "会话 id";
// 创建文件消息
let fileMsg = new FileMessage();
// 文件的沙箱路径
fileMsg.localPath = localPath;
let msg = new Message(conId, fileMsg);
let option: ISendMsgOption = {};
IMEngine.getInstance().sendMediaMessage(msg, option, (msg: Message) => {
// 消息保存到数据库
}, (msg: Message, progress: number) => {
// 媒体上传进度 [1 ~ 100]
}).
then(result => {
if (EngineError.Success !== result.code) {
//发送消息失败
return;
}
if (!result.data) {
// 消息为空
return;
}
let msg = result.data as Message;
})
遇到报错 InvalidArgumentMediaLocalPath 有如下原因
- 传入的路径不是文件路径
- 传入的不是沙箱路径而是系统路径
发送高清语音
高清语音的录制
鸿蒙语音录制文档: https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/using-avrecorder-for-recording-V5
提示
注:鸿蒙 Next beta1 遇到语音消息互通的问题,鸿蒙和安卓使用相同的录制参数
鸿蒙录制的语音消息,鸿蒙播放正常,安卓播放正常
安卓录制的语音消息,安卓播放正常,鸿蒙播放异常
鸿蒙 Next beta2 已修复,具体修复版本信息如下
手机版本 5.0 beta2,手机显示版本号 NEXT.0.0.31,对应 DevEco-Studio 版本 5.0.3.500
构造高清语音消息
let conId = new ConversationIdentifier();
conId.conversationType = ConversationType.Private;
conId.targetId = "会话 id";
// 创建高清语音消息
let hqMsg = new HQVoiceMessage();
// 高清语音的沙箱路径
hqMsg.localPath = localPath;
// 高清语音消息时长,单位秒
hqMsg.duration = duration;
let msg = new Message(conId, hqMsg);
let option: ISendMsgOption = {};
IMEngine.getInstance().
sendMediaMessage(msg, option, (msg: Message) => {
// 消息保存到数据库
}, (msg: Message, progress: number) => {
// 媒体上传进度 [1 ~ 100]
}).
then(result => {
if (EngineError.Success !== result.code) {
//发送消息失败
return;
}
if (!result.data) {
// 消息为空
return;
}
let msg = result.data as Message;
})