开始进行网速测试

方法名

startSpeedTest

用法

• 用法如下：

uniapp

module.startSpeedTest({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    let data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  complete: (res) => {
    // console.log(res)
  }
})

uniappx

module.startSpeedTest({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    const data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  // complete: (res) => {
  //   console.log(res)
  // }
} as LevenOptions)

• 参数说明

  参数名	参数类型	是否必填	默认值	参数描述
  params	Object	是	无	参数配置
  params.sdkAppId	String	是	无	应用标识（必填），腾讯云基于 sdkAppId 完成计费统计
  params.userId	String	是	无	用户标识（必填），当前用户的 userId，相当于用户名，使用 UTF-8 编码。
  params.scene	String	是	无	应用场景，用于指定您的业务场景，同一个房间内的所有用户需要设定相同的，可参考测速场景类型
  params.isPluginSig	Boolean	否	false	是否使用插件内部签名，如果为true的话userSig可以不用传，否则必传
  params.userSig	String	否	无	用户签名，当前 userId 对应的验证签名，相当于使用云服务的登录密码
  params.sdkSecretKey	String	否	无	签名秘钥，isPluginSig为true是必传
  params.expectedDownBandwidth	Integer	否	无	预期的下行带宽（kbps，取值范围：[10, 5000]，为 0 时不测试） 当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时，为了获取更准确的 rtt / jitter 等信息，取值范围限制为 [10, 1000]
  params.expectedUpBandwidth	Integer	否	无	预期的上行带宽（kbps，取值范围： [10, 5000]，为 0 时不测试） 当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时，为了获取更准确的 rtt / jitter 等信息，取值范围限制为 [10, 1000]
  success	Function	否	无	执行成功的函数
  fail	Function	否	无	执行失败的函数
  complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

  注意

  1. 测速过程将产生少量的基础服务费用，详见 计费概述 > 基础服务 文档说明。
  2. 请在进入房间前进行网速测试，在房间中网速测试会影响正常的音视频传输效果，而且由于干扰过多，网速测试结果也不准确。
  3. 同一时间只允许一项网速测试任务运行。

测速场景类型

名称	描述
TRTC_SpeedTestScene_Delay_Testing	延迟测试
TRTC_SpeedTestScene_Delay_Bandwidth_Testing	延迟与带宽测试
TRTC_SpeedTestScene_Online_Chorus_Testing	在线合唱测试

回调

• 示例

{
"data": {
  "result": 0
},
"message": "",
"code": 0
}

• 回调说明：

  参数名	参数类型	参数描述
  message	String	消息提示
  data	Object	数据对象
  data.result	Boolean	接口调用结果，< 0：失败
  code	Integer	返回类型，0.成功，其他：失败