txFileRecognizer

init

recognize

clear

pollingRecognizeResult

getAllTaskIdAndRequesId

addEventListener

removeEventListener

概述

本插件封装了腾讯云录音文件识别的SDK

注意：本插件 iOS 平台上最低适配系统版本为 iOS 9.0

插件接口

init

初始化

init({params})

params

appid：

  • 类型：字符串
  • 描述：腾讯云 ID，即 AppID，腾讯云获取

secretId：

  • 类型：字符串
  • 描述：腾讯云安全凭证，腾讯云获取

secretKey：

  • 类型：字符串
  • 描述：腾讯云安全凭证，腾讯云获取

authorize：

  • 类型：布尔
  • 描述：（可选项）是否需要授权，iOS端1.0.2版本以后不再支持该参数
  • 默认：false

sn：

  • 类型：字符串
  • 描述：（可选项）授权序列号，authorize为true时必须填写，false可不填写，iOS端1.0.2版本以后不再支持该参数

示例代码

var txFileRecognizer = api.require('txFileRecognizer');
txFileRecognizer.init({
  appid:'',
  secretId:'',
  secretKey:''
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

recognize

录音文件识别

recognize({params})

params

path：

  • 类型：字符串
  • 描述：（可选项）录音文件本地路径，支持fs、widget；sourceType为1时填写，否者忽略

audioUrl：

  • 类型：字符串
  • 描述：（可选项）录音文件网络路径；sourceType为0时填写，否者忽略

sourceType：

  • 类型：数字
  • 描述：（可选项）录音文件类型；0：网络路径，1：本地路径
  • 默认：1

示例代码

var txFileRecognizer = api.require('txFileRecognizer');
txFileRecognizer.recognize({
  path:''
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

clear

清除

clear()

示例代码

var txFileRecognizer = api.require('txFileRecognizer');
txFileRecognizer.clear();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

pollingRecognizeResult

获取识别结果，该方法会轮询结果。使用场景：clear调用了之后，想获取之前的识别结果，或者识别文件太大，app关掉了，下次打开想获取上次的识别结果 （仅支持ios）

recognize({params})

params

taskId：

  • 类型：字符串
  • 描述：录音唯一标识

requestId：

  • 类型：字符串
  • 描述：返回的请求唯一标识requestId

示例代码

var txFileRecognizer = api.require('txFileRecognizer');
txFileRecognizer.pollingRecognizeResult({
  taskId:'',
  requestId:''
});

可用性

iOS系统

可提供的1.0.0及更高版本

getAllTaskIdAndRequesId

获取所有taskId 和 requestId，只能在clear 方法调用前获取。fileRecognizerDidStart调用前为空。（仅支持ios）

getAllTaskIdAndRequesId(callback(ret))

callback(ret)

ret:

  • 类型：JSON对象
  • 内部字段：
{
     ids:[]      //数组类型；所有taskId 和 requestId，示例：[{"requestId":"taskId"},{"requestId":"taskId"}]                                

}

示例代码

var txFileRecognizer = api.require('txFileRecognizer');
txFileRecognizer.getAllTaskIdAndRequesId(function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统

可提供的1.0.0及更高版本

addEventListener

添加监听

addEventListener(callback(ret))

callback(ret)

ret:

  • 类型：JSON对象
  • 内部字段：
{
     eventType:'',     //字符串类型；事件回调，取值范围如下：
                        //success:录音文件识别成功
                        //error:录音文件识别失败
                        //didStart:录音文件已上传服务器，正在排队识别中（该参数仅支持ios）
    requestId	:'',            //字符串类型；请求唯一标识requestId
    text:'',        //字符串类型；识别文本；success返回                              
    msg:'',        //字符串类型；错误信息；error返回
    taskId:''        //字符串类型；向服务器查询识别结果唯一标识；didStart返回（该参数仅支持ios）
}

示例代码

var txFileRecognizer = api.require('txFileRecognizer');
txFileRecognizer.addEventListener(function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

removeEventListener

移除监听

removeEventListener()

示例代码

var txFileRecognizer = api.require('txFileRecognizer');
txFileRecognizer.removeEventListener();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24