Interface NetworkQuality

The last-mile network quality.

Last mile refers to the connection between the local device and Agora edge server.

  • After the local user joins the channel, the SDK triggers the [AgoraRTCClient.on("network-quality")]IAgoraRTCClient.event_network_quality callback once every two seconds and provides the uplink and downlink last-mile network conditions of the user through this interface.
  • You can call [AgoraRTCClient.getRemoteNetworkQuality]IAgoraRTCClient.getRemoteNetworkQuality to get the network quality of all remote users to whom the local user subscribes.

The returned network quality is a relative value and is for reference only.

interface NetworkQuality {
    downlinkNetworkQuality: 0 | 1 | 2 | 3 | 4 | 5 | 6;
    uplinkNetworkQuality: 0 | 1 | 2 | 3 | 4 | 5 | 6;
}

Hierarchy (view full)

Properties

downlinkNetworkQuality uplinkNetworkQuality

Properties

downlinkNetworkQuality

downlinkNetworkQuality: 0 | 1 | 2 | 3 | 4 | 5 | 6

The downlink network quality.

It is calculated based on the uplink transmission bitrate, uplink packet loss rate, RTT (round-trip time) and jitter.

  • 0: The quality is unknown.
  • 1: The quality is excellent.
  • 2: The quality is good, but the bitrate is less than optimal.
  • 3: Users experience slightly impaired communication.
  • 4: Users can communicate with each other, but not very smoothly.
  • 5: The quality is so poor that users can barely communicate.
  • 6: The network is disconnected and users cannot communicate.

uplinkNetworkQuality

uplinkNetworkQuality: 0 | 1 | 2 | 3 | 4 | 5 | 6

The uplink network quality.

It is calculated based on the uplink transmission bitrate, uplink packet loss rate, RTT (round-trip time) and jitter.

  • 0: The quality is unknown.
  • 1: The quality is excellent.
  • 2: The quality is good, but the bitrate is less than optimal.
  • 3: Users experience slightly impaired communication.
  • 4: Users can communicate with each other, but not very smoothly.
  • 5: The quality is so poor that users can barely communicate.
  • 6: The network is disconnected and users cannot communicate.

Settings

Member Visibility

Theme

On This Page

downlinkNetworkQualityuplinkNetworkQuality