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

ty.getRecorderManagerTask

GetRecorderManagerTask ty.getRecorderManager

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

参数

Object object

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

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

回调参数 Object res

属性类型默认值必填说明
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {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;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
 
  /**
   * 停止持续录音
   */
  stopRecording(params: {
    complete?: () => void;
    success?: (params: null) => void;
    failure?: (params: {
      errorMsg: string;
      errorCode: string | number;
      innerError: {
        errorCode: string | number;
        errorMsg: string;
      };
    }) => void;
  }): void;
}
export function getRecorderManager(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): GetRecorderManagerTask;

GetRecorderManagerTask

GetRecorderManagerTask.start

开始录音

参数

Object object

开始录音的回调函数

回调参数 Object res

属性类型默认值必填说明
durationnumber录音的时长,单位 ms,最大值 600000(10 分钟)
sampleRatenumber采样率
numberOfChannelsnumber录音通道数
encodeBitRatenumber编码码率,有效值见下表格
formatstring音频格式
frameSizenumber指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。
audioSourcestring指定录音的音频输入源
completefunction接口调用完成的回调函数(成功失败都会回调)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

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

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {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;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 👉 立即开发

GetRecorderManagerTask.resume

继续录音

参数

Object object

继续录音的回调函数

回调参数 Object res

属性类型默认值必填说明
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

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

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }
函数定义示例
/**
 * 继续录音
 */
export function resume(params: {
  complete?: () => void;
  success?: (params: {
    /** 录音文件的临时路径 (本地路径) */
    tempFilePath: string;
  }) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

GetRecorderManagerTask.pause

暂停录音

参数

Object object

暂停录音的回调函数

回调参数 Object res

属性类型默认值必填说明
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

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

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }
函数定义示例
/**
 * 暂停录音
 */
export function pause(params: {
  complete?: () => void;
  success?: (params: {
    /** 录音文件的临时路径 (本地路径) */
    tempFilePath: string;
  }) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

GetRecorderManagerTask.stop

停止录音

参数

Object object

停止录音的回调函数

回调参数 Object res

属性类型默认值必填说明
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

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

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }
函数定义示例
/**
 * 停止录音
 */
export function stop(params: {
  complete?: () => void;
  success?: (params: {
    /** 录音文件的临时路径 (本地路径) */
    tempFilePath: string;
  }) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

GetRecorderManagerTask.startRecording

开始持续录音

参数

Object object

开始持续录音的回调函数

回调参数 Object res

属性类型默认值必填说明
periodnumber间隔时间 ms
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
函数定义示例
/**
 * 开始持续录音
 */
export function startRecording(params: {
  /** 间隔时间  ms */
  period: number;
  complete?: () => void;
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

GetRecorderManagerTask.stopRecording

停止持续录音

参数

Object object

停止持续录音的回调函数

回调参数 Object res

属性类型默认值必填说明
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
函数定义示例
/**
 * 停止持续录音
 */
export function stopRecording(params: {
  complete?: () => void;
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.onRecordingEvent

持续录音事件

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

参数

function callback

持续录音事件的回调函数

回调参数 Object res

属性类型默认值必填说明
bufferarray数据流
函数定义示例
/**
 * 持续录音事件
 */
export function onRecordingEvent(
  listener: (params: {
    /** 数据流 */
    buffer: number[];
  }) => void,
): void;

ty.offRecordingEvent

取消监听:持续录音事件

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

参数

function callback

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

回调参数 Object res

属性类型默认值必填说明
bufferarray数据流
函数定义示例
/**
 * 取消监听:持续录音事件
 */
export function offRecordingEvent(
  listener: (params: {
    /** 数据流 */
    buffer: number[];
  }) => void,
): void;

  👉 立即开发

  • 34
    点赞
  • 18
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IoT砖家涂拉拉

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值