Documentation
Video Call
Agora.io Community
English
search-icon
Agora Web SDK API Reference
Overview AgoraRTC Client Stream Error codes Warning Codes

Statistics of the network quality.

After joining the channel, the SDK triggers the "network-quality" callback and provides the network quality ratings in this interface.

Hierarchy

  • NetworkQualityStats

Index

Properties

Properties

Optional downlinkNetworkQuality

downlinkNetworkQuality: string

The downlink network quality.

  • "0": The network quality is unknown.
  • "1": The network quality is excellent.
  • "2": The network quality is quite good, but the bitrate may be slightly lower than excellent.
  • "3": Users can feel the communication slightly impaired.
  • "4": Users can communicate only not very smoothly.
  • "5": The network is so bad that users can hardly communicate.
  • "6": The network is down and users cannot communicate at all.

Optional uplinkNetworkQuality

uplinkNetworkQuality: string

The uplink network quality.

  • "0": The network quality is unknown.
  • "1": The network quality is excellent.
  • "2": The network quality is quite good, but the bitrate may be slightly lower than excellent.
  • "3": Users can feel the communication slightly impaired.
  • "4": Users can communicate only not very smoothly.
  • "5": The network is so bad that users can hardly communicate.
  • "6": The network is down and users cannot communicate at all.