智能小程序 Ray 开发媒体 API —— 录音 API 合集

GetRecorderManagerTask getRecorderManager

获取全局唯一的录音管理器

引入

import { getRecorderManager } from '@ray-js/ray';

参数

Object object

获取全局唯一的录音管理器的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

返回值

GetRecorderManagerTask 全局唯一的录音管理器

GetRecorderManagerTask

GetRecorderManagerTask.start

开始录音

参数

Object object

开始录音的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
duration	number		否	录音的时长，单位 ms，最大值 600000（10 分钟）
sampleRate	number		否	采样率
numberOfChannels	number		否	录音通道数
encodeBitRate	number		否	编码码率，有效值见下表格
format	string		否	音频格式
frameSize	number		是	指定帧大小，单位 KB。传入 frameSize 后，每录制指定帧大小的内容后，会回调录制的文件内容，不指定则不会回调。暂仅支持 mp3、pcm 格式。
audioSource	string		否	指定录音的音频输入源
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
tempFilePath	string	录音文件的临时路径 (本地路径)

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 开始录音
 */
export function start(params: {
  /** 录音的时长，单位 ms，最大值 600000（10 分钟） */
  duration?: number;
  /** 采样率 */
  sampleRate?: number;
  /** 录音通道数 */
  numberOfChannels?: number;
  /** 编码码率，有效值见下表格 */
  encodeBitRate?: number;
  /** 音频格式 */
  format?: string;
  /** 指定帧大小，单位 KB。传入 frameSize 后，每录制指定帧大小的内容后，会回调录制的文件内容，不指定则不会回调。暂仅支持 mp3、pcm 格式。 */
  frameSize: number;
  /** 指定录音的音频输入源 */
  audioSource?: string;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 录音文件的临时路径 (本地路径) */
    tempFilePath: string;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

GetRecorderManagerTask.resume

继续录音

参数

Object object

继续录音的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 继续录音
 */
export function resume(params: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: () => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

GetRecorderManagerTask.pause

暂停录音

参数

Object object

暂停录音的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 暂停录音
 */
export function pause(params: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

GetRecorderManagerTask.stop

停止录音

参数

Object object

停止录音的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 停止录音
 */
export function stop(params: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

GetRecorderManagerTask.startRecording

开始持续录音

参数

Object object

开始持续录音的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
period	number		是	间隔时间 ms
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 开始持续录音
 */
export function startRecording(params: {
  /** 间隔时间  ms */
  period: number;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

GetRecorderManagerTask.stopRecording

停止持续录音

参数

Object object

停止持续录音的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 停止持续录音
 */
export function stopRecording(params: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

onRecordingEvent

持续录音事件

引入

import { onRecordingEvent } from '@ray-js/ray';

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

持续录音事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
buffer	array		是	数据流

 

offRecordingEvent

取消监听：持续录音事件

引入

import { offRecordingEvent } from '@ray-js/ray';

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

取消监听：持续录音事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
buffer	array		是	数据流

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。