createSoundMessageFromFullPath

功能介绍

说明

创建音频消息，由SDK内部根据绝对路径提取音频信息并创建音频消息。

iOS

函数原型

 Future<Message> createSoundMessageFromFullPath({
    required String soundPath,
    required int duration,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
soundPath	String	是	绝对路径
duration	int	是	时长

返回结果

名称	类型	描述
~	Message	成功返回

代码示例

    Message msg = await OpenIM.iMManager.messageManager.createSoundMessageFromFullPath(soundPath: soundPath, duration: duration);
    //todo

Android

函数原型

+ (OIMMessageInfo *)createSoundMessageFromFullPath:(NSString *)soundPath
                                          duration:(NSInteger)duration;

输入参数

参数名称	参数类型	是否必填	描述
soundPath	NSString	是	绝对路径
duration	NSInteger	是	时长

返回结果

名称	类型	描述
message	OIMMessageInfo	成功返回

代码示例

OIMMessageInfo *message = [OIMMessageInfo createSoundMessageFromFullPath:@"" duration:1];

Flutter

函数原型

   public Message createSoundMessageFromFullPath(String soundPath, long duration)

输入参数

参数名称	参数类型	是否必填	描述
soundPath	String	是	绝对路径
duration	int	是	时长

返回结果

名称	类型	描述
~	Message	成功返回

代码示例

       Message Message= OpenIMClient.getInstance().messageManager.createSoundMessageFromFullPath( soundPath,  duration)

uni-app

注意

仅在electron中使用ffi调用时支持

Web端建议使用createSoundMessageByURL或createSoundMessageByFile。

函数原型

IMSDK.createSoundMessageFromFullPath({
  soundPath: string,
  duration: number
}, operationID?: string): Promise<WsResponse<MessageItem>>

输入参数

参数名称	参数类型	是否必填	描述
soundPath	string	是	文件路径，绝对路径
duration	number	是	音频时长，秒

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<MessageItem>>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
const { instance: IMSDK } = getWithRenderProcess();

IMSDK.createSoundMessageFromFullPath({
  soundPath: 'file://...',
  duration: 9
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('createSoundMessageFromFullPath', operationID: string, {
  soundPath: string,
  duration: number
}): Promise<MessageItem>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
soundPath	string	是	文件绝对路径
duration	number	是	录音时长

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<MessageItem>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('createSoundMessageFromFullPath', IMSDK.uuid(), {
  soundPath: 'soundPath',
  duration: 6,
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDK.createSoundMessageFromFullPath({
  soundPath: string,
  duration: number,
}, operationID?: string): Promise<MessageItem>

输入参数

参数名称	参数类型	是否必填	描述
soundPath	string	是	文件绝对路径
duration	number	是	录音时长
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<MessageItem>	调用成功回调
Promise.catch()	Promise<OpenIMApiError>	调用失败回调

代码示例

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.createSoundMessageFromFullPath({
  soundPath: 'soundPath',
  duration: 6,
})
  .then((data) => {
    // 调用成功
  })
  .catch((error) => {
    // 调用失败
  });

Unity

函数原型

public static Message CreateSoundMessageFromFullPath(string soundPath, long duration);

输入参数

参数名称	参数类型	是否必填	描述
soundPath	string	是	绝对路径
duration	long	是	时长

返回结果

名称	类型	描述
message	Message	成功返回

代码示例

var msg = IMSDK.CreateSoundMessageFromFullPath(sourcePath,duration);