Skip to content

初始化

方法名

initAsr

注意

识别结果会在该方法中回调

用法

  • 用法如下:
js
module.initAsr({
  params: {
    //【必需配置】配置音频来源,可选值:Recorder,File,Stream,Directory
    recorderType: "Recorder",
    //【可选配置】Debug目录
    debugDir: "/storage/emulated/0/hsSpeech/debug",
    //【可选配置】日志级别,可选值:DEBUG,TRACE,INFO,WARN,ERROR,FATAL
    logLevel: "DEBUG",
    //【可选配置】User ID(用以辅助定位线上用户问题)
    uid: "leven",
    //【可选配置】DEVICE_ID(用以辅助定位线上用户问题)
    deviceId: "0",
    //【可选配置】是否保存录音文件
    saveAudio: false,
    //【可选配置】音频采样率,默认16000
    sampleRate: 16000,
    //【可选配置】音频通道数,默认1,可选1或2
    channelNum: 1,
    //【可选配置】上传给服务的音频通道数,默认1,可选1或2,一般与channelNum保持一致即可
    upChannelNum: 1,
    //【可选配置】识别服务域名,默认:wss://openspeech.bytedance.com
    address: "wss://openspeech.bytedance.com",
    //【可选配置】识别服务Uri,默认:/api/v2/asr
    uri: "/api/v2/asr",
    //【必需配置】鉴权相关:Appid
    appId: "4413143697",
    //【必需配置】鉴权相关:Token,Token前需要加上Bearer;
    token: "Bearer;CUT52ZrQxcTNlbY_AtzCxJx4F4SW7KTG",
    //【必需配置】识别服务所用集群
    cluster: "volcengine_streaming_common",
    //【可选配置】链接超时时间
    connTimeout: 3000,
    //【可选配置】接收超时时间
    receiveTimeout: 5000,
    //【可选配置】在线请求断连后,重连次数,默认值为0,如果需要开启需要设置大于0的次数
    maxRetryTimes: 0
  },
  //成功执行的函数
  success: (res) => {
    let data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数,不管成功还是失败都会返回
  complete: (res) => {
    // console.log(res)
  }
})
js
module.initAsr({
  params: {
    //【必需配置】配置音频来源,可选值:Recorder,File,Stream,Directory
    recorderType: "Recorder",
    //【可选配置】Debug目录
    debugDir: "/storage/emulated/0/hsSpeech/debug",
    //【可选配置】日志级别,可选值:DEBUG,TRACE,INFO,WARN,ERROR,FATAL
    logLevel: "DEBUG",
    //【可选配置】User ID(用以辅助定位线上用户问题)
    uid: "leven",
    //【可选配置】DEVICE_ID(用以辅助定位线上用户问题)
    deviceId: "0",
    //【可选配置】是否保存录音文件
    saveAudio: false,
    //【可选配置】音频采样率,默认16000
    sampleRate: 16000,
    //【可选配置】音频通道数,默认1,可选1或2
    channelNum: 1,
    //【可选配置】上传给服务的音频通道数,默认1,可选1或2,一般与channelNum保持一致即可
    upChannelNum: 1,
    //【可选配置】识别服务域名,默认:wss://openspeech.bytedance.com
    address: "wss://openspeech.bytedance.com",
    //【可选配置】识别服务Uri,默认:/api/v2/asr
    uri: "/api/v2/asr",
    //【必需配置】鉴权相关:Appid
    appId: "4413143697",
    //【必需配置】鉴权相关:Token,Token前需要加上Bearer;
    token: "Bearer;CUT52ZrQxcTNlbY_AtzCxJx4F4SW7KTG",
    //【必需配置】识别服务所用集群
    cluster: "volcengine_streaming_common",
    //【可选配置】链接超时时间
    connTimeout: 3000,
    //【可选配置】接收超时时间
    receiveTimeout: 5000,
    //【可选配置】在线请求断连后,重连次数,默认值为0,如果需要开启需要设置大于0的次数
    maxRetryTimes: 0
  },
  //成功执行的函数
  success: (res) => {
    const data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数,不管成功还是失败都会返回
  // complete: (res) => {
  //   console.log(res)
  // }
} as LevenOptions)
  • 参数说明
    参数名参数类型是否必填默认值参数描述
    paramsObject接口请求参数
    params.recorderTypeString配置音频来源,可选值:
    Recorder:内置录音机
    File:PCM 格式的音频文件
    Stream:外部 PCM 音频流
    Directory:sdk文档未做介绍
    params.debugDirStringdebug目录,生成的音频文件也在该目录中
    params.logLevelString日志级别,可选值:DEBUGTRACEINFOWARNERRORFATAL
    params.uidString用户id(用以辅助定位线上用户问题)
    params.deviceIdString设备id(用以辅助定位线上用户问题)
    params.saveAudioBooleanfalse是否保存录音文件
    params.sampleRateInteger16000音频采样率,默认16000
    params.channelNumInteger音频通道数,默认1,可选1或2
    params.upChannelNumInteger上传给服务的音频通道数,默认1,可选1或2,一般与channelNum保持一致即可
    params.addressStringwss://openspeech.bytedance.com识别服务域名,默认:wss://openspeech.bytedance.com
    params.uriString/api/v2/asr识别服务Uri,默认:/api/v2/asr
    params.appIdString鉴权相关:Appid
    params.tokenString鉴权相关:Token,Token前需要加上Bearer;
    params.clusterString识别服务所用集群
    params.connTimeoutInteger链接超时时间,单位:毫秒
    params.receiveTimeoutInteger接收超时时间,单位:毫秒
    params.maxRetryTimesInteger在线请求断连后,重连次数,默认值为0,如果需要开启需要设置大于0的次数
    successFunction执行成功的函数
    failFunction执行失败的函数
    completeFunction执行完成的函数,不管成功还是失败都会执行

回调

  • 示例
json
{
  "status": "onInitSuccess"
}
json
{
  "status": "onSpeechMessage",
  "typeName": "MESSAGE_TYPE_PARTIAL_RESULT",
  "len": 239,
  "typeValue": 1201,
  "result": "{\"addition\":{\"duration\":\"7980\",\"logid\":\"2026030722370552F1F1A0F2874400D82F\",\"split_time\":\"[]\"},\"code\":1000,\"message\":\"Success\",\"reqid\":\"fb567ada-7556-467d-bacc-6e9a84d2940e\",\"result\":[{\"confidence\":0,\"text\":\"喂! 喂!\"}],\"sequence\":82}"
}
  • 回调说明:
    参数名参数类型参数描述
    messageString消息提示
    dataObject数据对象
    data.statusString类型
    onInitSuccess:初始化成功
    onSpeechMessage:消息回调
    data.typeNameString事件类型,具体可参考示例文件
    data.typeValueInteger事件值
    data.lenInteger字节数
    data.resultString识别结果
    codeInteger返回类型,0.成功,其他:失败