网络探测

SDK 从 5.2.5 版本开始支持该功能。

startNetworkProbe 方法支持用户在加入房间前进行网络质量探测，通过相应的回调将当前网络往返时延、上下行丢包率、网络质量数据返回给上层应用。

提示

请在加入房间前完成网络质量探测。SDK 不支持在音视频通话过程中进行网络质量探测。

设置网络探测事件回调监听

开启网络探测监听

方法

JavaScript

engine.setOnNetworkProbeStartedListener();

回调参数

参数	类型	说明
code	Number	错误码，0 表示成功
errMsg	String	错误信息

示例代码

JavaScript

// 开启网络探测的回调
engine.setOnNetworkProbeStartedListener(({code, errMsg}) => {
  if (code == 0) {
    // 开启网络探测成功
    console.log('网络探测开启成功');
  } else {
    console.log('网络探测开启失败:', errMsg);
  }
});

上行网络统计监听

方法

JavaScript

engine.setOnNetworkProbeUpLinkStatsListener();

回调参数

参数	类型	说明
qualityLevel	Number	网络质量等级
packetLostRate	Number	丢包率
rtt	Number	往返时延

示例代码

JavaScript

engine.setOnNetworkProbeUpLinkStatsListener(({qualityLevel, packetLostRate, rtt}) => {
  // 汇报网络探测上行数据
  console.log('上行网络统计:', qualityLevel, packetLostRate, rtt);
});

下行网络统计监听

方法

JavaScript

engine.setOnNetworkProbeDownLinkStatsListener();

回调参数

参数	类型	说明
qualityLevel	Number	网络质量等级
packetLostRate	Number	丢包率
rtt	Number	往返时延

示例代码

JavaScript

engine.setOnNetworkProbeDownLinkStatsListener(({qualityLevel, packetLostRate, rtt}) => {
  // 汇报网络探测下行数据
  console.log('下行网络统计:', qualityLevel, packetLostRate, rtt);
});

网络探测完成监听

方法

JavaScript

engine.setOnNetworkProbeFinishedListener();

回调参数

参数	类型	说明
code	Number	错误码，0 表示正常结束，非 0 为探测中断
errMsg	String	错误信息

示例代码

JavaScript

engine.setOnNetworkProbeFinishedListener(({code, errMsg}) => {
  // 网络探测完成 code 为 0 时是正常结束，非 0 为探测中断
  if (code == 0) {
    console.log('网络探测正常完成');
  } else {
    console.log('网络探测中断:', errMsg);
  }
});

开启 RTC 网络探测

加入房间前，通过调用 RCRTCEngine 对象的 startNetworkProbe 方法开启 RTC 网络质量探测，开启探测成功后，会回调注册的回调来反馈探测结果。每隔约 2 秒回调一次上下行网络的带宽、丢包、网络抖动和往返时延等数据。通过 setOnNetworkProbeUpLinkStatsListener、 setOnNetworkProbeDownLinkStatsListener、 setOnNetworkProbeFinishedListener 方法接收相关的事件。

探测总时长约为 30 秒，30 秒后会自动停止探测并触发 setOnNetworkProbeFinishedListener 回调方法通知上层应用探测结束，此时回调中的 code 值为 0。

提示

在探测自动结束（setOnNetworkProbeFinishedListener code == 0）前，如调用 joinRoom 或 destroy 等 API 方法会打断当前正在进行的 RTC 网络探测，此时回调中的 code 值不为 0。

方法

JavaScript

engine.startNetworkProbe();

示例代码

JavaScript

// 开启网络探测
engine.startNetworkProbe();
console.log('网络探测请求已发送');

停止 RTC 网络探测

开启探测成功约 30 秒后，会自动停止探测，如果不想等待自动结束，可调用 stopNetworkProbe 方法强制停止探测。

停止网络探测监听

方法

JavaScript

engine.setOnNetworkProbeStoppedListener();

回调参数

参数	类型	说明
code	Number	错误码，0 表示成功
errMsg	String	错误信息

示例代码

JavaScript

// 停止网络探测的回调
engine.setOnNetworkProbeStoppedListener(({code, errMsg}) => {
  if (code == 0) {
    // 停止网络探测成功
    console.log('网络探测停止成功');
  } else {
    console.log('网络探测停止失败:', errMsg);
  }
});

方法

JavaScript

engine.stopNetworkProbe();

示例代码

JavaScript

// 停止网络探测
engine.stopNetworkProbe();
console.log('网络探测停止请求已发送');

完整示例代码

JavaScript

// 开启网络探测的回调
engine.setOnNetworkProbeStartedListener(({code, errMsg}) => {
  if (code == 0) {
    // 开启网络探测成功
    console.log('网络探测开启成功');
  } else {
    console.log('网络探测开启失败:', errMsg);
  }
});

// 开启网络探测
engine.startNetworkProbe();

engine.setOnNetworkProbeUpLinkStatsListener(({qualityLevel, packetLostRate, rtt}) => {
  // 汇报网络探测上行数据
  console.log('上行网络统计:', qualityLevel, packetLostRate, rtt);
});

engine.setOnNetworkProbeDownLinkStatsListener(({qualityLevel, packetLostRate, rtt}) => {
  // 汇报网络探测下行数据
  console.log('下行网络统计:', qualityLevel, packetLostRate, rtt);
});

engine.setOnNetworkProbeFinishedListener(({code, errMsg}) => {
  // 网络探测完成 code 为 0 时是正常结束，非 0 为探测中断
  if (code == 0) {
    console.log('网络探测正常完成');
  } else {
    console.log('网络探测中断:', errMsg);
  }
});

// 停止网络探测的回调
engine.setOnNetworkProbeStoppedListener(({code, errMsg}) => {
  if (code == 0) {
    // 停止网络探测成功
    console.log('网络探测停止成功');
  } else {
    console.log('网络探测停止失败:', errMsg);
  }
});

// 停止网络探测
engine.stopNetworkProbe();