startEchoTest method

FutureOr<int> startEchoTest(
  1. ByteRTCEchoTestConfig echoConfig,
  2. NSInteger delayTime
)

@detail api @author qipengxiang @brief 开启音视频回路测试。
在进房前,用户可调用该接口对音视频通话全链路进行检测,包括对音视频设备以及用户上下行网络的检测,从而帮助用户判断是否可以正常发布和接收音视频流。
开始检测后,SDK 会录制你声音或视频。如果你在设置的延时范围内收到了回放,则视为音视频回路测试正常。 @param echoConfig 回路测试参数设置,参看 ByteRTCEchoTestConfig{@link #ByteRTCEchoTestConfig}。 @param delayTime 音视频延迟播放的时间间隔,用于指定在开始检测多长时间后期望收到回放。取值范围为 2,10,单位为秒,默认为 2 秒。 @return 方法调用结果:
- 0:成功 - -2:失败,参数异常 - -4:失败,用户已进房 - -6:失败,当前用户已经在检测中 - -7:失败,音视频均不检查 - -8:失败,已经存在相同 roomId 的房间 @note - 调用该方法开始音视频回路检测后,你可以调用 stopEchoTest{@link #ByteRTCEngine#stopEchoTest} 立即结束测试,也可等待测试 60s 后自动结束,以更换设备进行下一次测试,或进房。 - 在该方法之前调用的所有跟设备控制、流控制相关的方法均在开始检测时失效,在结束检测后恢复生效。 - 在调用 startEchoTest:playDelay:{@link #ByteRTCEngine#startEchoTest:playDelay} 和 stopEchoTest{@link #ByteRTCEngine#stopEchoTest} 之间调用的所有跟设备采集、流控制、进房相关的方法均不生效,并会收到 rtcEngine:onWarning:{@link #ByteRTCEngineDelegate#rtcEngine:onWarning} 回调,提示警告码为 ByteRTCWarningCodeInEchoTestMode。 - 音视频回路检测的结果会通过 rtcEngine:onEchoTestResult:{@link #ByteRTCEngineDelegate#rtcEngine:onEchoTestResult} 回调通知。

Implementation

FutureOr<int> startEchoTest(
    ByteRTCEchoTestConfig echoConfig, NSInteger delayTime) async {
  return await nativeCall(
      'startEchoTest:playDelay:', [echoConfig, delayTime]);
}