【小程序】媒体API能力集成指南——录音API

ty.getRecorderManagerTask

GetRecorderManagerTask ty.getRecorderManager

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

参数

Object object

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

录音前需要调用 ty.authorize 获取 scope.record 权限。

回调参数 Object res

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

object.success 回调参数

参数

Object res

object.fail 回调参数

参数

Object res

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

返回值

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

函数定义示例

/**
 * 获取全局唯一的录音管理器
 */
interface GetRecorderManagerTask {
  /**
   * 开始录音
   */
  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;
    failure?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
 
  /**
   * 继续录音
   */
  resume(params: {
    complete?: () => void;
    success?: (params: {
      /** 录音文件的临时路径 (本地路径) */
      tempFilePath: string;
    }) => void;
    failure?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
 
  /**
   * 暂停录音
   */
  pause(params: {
    complete?: () => void;
    success?: (params: {
      /** 录音文件的临时路径 (本地路径) */
      tempFilePath: string;
    }) => void;
    failure?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
 
  /**
   * 停止录音
   */
  stop(params: {
    complete?: () => void;
    success?: (params: {
      /** 录音文件的临时路径 (本地路径) */
      tempFilePath: string;
    }) => void;
    failure?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
 
  /**
   * 开始持续录音
   */
  startRecording(params: {
    /** 间隔时间  ms */
    period: number;
    complete?: () => void;
    success?: (params: null) => void;
    failure?: (params: {
      errorMsg: string;
      errorCode: string | number;
      i