createSoundMessageByURL
功能介绍
需要自行存储资源时,通过api上传语音并获取下载地址后创建语音消息。
通过该api创建的消息必须通过sendMessageNotOss发送。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<Message> createSoundMessageByURL({
required SoundElem soundElem,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
soundElem | SoundElem | 是 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | Message | 成功返回 |
代码示例
Message msg = await OpenIM.iMManager.messageManager.createSoundMessageByURL(soundElem: soundElem);
//todo
函数原型
+ (OIMMessageInfo *)createSoundMessageByURL:(NSString *)fileURL
duration:(NSInteger)duration
size:(NSInteger)size;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
fileURL | NSString | 是 | 音频地址 |
duration | NSInteger | 是 | 长度 |
size | NSInteger | 是 | 文件大小 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
message | OIMMessageInfo | 成功返回 |
代码示例
OIMMessageInfo *message = [OIMMessageInfo createSoundMessageByURL:@"" duration:1 size:1024];
函数原型
public Message createSoundMessageByURL(SoundElem soundElem)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
soundElem | SoundElem | 是 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | Message | 成功返回 |
代码示例
Message Message= OpenIMClient.getInstance().messageManager.createSoundMessageByURL( soundElem)
函数原型
IMSDK.createFileMessageByURL({
uuid: string;
soundPath: string;
sourceUrl: string;
dataSize: number;
duration: number;
soundType?: string;
}, operationID?: string): Promise<WsResponse<MessageItem>>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
soundPath | string | 是 | 文件路径,传空字符串即可 |
duration | number | 是 | 录音时长 |
uuid | string | 是 | 文件唯一 ID |
sourceUrl | string | 是 | 录音下载地址,自行上文件并通过sendMessageNotOss 发送时,需要传入远程 url,否则为空字符串 |
dataSize | string | 是 | 文件大小 |
soundType | string | 是 | 文件类型,一般为后缀名 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse<MessageItem>> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.createFileMessageByURL({
soundPath: '',
duration: 6,
uuid: 'uuid',
sourceUrl: '',
dataSize: 1024,
soundType: 'mp3',
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('createSoundMessageByURL', operationID: string, {
uuid: string;
soundPath: string;
sourceUrl: string;
dataSize: number;
duration: number;
soundType: string;
}): Promise<MessageItem>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
soundPath | string | 是 | 文件路径,传空字符串即可 |
duration | number | 是 | 录音时长 |
uuid | string | 是 | 文件唯一 ID |
sourceUrl | string | 是 | 图片下载地址,自行上文件并通过sendMessageNotOss 发送时,需要传入远程 url,否则为空字符串 |
dataSize | string | 是 | 文件大小 |
soundType | string | 是 | 文件类型,一般为后缀名 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<MessageItem> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('createSoundMessageByURL', IMSDK.uuid(), {
soundPath: '',
duration: 6,
uuid: 'uuid',
sourceUrl: '',
dataSize: 1024,
soundType: 'mp3',
})
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.createSoundMessageByURL({
uuid: string,
soundPath: string,
sourceUrl: string,
dataSize: number,
duration: number,
soundType: string,
}, operationID: string): Promise<MessageItem>
输入参数
| 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- | | | soundPath | string | 是 | 文件路径,传空字符串即可 | | duration | number | 是 | 录音时长 | | uuid | string | 是 | 文件唯一 ID | | sourceUrl | string | 是 | 图片下载地址,自行上文件并通过sendMessageNotOss 发送时,需要传入远程 url,否则为空字符串 | | dataSize | string | 是 | 文件大小 | | soundType | string | 是 | 文件类型,一般为后缀名 | | operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<MessageItem> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.createSoundMessageByURL({
soundPath: '',
duration: 6,
uuid: 'uuid',
sourceUrl: '',
dataSize: 1024,
soundType: 'mp3',
}, 'operationID')
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});