Network Speed Test

Feature Overview

ZEGO provides network speed test functionality, which can detect uplink and downlink network speeds before users publish/play streams, to determine the bitrate of audio and video streams suitable for publishing/playing under current network conditions.

When the uplink speed test results show a high packet loss rate, it is recommended to use methods such as lowering resolution or lowering frame rate to reduce the publish stream bitrate to ensure normal publishing; when the downlink speed test results show a high packet loss rate, it is recommended to use the Layered Video Encoding feature provided by the SDK to play low-bitrate streams to ensure normal playing.

When the following situations occur in developers' business, ZEGO recommends using the SDK's network speed test feature:

• In call scenarios, network quality assessment needs to be performed.

• In education scenarios, pre-class network detection needs to be performed.

• In live streaming scenarios, network connection speed testing needs to be performed.

The basic principle of network speed test is shown in the following figure:

Example Source Code Download

Please refer to Download Example Source Code to get the source code.

For related source code, please check the files in the "/ZegoExpressExample/Others/src/main/java/im/zego/others/networkandperformance" directory.

Prerequisites

Before implementing the network speed test feature, please ensure:

• You have created a project in the ZEGOCLOUD Console and applied for a valid AppID and AppSign. For details, please refer to Console - Project Information.
• You have integrated ZEGO Express SDK in your project and implemented basic audio and video streaming functionality. For details, please refer to Quick Start - Integration and Quick Start - Implementation.

Usage Steps

1 Listen for speed test callbacks

Before starting the speed test, you can first set speed test related callbacks.

• In normal speed test situations, the onNetworkSpeedTestQualityUpdate callback will be triggered when network speed quality updates.

• When an error occurs during the speed test process, the onNetworkSpeedTestError callback will be triggered.

// Set speed test related callbacks
ZegoExpressEngine.getEngine().setEventHandler(new IZegoEventHandler() {
    @Override
    // Network speed test quality callback
    public void onNetworkSpeedTestQualityUpdate(ZegoNetworkSpeedTestQuality quality, ZegoNetworkSpeedTestType type) {

    }

    @Override
    // Network speed test exception callback
    public void onNetworkSpeedTestError(int errorCode, ZegoNetworkSpeedTestType type) {

    }
});

// Set speed test related callbacks
ZegoExpressEngine.getEngine().setEventHandler(new IZegoEventHandler() {
    @Override
    // Network speed test quality callback
    public void onNetworkSpeedTestQualityUpdate(ZegoNetworkSpeedTestQuality quality, ZegoNetworkSpeedTestType type) {

    }

    @Override
    // Network speed test exception callback
    public void onNetworkSpeedTestError(int errorCode, ZegoNetworkSpeedTestType type) {

    }
});

2 Start speed test

Create an instance of ZegoNetworkSpeedTestConfig network speed test configuration, set whether to perform uplink and downlink speed tests and expected bitrate according to the actual situation, and call the startNetworkSpeedTest interface to enable network speed test.

ZegoNetworkSpeedTestConfig config =new ZegoNetworkSpeedTestConfig();

// Perform uplink speed test, specify expected publish stream bitrate
config.testUplink = true;
config.expectedUplinkBitrate = ZegoExpressEngine.getEngine().getVideoConfig().bitrate;

// Perform downlink speed test, specify expected play stream bitrate
config.testDownlink = true;
config.expectedDownlinkBitrate = ZegoExpressEngine.getEngine().getVideoConfig().bitrate;

// Start speed test, default callback interval is 3 seconds
engine.startNetworkSpeedTest(config);

// If you need to set callback interval, you can refer to the following call (take 1.5 seconds as an example)
engine.startNetworkSpeedTest(config, 1500);

ZegoNetworkSpeedTestConfig config =new ZegoNetworkSpeedTestConfig();

// Perform uplink speed test, specify expected publish stream bitrate
config.testUplink = true;
config.expectedUplinkBitrate = ZegoExpressEngine.getEngine().getVideoConfig().bitrate;

// Perform downlink speed test, specify expected play stream bitrate
config.testDownlink = true;
config.expectedDownlinkBitrate = ZegoExpressEngine.getEngine().getVideoConfig().bitrate;

// Start speed test, default callback interval is 3 seconds
engine.startNetworkSpeedTest(config);

// If you need to set callback interval, you can refer to the following call (take 1.5 seconds as an example)
engine.startNetworkSpeedTest(config, 1500);

The speed test results will be returned in the network speed test quality ZegoNetworkSpeedTestQuality in onNetworkSpeedTestQualityUpdate. By analyzing each parameter value, you can know whether the current network quality is good.

The parameters in ZegoNetworkSpeedTestQuality are as follows:

3 Stop speed test

Call the stopNetworkSpeedTest interface to stop network speed test.

After stopping the speed test, you will no longer receive onNetworkSpeedTestQualityUpdate or onNetworkSpeedTestError callbacks.

engine.stopNetworkSpeedTest();

engine.stopNetworkSpeedTest();