startNetworkSpeedTest method

Future<void> startNetworkSpeedTest(
  1. ZegoNetworkSpeedTestConfig config,
  2. {int? interval}
)

Start network speed test. Support set speed test interval。

Available since: 1.20.0 Description: This function supports uplink/downlink network speed test when the network can be connected. Use cases: This function can be used to detect whether the network environment is suitable for pushing/pulling streams with specified bitrates. When to call: It needs to be called after createEngine, and before startPublishingStream. If you call startPublishingStream while speed testing, the speed test will automatically stop. Restrictions: The default maximum allowable test time for a single network speed test is 30 seconds. Caution: Developers can register onNetworkSpeedTestQualityUpdate callback to get the speed test result, which will be triggered every 3 seconds. If an error occurs during the speed test process, onNetworkSpeedTestError callback will be triggered. If this function is repeatedly called multiple times, the last functioh call's configuration will be used. Related APIs: Call stopNetworkSpeedTest to stop network speed test.

  • config Network speed test configuration.
  • interval Interval of network speed test. In milliseconds, default is 3000 ms.

Implementation

Future<void> startNetworkSpeedTest(ZegoNetworkSpeedTestConfig config,
    {int? interval}) async {
  return await ZegoExpressImpl.instance
      .startNetworkSpeedTest(config, interval: interval);
}