初始化

方法名

initAsr

注意

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

用法

用法如下：

uniappuniappx

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)
  }
})

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)

参数说明

参数名	参数类型	是否必填	默认值	参数描述
params	Object	`是`	无	接口请求参数
params.recorderType	String	`是`	无	配置音频来源，可选值： `Recorder`：内置录音机 `File`:PCM 格式的音频文件 `Stream`:外部 PCM 音频流 `Directory`：sdk文档未做介绍
params.debugDir	String	否	无	debug目录，生成的音频文件也在该目录中
params.logLevel	String	否	无	日志级别，可选值：`DEBUG`，`TRACE`，`INFO`，`WARN`，`ERROR`，`FATAL`
params.uid	String	否	无	用户id（用以辅助定位线上用户问题）
params.deviceId	String	否	无	设备id（用以辅助定位线上用户问题）
params.saveAudio	Boolean	否	false	是否保存录音文件
params.sampleRate	Integer	否	16000	音频采样率，默认16000
params.channelNum	Integer	否	无	音频通道数，默认1，可选1或2
params.upChannelNum	Integer	否	无	上传给服务的音频通道数，默认1，可选1或2，一般与channelNum保持一致即可
params.address	String	否	wss://openspeech.bytedance.com	识别服务域名，默认：wss://openspeech.bytedance.com
params.uri	String	否	/api/v2/asr	识别服务Uri，默认：/api/v2/asr
params.appId	String	`是`	无	鉴权相关：Appid
params.token	String	`是`	无	鉴权相关：Token，Token前需要加上Bearer;
params.cluster	String	`是`	无	识别服务所用集群
params.connTimeout	Integer	否	无	链接超时时间，单位：毫秒
params.receiveTimeout	Integer	否	无	接收超时时间，单位：毫秒
params.maxRetryTimes	Integer	否	无	在线请求断连后，重连次数，默认值为0，如果需要开启需要设置大于0的次数
params.recorderPreset	String	否	无	预设值录音模式，可选值如下： `RECORDER_PRESET_NONE` `RECORDER_PRESET_GENERIC`：默认 `RECORDER_PRESET_CAMCORDER` `RECORDER_PRESET_VOICE_RECOGNITION` `RECORDER_PRESET_VOICE_COMMUNICATION` `RECORDER_PRESET_UNPROCESSED` 若设置为`RECORDER_PRESET_VOICE_COMMUNICATION`可开启系统自带的回声消除（AEC）能力，打开后ASR识别时，不会收到TTS的声音，该功能并非SDK提供的功能，效果取决于底层系统和硬件
success	Function	否	无	执行成功的函数
fail	Function	否	无	执行失败的函数
complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

回调

示例

onInitSuccessonSpeechMessage

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}"
}

回调说明：

参数名	参数类型	参数描述
message	String	消息提示
data	Object	数据对象
data.status	String	类型 `onInitSuccess`：初始化成功 `onSpeechMessage`：消息回调
data.typeName	String	事件类型，具体可参考示例文件
data.typeValue	Integer	事件值
data.len	Integer	字节数
data.result	String	识别结果
code	Integer	返回类型，0.成功，其他：失败

初始化 ​

方法名 ​

用法 ​

回调 ​

初始化

方法名

用法

回调